Package com.google.firestore.admin.v1

Class Database.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Database.Builder>
com.google.firestore.admin.v1.Database.Builder
All Implemented Interfaces:
DatabaseOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Database
public static final class Database.Builder extends com.google.protobuf.GeneratedMessage.Builder<Database.Builder> implements DatabaseOrBuilder
 A Cloud Firestore Database.
Protobuf type google.firestore.admin.v1.Database

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Database.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Database.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Database.Builder>

    • clear

      public Database.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<Database.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Database.Builder>

    • getDefaultInstanceForType

      public Database getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public Database build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public Database buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public Database.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Database.Builder>

    • mergeFrom

      public Database.Builder mergeFrom(Database other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Database.Builder>

    • mergeFrom

      public Database.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Database.Builder>
      Throws:
      IOException

    • getName

      public String getName()
       The resource name of the Database.
 Format: `projects/{project}/databases/{database}`
      string name = 1;
      Specified by:
      getName in interface DatabaseOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       The resource name of the Database.
 Format: `projects/{project}/databases/{database}`
      string name = 1;
      Specified by:
      getNameBytes in interface DatabaseOrBuilder
      Returns:
      The bytes for name.

    • setName

      public Database.Builder setName(String value)
       The resource name of the Database.
 Format: `projects/{project}/databases/{database}`
      string name = 1;
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public Database.Builder clearName()
       The resource name of the Database.
 Format: `projects/{project}/databases/{database}`
      string name = 1;
      Returns:
      This builder for chaining.

    • setNameBytes

      public Database.Builder setNameBytes(com.google.protobuf.ByteString value)
       The resource name of the Database.
 Format: `projects/{project}/databases/{database}`
      string name = 1;
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • getUid

      public String getUid()
       Output only. The system-generated UUID4 for this Database.
      string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUid in interface DatabaseOrBuilder
      Returns:
      The uid.

    • getUidBytes

      public com.google.protobuf.ByteString getUidBytes()
       Output only. The system-generated UUID4 for this Database.
      string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUidBytes in interface DatabaseOrBuilder
      Returns:
      The bytes for uid.

    • setUid

      public Database.Builder setUid(String value)
       Output only. The system-generated UUID4 for this Database.
      string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The uid to set.
      Returns:
      This builder for chaining.

    • clearUid

      public Database.Builder clearUid()
       Output only. The system-generated UUID4 for this Database.
      string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • setUidBytes

      public Database.Builder setUidBytes(com.google.protobuf.ByteString value)
       Output only. The system-generated UUID4 for this Database.
      string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The bytes for uid to set.
      Returns:
      This builder for chaining.

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. The timestamp at which this database was created. Databases
 created before 2016 do not populate create_time.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface DatabaseOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. The timestamp at which this database was created. Databases
 created before 2016 do not populate create_time.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface DatabaseOrBuilder
      Returns:
      The createTime.

    • setCreateTime

      public Database.Builder setCreateTime(com.google.protobuf.Timestamp value)
       Output only. The timestamp at which this database was created. Databases
 created before 2016 do not populate create_time.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setCreateTime

      public Database.Builder setCreateTime(com.google.protobuf.Timestamp.Builder builderForValue)
       Output only. The timestamp at which this database was created. Databases
 created before 2016 do not populate create_time.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • mergeCreateTime

      public Database.Builder mergeCreateTime(com.google.protobuf.Timestamp value)
       Output only. The timestamp at which this database was created. Databases
 created before 2016 do not populate create_time.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • clearCreateTime

      public Database.Builder clearCreateTime()
       Output only. The timestamp at which this database was created. Databases
 created before 2016 do not populate create_time.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getCreateTimeBuilder

      public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()
       Output only. The timestamp at which this database was created. Databases
 created before 2016 do not populate create_time.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The timestamp at which this database was created. Databases
 created before 2016 do not populate create_time.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface DatabaseOrBuilder

    • hasUpdateTime

      public boolean hasUpdateTime()
       Output only. The timestamp at which this database was most recently
 updated. Note this only includes updates to the database resource and not
 data contained by the database.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasUpdateTime in interface DatabaseOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       Output only. The timestamp at which this database was most recently
 updated. Note this only includes updates to the database resource and not
 data contained by the database.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTime in interface DatabaseOrBuilder
      Returns:
      The updateTime.

    • setUpdateTime

      public Database.Builder setUpdateTime(com.google.protobuf.Timestamp value)
       Output only. The timestamp at which this database was most recently
 updated. Note this only includes updates to the database resource and not
 data contained by the database.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setUpdateTime

      public Database.Builder setUpdateTime(com.google.protobuf.Timestamp.Builder builderForValue)
       Output only. The timestamp at which this database was most recently
 updated. Note this only includes updates to the database resource and not
 data contained by the database.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • mergeUpdateTime

      public Database.Builder mergeUpdateTime(com.google.protobuf.Timestamp value)
       Output only. The timestamp at which this database was most recently
 updated. Note this only includes updates to the database resource and not
 data contained by the database.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • clearUpdateTime

      public Database.Builder clearUpdateTime()
       Output only. The timestamp at which this database was most recently
 updated. Note this only includes updates to the database resource and not
 data contained by the database.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getUpdateTimeBuilder

      public com.google.protobuf.Timestamp.Builder getUpdateTimeBuilder()
       Output only. The timestamp at which this database was most recently
 updated. Note this only includes updates to the database resource and not
 data contained by the database.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The timestamp at which this database was most recently
 updated. Note this only includes updates to the database resource and not
 data contained by the database.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface DatabaseOrBuilder

    • hasDeleteTime

      public boolean hasDeleteTime()
       Output only. The timestamp at which this database was deleted. Only set if
 the database has been deleted.
      .google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasDeleteTime in interface DatabaseOrBuilder
      Returns:
      Whether the deleteTime field is set.

    • getDeleteTime

      public com.google.protobuf.Timestamp getDeleteTime()
       Output only. The timestamp at which this database was deleted. Only set if
 the database has been deleted.
      .google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDeleteTime in interface DatabaseOrBuilder
      Returns:
      The deleteTime.

    • setDeleteTime

      public Database.Builder setDeleteTime(com.google.protobuf.Timestamp value)
       Output only. The timestamp at which this database was deleted. Only set if
 the database has been deleted.
      .google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setDeleteTime

      public Database.Builder setDeleteTime(com.google.protobuf.Timestamp.Builder builderForValue)
       Output only. The timestamp at which this database was deleted. Only set if
 the database has been deleted.
      .google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • mergeDeleteTime

      public Database.Builder mergeDeleteTime(com.google.protobuf.Timestamp value)
       Output only. The timestamp at which this database was deleted. Only set if
 the database has been deleted.
      .google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • clearDeleteTime

      public Database.Builder clearDeleteTime()
       Output only. The timestamp at which this database was deleted. Only set if
 the database has been deleted.
      .google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getDeleteTimeBuilder

      public com.google.protobuf.Timestamp.Builder getDeleteTimeBuilder()
       Output only. The timestamp at which this database was deleted. Only set if
 the database has been deleted.
      .google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getDeleteTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder()
       Output only. The timestamp at which this database was deleted. Only set if
 the database has been deleted.
      .google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDeleteTimeOrBuilder in interface DatabaseOrBuilder

    • getLocationId

      public String getLocationId()
       The location of the database. Available locations are listed at
 https://cloud.google.com/firestore/docs/locations.
      string location_id = 9;
      Specified by:
      getLocationId in interface DatabaseOrBuilder
      Returns:
      The locationId.

    • getLocationIdBytes

      public com.google.protobuf.ByteString getLocationIdBytes()
       The location of the database. Available locations are listed at
 https://cloud.google.com/firestore/docs/locations.
      string location_id = 9;
      Specified by:
      getLocationIdBytes in interface DatabaseOrBuilder
      Returns:
      The bytes for locationId.

    • setLocationId

      public Database.Builder setLocationId(String value)
       The location of the database. Available locations are listed at
 https://cloud.google.com/firestore/docs/locations.
      string location_id = 9;
      Parameters:
      value - The locationId to set.
      Returns:
      This builder for chaining.

    • clearLocationId

      public Database.Builder clearLocationId()
       The location of the database. Available locations are listed at
 https://cloud.google.com/firestore/docs/locations.
      string location_id = 9;
      Returns:
      This builder for chaining.

    • setLocationIdBytes

      public Database.Builder setLocationIdBytes(com.google.protobuf.ByteString value)
       The location of the database. Available locations are listed at
 https://cloud.google.com/firestore/docs/locations.
      string location_id = 9;
      Parameters:
      value - The bytes for locationId to set.
      Returns:
      This builder for chaining.

    • getTypeValue

      public int getTypeValue()
       The type of the database.
 See https://cloud.google.com/datastore/docs/firestore-or-datastore for
 information about how to choose.
      .google.firestore.admin.v1.Database.DatabaseType type = 10;
      Specified by:
      getTypeValue in interface DatabaseOrBuilder
      Returns:
      The enum numeric value on the wire for type.

    • setTypeValue

      public Database.Builder setTypeValue(int value)
       The type of the database.
 See https://cloud.google.com/datastore/docs/firestore-or-datastore for
 information about how to choose.
      .google.firestore.admin.v1.Database.DatabaseType type = 10;
      Parameters:
      value - The enum numeric value on the wire for type to set.
      Returns:
      This builder for chaining.

    • getType

      public Database.DatabaseType getType()
       The type of the database.
 See https://cloud.google.com/datastore/docs/firestore-or-datastore for
 information about how to choose.
      .google.firestore.admin.v1.Database.DatabaseType type = 10;
      Specified by:
      getType in interface DatabaseOrBuilder
      Returns:
      The type.

    • setType

      public Database.Builder setType(Database.DatabaseType value)
       The type of the database.
 See https://cloud.google.com/datastore/docs/firestore-or-datastore for
 information about how to choose.
      .google.firestore.admin.v1.Database.DatabaseType type = 10;
      Parameters:
      value - The type to set.
      Returns:
      This builder for chaining.

    • clearType

      public Database.Builder clearType()
       The type of the database.
 See https://cloud.google.com/datastore/docs/firestore-or-datastore for
 information about how to choose.
      .google.firestore.admin.v1.Database.DatabaseType type = 10;
      Returns:
      This builder for chaining.

    • getConcurrencyModeValue

      public int getConcurrencyModeValue()
       The concurrency control mode to use for this database.

 If unspecified in a CreateDatabase request, this will default based on the
 database edition: Optimistic for Enterprise and Pessimistic for all other
 databases.
      .google.firestore.admin.v1.Database.ConcurrencyMode concurrency_mode = 15;
      Specified by:
      getConcurrencyModeValue in interface DatabaseOrBuilder
      Returns:
      The enum numeric value on the wire for concurrencyMode.

    • setConcurrencyModeValue

      public Database.Builder setConcurrencyModeValue(int value)
       The concurrency control mode to use for this database.

 If unspecified in a CreateDatabase request, this will default based on the
 database edition: Optimistic for Enterprise and Pessimistic for all other
 databases.
      .google.firestore.admin.v1.Database.ConcurrencyMode concurrency_mode = 15;
      Parameters:
      value - The enum numeric value on the wire for concurrencyMode to set.
      Returns:
      This builder for chaining.

    • getConcurrencyMode

      public Database.ConcurrencyMode getConcurrencyMode()
       The concurrency control mode to use for this database.

 If unspecified in a CreateDatabase request, this will default based on the
 database edition: Optimistic for Enterprise and Pessimistic for all other
 databases.
      .google.firestore.admin.v1.Database.ConcurrencyMode concurrency_mode = 15;
      Specified by:
      getConcurrencyMode in interface DatabaseOrBuilder
      Returns:
      The concurrencyMode.

    • setConcurrencyMode

      public Database.Builder setConcurrencyMode(Database.ConcurrencyMode value)
       The concurrency control mode to use for this database.

 If unspecified in a CreateDatabase request, this will default based on the
 database edition: Optimistic for Enterprise and Pessimistic for all other
 databases.
      .google.firestore.admin.v1.Database.ConcurrencyMode concurrency_mode = 15;
      Parameters:
      value - The concurrencyMode to set.
      Returns:
      This builder for chaining.

    • clearConcurrencyMode

      public Database.Builder clearConcurrencyMode()
       The concurrency control mode to use for this database.

 If unspecified in a CreateDatabase request, this will default based on the
 database edition: Optimistic for Enterprise and Pessimistic for all other
 databases.
      .google.firestore.admin.v1.Database.ConcurrencyMode concurrency_mode = 15;
      Returns:
      This builder for chaining.

    • hasVersionRetentionPeriod

      public boolean hasVersionRetentionPeriod()
       Output only. The period during which past versions of data are retained in
 the database.

 Any [read][google.firestore.v1.GetDocumentRequest.read_time]
 or [query][google.firestore.v1.ListDocumentsRequest.read_time] can specify
 a `read_time` within this window, and will read the state of the database
 at that time.

 If the PITR feature is enabled, the retention period is 7 days. Otherwise,
 the retention period is 1 hour.
      .google.protobuf.Duration version_retention_period = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasVersionRetentionPeriod in interface DatabaseOrBuilder
      Returns:
      Whether the versionRetentionPeriod field is set.

    • getVersionRetentionPeriod

      public com.google.protobuf.Duration getVersionRetentionPeriod()
       Output only. The period during which past versions of data are retained in
 the database.

 Any [read][google.firestore.v1.GetDocumentRequest.read_time]
 or [query][google.firestore.v1.ListDocumentsRequest.read_time] can specify
 a `read_time` within this window, and will read the state of the database
 at that time.

 If the PITR feature is enabled, the retention period is 7 days. Otherwise,
 the retention period is 1 hour.
      .google.protobuf.Duration version_retention_period = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getVersionRetentionPeriod in interface DatabaseOrBuilder
      Returns:
      The versionRetentionPeriod.

    • setVersionRetentionPeriod

      public Database.Builder setVersionRetentionPeriod(com.google.protobuf.Duration value)
       Output only. The period during which past versions of data are retained in
 the database.

 Any [read][google.firestore.v1.GetDocumentRequest.read_time]
 or [query][google.firestore.v1.ListDocumentsRequest.read_time] can specify
 a `read_time` within this window, and will read the state of the database
 at that time.

 If the PITR feature is enabled, the retention period is 7 days. Otherwise,
 the retention period is 1 hour.
      .google.protobuf.Duration version_retention_period = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setVersionRetentionPeriod

      public Database.Builder setVersionRetentionPeriod(com.google.protobuf.Duration.Builder builderForValue)
       Output only. The period during which past versions of data are retained in
 the database.

 Any [read][google.firestore.v1.GetDocumentRequest.read_time]
 or [query][google.firestore.v1.ListDocumentsRequest.read_time] can specify
 a `read_time` within this window, and will read the state of the database
 at that time.

 If the PITR feature is enabled, the retention period is 7 days. Otherwise,
 the retention period is 1 hour.
      .google.protobuf.Duration version_retention_period = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • mergeVersionRetentionPeriod

      public Database.Builder mergeVersionRetentionPeriod(com.google.protobuf.Duration value)
       Output only. The period during which past versions of data are retained in
 the database.

 Any [read][google.firestore.v1.GetDocumentRequest.read_time]
 or [query][google.firestore.v1.ListDocumentsRequest.read_time] can specify
 a `read_time` within this window, and will read the state of the database
 at that time.

 If the PITR feature is enabled, the retention period is 7 days. Otherwise,
 the retention period is 1 hour.
      .google.protobuf.Duration version_retention_period = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • clearVersionRetentionPeriod

      public Database.Builder clearVersionRetentionPeriod()
       Output only. The period during which past versions of data are retained in
 the database.

 Any [read][google.firestore.v1.GetDocumentRequest.read_time]
 or [query][google.firestore.v1.ListDocumentsRequest.read_time] can specify
 a `read_time` within this window, and will read the state of the database
 at that time.

 If the PITR feature is enabled, the retention period is 7 days. Otherwise,
 the retention period is 1 hour.
      .google.protobuf.Duration version_retention_period = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getVersionRetentionPeriodBuilder

      public com.google.protobuf.Duration.Builder getVersionRetentionPeriodBuilder()
       Output only. The period during which past versions of data are retained in
 the database.

 Any [read][google.firestore.v1.GetDocumentRequest.read_time]
 or [query][google.firestore.v1.ListDocumentsRequest.read_time] can specify
 a `read_time` within this window, and will read the state of the database
 at that time.

 If the PITR feature is enabled, the retention period is 7 days. Otherwise,
 the retention period is 1 hour.
      .google.protobuf.Duration version_retention_period = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getVersionRetentionPeriodOrBuilder

      public com.google.protobuf.DurationOrBuilder getVersionRetentionPeriodOrBuilder()
       Output only. The period during which past versions of data are retained in
 the database.

 Any [read][google.firestore.v1.GetDocumentRequest.read_time]
 or [query][google.firestore.v1.ListDocumentsRequest.read_time] can specify
 a `read_time` within this window, and will read the state of the database
 at that time.

 If the PITR feature is enabled, the retention period is 7 days. Otherwise,
 the retention period is 1 hour.
      .google.protobuf.Duration version_retention_period = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getVersionRetentionPeriodOrBuilder in interface DatabaseOrBuilder

    • hasEarliestVersionTime

      public boolean hasEarliestVersionTime()
       Output only. The earliest timestamp at which older versions of the data can
 be read from the database. See [version_retention_period] above; this field
 is populated with `now - version_retention_period`.

 This value is continuously updated, and becomes stale the moment it is
 queried. If you are using this value to recover data, make sure to account
 for the time from the moment when the value is queried to the moment when
 you initiate the recovery.
      .google.protobuf.Timestamp earliest_version_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasEarliestVersionTime in interface DatabaseOrBuilder
      Returns:
      Whether the earliestVersionTime field is set.

    • getEarliestVersionTime

      public com.google.protobuf.Timestamp getEarliestVersionTime()
       Output only. The earliest timestamp at which older versions of the data can
 be read from the database. See [version_retention_period] above; this field
 is populated with `now - version_retention_period`.

 This value is continuously updated, and becomes stale the moment it is
 queried. If you are using this value to recover data, make sure to account
 for the time from the moment when the value is queried to the moment when
 you initiate the recovery.
      .google.protobuf.Timestamp earliest_version_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEarliestVersionTime in interface DatabaseOrBuilder
      Returns:
      The earliestVersionTime.

    • setEarliestVersionTime

      public Database.Builder setEarliestVersionTime(com.google.protobuf.Timestamp value)
       Output only. The earliest timestamp at which older versions of the data can
 be read from the database. See [version_retention_period] above; this field
 is populated with `now - version_retention_period`.

 This value is continuously updated, and becomes stale the moment it is
 queried. If you are using this value to recover data, make sure to account
 for the time from the moment when the value is queried to the moment when
 you initiate the recovery.
      .google.protobuf.Timestamp earliest_version_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setEarliestVersionTime

      public Database.Builder setEarliestVersionTime(com.google.protobuf.Timestamp.Builder builderForValue)
       Output only. The earliest timestamp at which older versions of the data can
 be read from the database. See [version_retention_period] above; this field
 is populated with `now - version_retention_period`.

 This value is continuously updated, and becomes stale the moment it is
 queried. If you are using this value to recover data, make sure to account
 for the time from the moment when the value is queried to the moment when
 you initiate the recovery.
      .google.protobuf.Timestamp earliest_version_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • mergeEarliestVersionTime

      public Database.Builder mergeEarliestVersionTime(com.google.protobuf.Timestamp value)
       Output only. The earliest timestamp at which older versions of the data can
 be read from the database. See [version_retention_period] above; this field
 is populated with `now - version_retention_period`.

 This value is continuously updated, and becomes stale the moment it is
 queried. If you are using this value to recover data, make sure to account
 for the time from the moment when the value is queried to the moment when
 you initiate the recovery.
      .google.protobuf.Timestamp earliest_version_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • clearEarliestVersionTime

      public Database.Builder clearEarliestVersionTime()
       Output only. The earliest timestamp at which older versions of the data can
 be read from the database. See [version_retention_period] above; this field
 is populated with `now - version_retention_period`.

 This value is continuously updated, and becomes stale the moment it is
 queried. If you are using this value to recover data, make sure to account
 for the time from the moment when the value is queried to the moment when
 you initiate the recovery.
      .google.protobuf.Timestamp earliest_version_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getEarliestVersionTimeBuilder

      public com.google.protobuf.Timestamp.Builder getEarliestVersionTimeBuilder()
       Output only. The earliest timestamp at which older versions of the data can
 be read from the database. See [version_retention_period] above; this field
 is populated with `now - version_retention_period`.

 This value is continuously updated, and becomes stale the moment it is
 queried. If you are using this value to recover data, make sure to account
 for the time from the moment when the value is queried to the moment when
 you initiate the recovery.
      .google.protobuf.Timestamp earliest_version_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getEarliestVersionTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getEarliestVersionTimeOrBuilder()
       Output only. The earliest timestamp at which older versions of the data can
 be read from the database. See [version_retention_period] above; this field
 is populated with `now - version_retention_period`.

 This value is continuously updated, and becomes stale the moment it is
 queried. If you are using this value to recover data, make sure to account
 for the time from the moment when the value is queried to the moment when
 you initiate the recovery.
      .google.protobuf.Timestamp earliest_version_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEarliestVersionTimeOrBuilder in interface DatabaseOrBuilder

    • getPointInTimeRecoveryEnablementValue

      public int getPointInTimeRecoveryEnablementValue()
       Whether to enable the PITR feature on this database.
      .google.firestore.admin.v1.Database.PointInTimeRecoveryEnablement point_in_time_recovery_enablement = 21;
      Specified by:
      getPointInTimeRecoveryEnablementValue in interface DatabaseOrBuilder
      Returns:
      The enum numeric value on the wire for pointInTimeRecoveryEnablement.

    • setPointInTimeRecoveryEnablementValue

      public Database.Builder setPointInTimeRecoveryEnablementValue(int value)
       Whether to enable the PITR feature on this database.
      .google.firestore.admin.v1.Database.PointInTimeRecoveryEnablement point_in_time_recovery_enablement = 21;
      Parameters:
      value - The enum numeric value on the wire for pointInTimeRecoveryEnablement to set.
      Returns:
      This builder for chaining.

    • getPointInTimeRecoveryEnablement

      public Database.PointInTimeRecoveryEnablement getPointInTimeRecoveryEnablement()
       Whether to enable the PITR feature on this database.
      .google.firestore.admin.v1.Database.PointInTimeRecoveryEnablement point_in_time_recovery_enablement = 21;
      Specified by:
      getPointInTimeRecoveryEnablement in interface DatabaseOrBuilder
      Returns:
      The pointInTimeRecoveryEnablement.

    • setPointInTimeRecoveryEnablement

      public Database.Builder setPointInTimeRecoveryEnablement(Database.PointInTimeRecoveryEnablement value)
       Whether to enable the PITR feature on this database.
      .google.firestore.admin.v1.Database.PointInTimeRecoveryEnablement point_in_time_recovery_enablement = 21;
      Parameters:
      value - The pointInTimeRecoveryEnablement to set.
      Returns:
      This builder for chaining.

    • clearPointInTimeRecoveryEnablement

      public Database.Builder clearPointInTimeRecoveryEnablement()
       Whether to enable the PITR feature on this database.
      .google.firestore.admin.v1.Database.PointInTimeRecoveryEnablement point_in_time_recovery_enablement = 21;
      Returns:
      This builder for chaining.

    • getAppEngineIntegrationModeValue

      public int getAppEngineIntegrationModeValue()
       The App Engine integration mode to use for this database.
      .google.firestore.admin.v1.Database.AppEngineIntegrationMode app_engine_integration_mode = 19;
      Specified by:
      getAppEngineIntegrationModeValue in interface DatabaseOrBuilder
      Returns:
      The enum numeric value on the wire for appEngineIntegrationMode.

    • setAppEngineIntegrationModeValue

      public Database.Builder setAppEngineIntegrationModeValue(int value)
       The App Engine integration mode to use for this database.
      .google.firestore.admin.v1.Database.AppEngineIntegrationMode app_engine_integration_mode = 19;
      Parameters:
      value - The enum numeric value on the wire for appEngineIntegrationMode to set.
      Returns:
      This builder for chaining.

    • getAppEngineIntegrationMode

      public Database.AppEngineIntegrationMode getAppEngineIntegrationMode()
       The App Engine integration mode to use for this database.
      .google.firestore.admin.v1.Database.AppEngineIntegrationMode app_engine_integration_mode = 19;
      Specified by:
      getAppEngineIntegrationMode in interface DatabaseOrBuilder
      Returns:
      The appEngineIntegrationMode.

    • setAppEngineIntegrationMode

      public Database.Builder setAppEngineIntegrationMode(Database.AppEngineIntegrationMode value)
       The App Engine integration mode to use for this database.
      .google.firestore.admin.v1.Database.AppEngineIntegrationMode app_engine_integration_mode = 19;
      Parameters:
      value - The appEngineIntegrationMode to set.
      Returns:
      This builder for chaining.

    • clearAppEngineIntegrationMode

      public Database.Builder clearAppEngineIntegrationMode()
       The App Engine integration mode to use for this database.
      .google.firestore.admin.v1.Database.AppEngineIntegrationMode app_engine_integration_mode = 19;
      Returns:
      This builder for chaining.

    • getKeyPrefix

      public String getKeyPrefix()
       Output only. The key_prefix for this database. This key_prefix is used, in
 combination with the project ID ("<key prefix>~<project id>") to construct
 the application ID that is returned from the Cloud Datastore APIs in Google
 App Engine first generation runtimes.

 This value may be empty in which case the appid to use for URL-encoded keys
 is the project_id (eg: foo instead of v~foo).
      string key_prefix = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getKeyPrefix in interface DatabaseOrBuilder
      Returns:
      The keyPrefix.

    • getKeyPrefixBytes

      public com.google.protobuf.ByteString getKeyPrefixBytes()
       Output only. The key_prefix for this database. This key_prefix is used, in
 combination with the project ID ("<key prefix>~<project id>") to construct
 the application ID that is returned from the Cloud Datastore APIs in Google
 App Engine first generation runtimes.

 This value may be empty in which case the appid to use for URL-encoded keys
 is the project_id (eg: foo instead of v~foo).
      string key_prefix = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getKeyPrefixBytes in interface DatabaseOrBuilder
      Returns:
      The bytes for keyPrefix.

    • setKeyPrefix

      public Database.Builder setKeyPrefix(String value)
       Output only. The key_prefix for this database. This key_prefix is used, in
 combination with the project ID ("<key prefix>~<project id>") to construct
 the application ID that is returned from the Cloud Datastore APIs in Google
 App Engine first generation runtimes.

 This value may be empty in which case the appid to use for URL-encoded keys
 is the project_id (eg: foo instead of v~foo).
      string key_prefix = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The keyPrefix to set.
      Returns:
      This builder for chaining.

    • clearKeyPrefix

      public Database.Builder clearKeyPrefix()
       Output only. The key_prefix for this database. This key_prefix is used, in
 combination with the project ID ("<key prefix>~<project id>") to construct
 the application ID that is returned from the Cloud Datastore APIs in Google
 App Engine first generation runtimes.

 This value may be empty in which case the appid to use for URL-encoded keys
 is the project_id (eg: foo instead of v~foo).
      string key_prefix = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • setKeyPrefixBytes

      public Database.Builder setKeyPrefixBytes(com.google.protobuf.ByteString value)
       Output only. The key_prefix for this database. This key_prefix is used, in
 combination with the project ID ("<key prefix>~<project id>") to construct
 the application ID that is returned from the Cloud Datastore APIs in Google
 App Engine first generation runtimes.

 This value may be empty in which case the appid to use for URL-encoded keys
 is the project_id (eg: foo instead of v~foo).
      string key_prefix = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The bytes for keyPrefix to set.
      Returns:
      This builder for chaining.

    • getDeleteProtectionStateValue

      public int getDeleteProtectionStateValue()
       State of delete protection for the database.
      .google.firestore.admin.v1.Database.DeleteProtectionState delete_protection_state = 22;
      Specified by:
      getDeleteProtectionStateValue in interface DatabaseOrBuilder
      Returns:
      The enum numeric value on the wire for deleteProtectionState.

    • setDeleteProtectionStateValue

      public Database.Builder setDeleteProtectionStateValue(int value)
       State of delete protection for the database.
      .google.firestore.admin.v1.Database.DeleteProtectionState delete_protection_state = 22;
      Parameters:
      value - The enum numeric value on the wire for deleteProtectionState to set.
      Returns:
      This builder for chaining.

    • getDeleteProtectionState

      public Database.DeleteProtectionState getDeleteProtectionState()
       State of delete protection for the database.
      .google.firestore.admin.v1.Database.DeleteProtectionState delete_protection_state = 22;
      Specified by:
      getDeleteProtectionState in interface DatabaseOrBuilder
      Returns:
      The deleteProtectionState.

    • setDeleteProtectionState

      public Database.Builder setDeleteProtectionState(Database.DeleteProtectionState value)
       State of delete protection for the database.
      .google.firestore.admin.v1.Database.DeleteProtectionState delete_protection_state = 22;
      Parameters:
      value - The deleteProtectionState to set.
      Returns:
      This builder for chaining.

    • clearDeleteProtectionState

      public Database.Builder clearDeleteProtectionState()
       State of delete protection for the database.
      .google.firestore.admin.v1.Database.DeleteProtectionState delete_protection_state = 22;
      Returns:
      This builder for chaining.

    • hasCmekConfig

      public boolean hasCmekConfig()
       Optional. Presence indicates CMEK is enabled for this database.
      .google.firestore.admin.v1.Database.CmekConfig cmek_config = 23 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasCmekConfig in interface DatabaseOrBuilder
      Returns:
      Whether the cmekConfig field is set.

    • getCmekConfig

      public Database.CmekConfig getCmekConfig()
       Optional. Presence indicates CMEK is enabled for this database.
      .google.firestore.admin.v1.Database.CmekConfig cmek_config = 23 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCmekConfig in interface DatabaseOrBuilder
      Returns:
      The cmekConfig.

    • setCmekConfig

      public Database.Builder setCmekConfig(Database.CmekConfig value)
       Optional. Presence indicates CMEK is enabled for this database.
      .google.firestore.admin.v1.Database.CmekConfig cmek_config = 23 [(.google.api.field_behavior) = OPTIONAL];

    • setCmekConfig

      public Database.Builder setCmekConfig(Database.CmekConfig.Builder builderForValue)
       Optional. Presence indicates CMEK is enabled for this database.
      .google.firestore.admin.v1.Database.CmekConfig cmek_config = 23 [(.google.api.field_behavior) = OPTIONAL];

    • mergeCmekConfig

      public Database.Builder mergeCmekConfig(Database.CmekConfig value)
       Optional. Presence indicates CMEK is enabled for this database.
      .google.firestore.admin.v1.Database.CmekConfig cmek_config = 23 [(.google.api.field_behavior) = OPTIONAL];

    • clearCmekConfig

      public Database.Builder clearCmekConfig()
       Optional. Presence indicates CMEK is enabled for this database.
      .google.firestore.admin.v1.Database.CmekConfig cmek_config = 23 [(.google.api.field_behavior) = OPTIONAL];

    • getCmekConfigBuilder

      public Database.CmekConfig.Builder getCmekConfigBuilder()
       Optional. Presence indicates CMEK is enabled for this database.
      .google.firestore.admin.v1.Database.CmekConfig cmek_config = 23 [(.google.api.field_behavior) = OPTIONAL];

    • getCmekConfigOrBuilder

      public Database.CmekConfigOrBuilder getCmekConfigOrBuilder()
       Optional. Presence indicates CMEK is enabled for this database.
      .google.firestore.admin.v1.Database.CmekConfig cmek_config = 23 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCmekConfigOrBuilder in interface DatabaseOrBuilder

    • getPreviousId

      public String getPreviousId()
       Output only. The database resource's prior database ID. This field is only
 populated for deleted databases.
      string previous_id = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPreviousId in interface DatabaseOrBuilder
      Returns:
      The previousId.

    • getPreviousIdBytes

      public com.google.protobuf.ByteString getPreviousIdBytes()
       Output only. The database resource's prior database ID. This field is only
 populated for deleted databases.
      string previous_id = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPreviousIdBytes in interface DatabaseOrBuilder
      Returns:
      The bytes for previousId.

    • setPreviousId

      public Database.Builder setPreviousId(String value)
       Output only. The database resource's prior database ID. This field is only
 populated for deleted databases.
      string previous_id = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The previousId to set.
      Returns:
      This builder for chaining.

    • clearPreviousId

      public Database.Builder clearPreviousId()
       Output only. The database resource's prior database ID. This field is only
 populated for deleted databases.
      string previous_id = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • setPreviousIdBytes

      public Database.Builder setPreviousIdBytes(com.google.protobuf.ByteString value)
       Output only. The database resource's prior database ID. This field is only
 populated for deleted databases.
      string previous_id = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The bytes for previousId to set.
      Returns:
      This builder for chaining.

    • hasSourceInfo

      public boolean hasSourceInfo()
       Output only. Information about the provenance of this database.
      .google.firestore.admin.v1.Database.SourceInfo source_info = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasSourceInfo in interface DatabaseOrBuilder
      Returns:
      Whether the sourceInfo field is set.

    • getSourceInfo

      public Database.SourceInfo getSourceInfo()
       Output only. Information about the provenance of this database.
      .google.firestore.admin.v1.Database.SourceInfo source_info = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSourceInfo in interface DatabaseOrBuilder
      Returns:
      The sourceInfo.

    • setSourceInfo

      public Database.Builder setSourceInfo(Database.SourceInfo value)
       Output only. Information about the provenance of this database.
      .google.firestore.admin.v1.Database.SourceInfo source_info = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setSourceInfo

      public Database.Builder setSourceInfo(Database.SourceInfo.Builder builderForValue)
       Output only. Information about the provenance of this database.
      .google.firestore.admin.v1.Database.SourceInfo source_info = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • mergeSourceInfo

      public Database.Builder mergeSourceInfo(Database.SourceInfo value)
       Output only. Information about the provenance of this database.
      .google.firestore.admin.v1.Database.SourceInfo source_info = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • clearSourceInfo

      public Database.Builder clearSourceInfo()
       Output only. Information about the provenance of this database.
      .google.firestore.admin.v1.Database.SourceInfo source_info = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getSourceInfoBuilder

      public Database.SourceInfo.Builder getSourceInfoBuilder()
       Output only. Information about the provenance of this database.
      .google.firestore.admin.v1.Database.SourceInfo source_info = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getSourceInfoOrBuilder

      public Database.SourceInfoOrBuilder getSourceInfoOrBuilder()
       Output only. Information about the provenance of this database.
      .google.firestore.admin.v1.Database.SourceInfo source_info = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSourceInfoOrBuilder in interface DatabaseOrBuilder

    • getTagsCount

      public int getTagsCount()
      Description copied from interface: DatabaseOrBuilder
       Optional. Input only. Immutable. Tag keys/values directly bound to this
 resource. For example:
 "123/environment": "production",
 "123/costCenter": "marketing"
      map<string, string> tags = 29 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTagsCount in interface DatabaseOrBuilder

    • containsTags

      public boolean containsTags(String key)
       Optional. Input only. Immutable. Tag keys/values directly bound to this
 resource. For example:
 "123/environment": "production",
 "123/costCenter": "marketing"
      map<string, string> tags = 29 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsTags in interface DatabaseOrBuilder

    • getTags

      @Deprecated public Map<String,String> getTags()
      Deprecated.
      Use getTagsMap() instead.
      Specified by:
      getTags in interface DatabaseOrBuilder

    • getTagsMap

      public Map<String,String> getTagsMap()
       Optional. Input only. Immutable. Tag keys/values directly bound to this
 resource. For example:
 "123/environment": "production",
 "123/costCenter": "marketing"
      map<string, string> tags = 29 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTagsMap in interface DatabaseOrBuilder

    • getTagsOrDefault

      public String getTagsOrDefault(String key, String defaultValue)
       Optional. Input only. Immutable. Tag keys/values directly bound to this
 resource. For example:
 "123/environment": "production",
 "123/costCenter": "marketing"
      map<string, string> tags = 29 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTagsOrDefault in interface DatabaseOrBuilder

    • getTagsOrThrow

      public String getTagsOrThrow(String key)
       Optional. Input only. Immutable. Tag keys/values directly bound to this
 resource. For example:
 "123/environment": "production",
 "123/costCenter": "marketing"
      map<string, string> tags = 29 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTagsOrThrow in interface DatabaseOrBuilder

    • clearTags

      public Database.Builder clearTags()

    • removeTags

      public Database.Builder removeTags(String key)
       Optional. Input only. Immutable. Tag keys/values directly bound to this
 resource. For example:
 "123/environment": "production",
 "123/costCenter": "marketing"
      map<string, string> tags = 29 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

    • getMutableTags

      @Deprecated public Map<String,String> getMutableTags()
      Deprecated.
      Use alternate mutation accessors instead.

    • putTags

      public Database.Builder putTags(String key, String value)
       Optional. Input only. Immutable. Tag keys/values directly bound to this
 resource. For example:
 "123/environment": "production",
 "123/costCenter": "marketing"
      map<string, string> tags = 29 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

    • putAllTags

      public Database.Builder putAllTags(Map<String,String> values)
       Optional. Input only. Immutable. Tag keys/values directly bound to this
 resource. For example:
 "123/environment": "production",
 "123/costCenter": "marketing"
      map<string, string> tags = 29 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

    • hasFreeTier

      public boolean hasFreeTier()
       Output only. Background: Free tier is the ability of a Firestore database
 to use a small amount of resources every day without being charged. Once
 usage exceeds the free tier limit further usage is charged.

 Whether this database can make use of the free tier. Only one database
 per project can be eligible for the free tier.

 The first (or next) database that is created in a project without a free
 tier database will be marked as eligible for the free tier. Databases that
 are created while there is a free tier database will not be eligible for
 the free tier.
      optional bool free_tier = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasFreeTier in interface DatabaseOrBuilder
      Returns:
      Whether the freeTier field is set.

    • getFreeTier

      public boolean getFreeTier()
       Output only. Background: Free tier is the ability of a Firestore database
 to use a small amount of resources every day without being charged. Once
 usage exceeds the free tier limit further usage is charged.

 Whether this database can make use of the free tier. Only one database
 per project can be eligible for the free tier.

 The first (or next) database that is created in a project without a free
 tier database will be marked as eligible for the free tier. Databases that
 are created while there is a free tier database will not be eligible for
 the free tier.
      optional bool free_tier = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getFreeTier in interface DatabaseOrBuilder
      Returns:
      The freeTier.

    • setFreeTier

      public Database.Builder setFreeTier(boolean value)
       Output only. Background: Free tier is the ability of a Firestore database
 to use a small amount of resources every day without being charged. Once
 usage exceeds the free tier limit further usage is charged.

 Whether this database can make use of the free tier. Only one database
 per project can be eligible for the free tier.

 The first (or next) database that is created in a project without a free
 tier database will be marked as eligible for the free tier. Databases that
 are created while there is a free tier database will not be eligible for
 the free tier.
      optional bool free_tier = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The freeTier to set.
      Returns:
      This builder for chaining.

    • clearFreeTier

      public Database.Builder clearFreeTier()
       Output only. Background: Free tier is the ability of a Firestore database
 to use a small amount of resources every day without being charged. Once
 usage exceeds the free tier limit further usage is charged.

 Whether this database can make use of the free tier. Only one database
 per project can be eligible for the free tier.

 The first (or next) database that is created in a project without a free
 tier database will be marked as eligible for the free tier. Databases that
 are created while there is a free tier database will not be eligible for
 the free tier.
      optional bool free_tier = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • getEtag

      public String getEtag()
       This checksum is computed by the server based on the value of other
 fields, and may be sent on update and delete requests to ensure the
 client has an up-to-date value before proceeding.
      string etag = 99;
      Specified by:
      getEtag in interface DatabaseOrBuilder
      Returns:
      The etag.

    • getEtagBytes

      public com.google.protobuf.ByteString getEtagBytes()
       This checksum is computed by the server based on the value of other
 fields, and may be sent on update and delete requests to ensure the
 client has an up-to-date value before proceeding.
      string etag = 99;
      Specified by:
      getEtagBytes in interface DatabaseOrBuilder
      Returns:
      The bytes for etag.

    • setEtag

      public Database.Builder setEtag(String value)
       This checksum is computed by the server based on the value of other
 fields, and may be sent on update and delete requests to ensure the
 client has an up-to-date value before proceeding.
      string etag = 99;
      Parameters:
      value - The etag to set.
      Returns:
      This builder for chaining.

    • clearEtag

      public Database.Builder clearEtag()
       This checksum is computed by the server based on the value of other
 fields, and may be sent on update and delete requests to ensure the
 client has an up-to-date value before proceeding.
      string etag = 99;
      Returns:
      This builder for chaining.

    • setEtagBytes

      public Database.Builder setEtagBytes(com.google.protobuf.ByteString value)
       This checksum is computed by the server based on the value of other
 fields, and may be sent on update and delete requests to ensure the
 client has an up-to-date value before proceeding.
      string etag = 99;
      Parameters:
      value - The bytes for etag to set.
      Returns:
      This builder for chaining.

    • getDatabaseEditionValue

      public int getDatabaseEditionValue()
       Immutable. The edition of the database.
      .google.firestore.admin.v1.Database.DatabaseEdition database_edition = 28 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getDatabaseEditionValue in interface DatabaseOrBuilder
      Returns:
      The enum numeric value on the wire for databaseEdition.

    • setDatabaseEditionValue

      public Database.Builder setDatabaseEditionValue(int value)
       Immutable. The edition of the database.
      .google.firestore.admin.v1.Database.DatabaseEdition database_edition = 28 [(.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      value - The enum numeric value on the wire for databaseEdition to set.
      Returns:
      This builder for chaining.

    • getDatabaseEdition

      public Database.DatabaseEdition getDatabaseEdition()
       Immutable. The edition of the database.
      .google.firestore.admin.v1.Database.DatabaseEdition database_edition = 28 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getDatabaseEdition in interface DatabaseOrBuilder
      Returns:
      The databaseEdition.

    • setDatabaseEdition

      public Database.Builder setDatabaseEdition(Database.DatabaseEdition value)
       Immutable. The edition of the database.
      .google.firestore.admin.v1.Database.DatabaseEdition database_edition = 28 [(.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      value - The databaseEdition to set.
      Returns:
      This builder for chaining.

    • clearDatabaseEdition

      public Database.Builder clearDatabaseEdition()
       Immutable. The edition of the database.
      .google.firestore.admin.v1.Database.DatabaseEdition database_edition = 28 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      This builder for chaining.

    • getRealtimeUpdatesModeValue

      public int getRealtimeUpdatesModeValue()
       Immutable. The default Realtime Updates mode to use for this database.
      .google.firestore.admin.v1.RealtimeUpdatesMode realtime_updates_mode = 31 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getRealtimeUpdatesModeValue in interface DatabaseOrBuilder
      Returns:
      The enum numeric value on the wire for realtimeUpdatesMode.

    • setRealtimeUpdatesModeValue

      public Database.Builder setRealtimeUpdatesModeValue(int value)
       Immutable. The default Realtime Updates mode to use for this database.
      .google.firestore.admin.v1.RealtimeUpdatesMode realtime_updates_mode = 31 [(.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      value - The enum numeric value on the wire for realtimeUpdatesMode to set.
      Returns:
      This builder for chaining.

    • getRealtimeUpdatesMode

      public RealtimeUpdatesMode getRealtimeUpdatesMode()
       Immutable. The default Realtime Updates mode to use for this database.
      .google.firestore.admin.v1.RealtimeUpdatesMode realtime_updates_mode = 31 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getRealtimeUpdatesMode in interface DatabaseOrBuilder
      Returns:
      The realtimeUpdatesMode.

    • setRealtimeUpdatesMode

      public Database.Builder setRealtimeUpdatesMode(RealtimeUpdatesMode value)
       Immutable. The default Realtime Updates mode to use for this database.
      .google.firestore.admin.v1.RealtimeUpdatesMode realtime_updates_mode = 31 [(.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      value - The realtimeUpdatesMode to set.
      Returns:
      This builder for chaining.

    • clearRealtimeUpdatesMode

      public Database.Builder clearRealtimeUpdatesMode()
       Immutable. The default Realtime Updates mode to use for this database.
      .google.firestore.admin.v1.RealtimeUpdatesMode realtime_updates_mode = 31 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      This builder for chaining.

    • getFirestoreDataAccessModeValue

      public int getFirestoreDataAccessModeValue()
       Optional. The Firestore API data access mode to use for this database. If
 not set on write:
 - the default value is DATA_ACCESS_MODE_DISABLED for Enterprise Edition.
 - the default value is DATA_ACCESS_MODE_ENABLED for Standard Edition.
      .google.firestore.admin.v1.Database.DataAccessMode firestore_data_access_mode = 33 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFirestoreDataAccessModeValue in interface DatabaseOrBuilder
      Returns:
      The enum numeric value on the wire for firestoreDataAccessMode.

    • setFirestoreDataAccessModeValue

      public Database.Builder setFirestoreDataAccessModeValue(int value)
       Optional. The Firestore API data access mode to use for this database. If
 not set on write:
 - the default value is DATA_ACCESS_MODE_DISABLED for Enterprise Edition.
 - the default value is DATA_ACCESS_MODE_ENABLED for Standard Edition.
      .google.firestore.admin.v1.Database.DataAccessMode firestore_data_access_mode = 33 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The enum numeric value on the wire for firestoreDataAccessMode to set.
      Returns:
      This builder for chaining.

    • getFirestoreDataAccessMode

      public Database.DataAccessMode getFirestoreDataAccessMode()
       Optional. The Firestore API data access mode to use for this database. If
 not set on write:
 - the default value is DATA_ACCESS_MODE_DISABLED for Enterprise Edition.
 - the default value is DATA_ACCESS_MODE_ENABLED for Standard Edition.
      .google.firestore.admin.v1.Database.DataAccessMode firestore_data_access_mode = 33 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFirestoreDataAccessMode in interface DatabaseOrBuilder
      Returns:
      The firestoreDataAccessMode.

    • setFirestoreDataAccessMode

      public Database.Builder setFirestoreDataAccessMode(Database.DataAccessMode value)
       Optional. The Firestore API data access mode to use for this database. If
 not set on write:
 - the default value is DATA_ACCESS_MODE_DISABLED for Enterprise Edition.
 - the default value is DATA_ACCESS_MODE_ENABLED for Standard Edition.
      .google.firestore.admin.v1.Database.DataAccessMode firestore_data_access_mode = 33 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The firestoreDataAccessMode to set.
      Returns:
      This builder for chaining.

    • clearFirestoreDataAccessMode

      public Database.Builder clearFirestoreDataAccessMode()
       Optional. The Firestore API data access mode to use for this database. If
 not set on write:
 - the default value is DATA_ACCESS_MODE_DISABLED for Enterprise Edition.
 - the default value is DATA_ACCESS_MODE_ENABLED for Standard Edition.
      .google.firestore.admin.v1.Database.DataAccessMode firestore_data_access_mode = 33 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • getMongodbCompatibleDataAccessModeValue

      public int getMongodbCompatibleDataAccessModeValue()
       Optional. The MongoDB compatible API data access mode to use for this
 database. If not set on write, the default value is
 DATA_ACCESS_MODE_ENABLED for Enterprise Edition. The value is always
 DATA_ACCESS_MODE_DISABLED for Standard Edition.
      .google.firestore.admin.v1.Database.DataAccessMode mongodb_compatible_data_access_mode = 34 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMongodbCompatibleDataAccessModeValue in interface DatabaseOrBuilder
      Returns:
      The enum numeric value on the wire for mongodbCompatibleDataAccessMode.

    • setMongodbCompatibleDataAccessModeValue

      public Database.Builder setMongodbCompatibleDataAccessModeValue(int value)
       Optional. The MongoDB compatible API data access mode to use for this
 database. If not set on write, the default value is
 DATA_ACCESS_MODE_ENABLED for Enterprise Edition. The value is always
 DATA_ACCESS_MODE_DISABLED for Standard Edition.
      .google.firestore.admin.v1.Database.DataAccessMode mongodb_compatible_data_access_mode = 34 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The enum numeric value on the wire for mongodbCompatibleDataAccessMode to set.
      Returns:
      This builder for chaining.

    • getMongodbCompatibleDataAccessMode

      public Database.DataAccessMode getMongodbCompatibleDataAccessMode()
       Optional. The MongoDB compatible API data access mode to use for this
 database. If not set on write, the default value is
 DATA_ACCESS_MODE_ENABLED for Enterprise Edition. The value is always
 DATA_ACCESS_MODE_DISABLED for Standard Edition.
      .google.firestore.admin.v1.Database.DataAccessMode mongodb_compatible_data_access_mode = 34 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMongodbCompatibleDataAccessMode in interface DatabaseOrBuilder
      Returns:
      The mongodbCompatibleDataAccessMode.

    • setMongodbCompatibleDataAccessMode

      public Database.Builder setMongodbCompatibleDataAccessMode(Database.DataAccessMode value)
       Optional. The MongoDB compatible API data access mode to use for this
 database. If not set on write, the default value is
 DATA_ACCESS_MODE_ENABLED for Enterprise Edition. The value is always
 DATA_ACCESS_MODE_DISABLED for Standard Edition.
      .google.firestore.admin.v1.Database.DataAccessMode mongodb_compatible_data_access_mode = 34 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The mongodbCompatibleDataAccessMode to set.
      Returns:
      This builder for chaining.

    • clearMongodbCompatibleDataAccessMode

      public Database.Builder clearMongodbCompatibleDataAccessMode()
       Optional. The MongoDB compatible API data access mode to use for this
 database. If not set on write, the default value is
 DATA_ACCESS_MODE_ENABLED for Enterprise Edition. The value is always
 DATA_ACCESS_MODE_DISABLED for Standard Edition.
      .google.firestore.admin.v1.Database.DataAccessMode mongodb_compatible_data_access_mode = 34 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.