Package com.google.firestore.admin.v1

Interface DatabaseOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Database, Database.Builder
@Generated public interface DatabaseOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

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

    • getNameBytes

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

    • getUid

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

    • getUidBytes

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

    • hasCreateTime

      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];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      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];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      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];

    • hasUpdateTime

      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];
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      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];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      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];

    • hasDeleteTime

      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];
      Returns:
      Whether the deleteTime field is set.

    • getDeleteTime

      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];
      Returns:
      The deleteTime.

    • getDeleteTimeOrBuilder

      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];

    • getLocationId

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

    • getLocationIdBytes

      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;
      Returns:
      The bytes for locationId.

    • getTypeValue

      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;
      Returns:
      The enum numeric value on the wire for type.

    • getType

      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;
      Returns:
      The type.

    • getConcurrencyModeValue

      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;
      Returns:
      The enum numeric value on the wire for concurrencyMode.

    • getConcurrencyMode

      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;
      Returns:
      The concurrencyMode.

    • hasVersionRetentionPeriod

      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];
      Returns:
      Whether the versionRetentionPeriod field is set.

    • getVersionRetentionPeriod

      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];
      Returns:
      The versionRetentionPeriod.

    • getVersionRetentionPeriodOrBuilder

      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];

    • hasEarliestVersionTime

      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];
      Returns:
      Whether the earliestVersionTime field is set.

    • getEarliestVersionTime

      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];
      Returns:
      The earliestVersionTime.

    • getEarliestVersionTimeOrBuilder

      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];

    • getPointInTimeRecoveryEnablementValue

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

    • getPointInTimeRecoveryEnablement

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

    • getAppEngineIntegrationModeValue

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

    • getAppEngineIntegrationMode

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

    • getKeyPrefix

      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];
      Returns:
      The keyPrefix.

    • getKeyPrefixBytes

      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];
      Returns:
      The bytes for keyPrefix.

    • getDeleteProtectionStateValue

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

    • getDeleteProtectionState

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

    • hasCmekConfig

      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];
      Returns:
      Whether the cmekConfig field is set.

    • getCmekConfig

      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];
      Returns:
      The cmekConfig.

    • getCmekConfigOrBuilder

      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];

    • getPreviousId

      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];
      Returns:
      The previousId.

    • getPreviousIdBytes

      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];
      Returns:
      The bytes for previousId.

    • hasSourceInfo

      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];
      Returns:
      Whether the sourceInfo field is set.

    • getSourceInfo

      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];
      Returns:
      The sourceInfo.

    • getSourceInfoOrBuilder

      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];

    • getTagsCount

      int getTagsCount()
       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];

    • containsTags

      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];

    • getTags

      @Deprecated Map<String,String> getTags()
      Deprecated.
      Use getTagsMap() instead.

    • getTagsMap

      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];

    • getTagsOrDefault

      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];

    • getTagsOrThrow

      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];

    • hasFreeTier

      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];
      Returns:
      Whether the freeTier field is set.

    • getFreeTier

      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];
      Returns:
      The freeTier.

    • getEtag

      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;
      Returns:
      The etag.

    • getEtagBytes

      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;
      Returns:
      The bytes for etag.

    • getDatabaseEditionValue

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

    • getDatabaseEdition

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

    • getRealtimeUpdatesModeValue

      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];
      Returns:
      The enum numeric value on the wire for realtimeUpdatesMode.

    • getRealtimeUpdatesMode

      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];
      Returns:
      The realtimeUpdatesMode.

    • getFirestoreDataAccessModeValue

      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];
      Returns:
      The enum numeric value on the wire for firestoreDataAccessMode.

    • getFirestoreDataAccessMode

      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];
      Returns:
      The firestoreDataAccessMode.

    • getMongodbCompatibleDataAccessModeValue

      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];
      Returns:
      The enum numeric value on the wire for mongodbCompatibleDataAccessMode.

    • getMongodbCompatibleDataAccessMode

      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];
      Returns:
      The mongodbCompatibleDataAccessMode.