Package com.google.firestore.admin.v1

Class Database

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.firestore.admin.v1.Database
All Implemented Interfaces:
DatabaseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Database extends com.google.protobuf.GeneratedMessage implements DatabaseOrBuilder
 A Cloud Firestore Database.
Protobuf type google.firestore.admin.v1.Database
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • UID_FIELD_NUMBER

      public static final int UID_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • DELETE_TIME_FIELD_NUMBER

      public static final int DELETE_TIME_FIELD_NUMBER
      See Also:

    • LOCATION_ID_FIELD_NUMBER

      public static final int LOCATION_ID_FIELD_NUMBER
      See Also:

    • TYPE_FIELD_NUMBER

      public static final int TYPE_FIELD_NUMBER
      See Also:

    • CONCURRENCY_MODE_FIELD_NUMBER

      public static final int CONCURRENCY_MODE_FIELD_NUMBER
      See Also:

    • VERSION_RETENTION_PERIOD_FIELD_NUMBER

      public static final int VERSION_RETENTION_PERIOD_FIELD_NUMBER
      See Also:

    • EARLIEST_VERSION_TIME_FIELD_NUMBER

      public static final int EARLIEST_VERSION_TIME_FIELD_NUMBER
      See Also:

    • POINT_IN_TIME_RECOVERY_ENABLEMENT_FIELD_NUMBER

      public static final int POINT_IN_TIME_RECOVERY_ENABLEMENT_FIELD_NUMBER
      See Also:

    • APP_ENGINE_INTEGRATION_MODE_FIELD_NUMBER

      public static final int APP_ENGINE_INTEGRATION_MODE_FIELD_NUMBER
      See Also:

    • KEY_PREFIX_FIELD_NUMBER

      public static final int KEY_PREFIX_FIELD_NUMBER
      See Also:

    • DELETE_PROTECTION_STATE_FIELD_NUMBER

      public static final int DELETE_PROTECTION_STATE_FIELD_NUMBER
      See Also:

    • CMEK_CONFIG_FIELD_NUMBER

      public static final int CMEK_CONFIG_FIELD_NUMBER
      See Also:

    • PREVIOUS_ID_FIELD_NUMBER

      public static final int PREVIOUS_ID_FIELD_NUMBER
      See Also:

    • SOURCE_INFO_FIELD_NUMBER

      public static final int SOURCE_INFO_FIELD_NUMBER
      See Also:

    • TAGS_FIELD_NUMBER

      public static final int TAGS_FIELD_NUMBER
      See Also:

    • FREE_TIER_FIELD_NUMBER

      public static final int FREE_TIER_FIELD_NUMBER
      See Also:

    • ETAG_FIELD_NUMBER

      public static final int ETAG_FIELD_NUMBER
      See Also:

    • DATABASE_EDITION_FIELD_NUMBER

      public static final int DATABASE_EDITION_FIELD_NUMBER
      See Also:

    • REALTIME_UPDATES_MODE_FIELD_NUMBER

      public static final int REALTIME_UPDATES_MODE_FIELD_NUMBER
      See Also:

    • FIRESTORE_DATA_ACCESS_MODE_FIELD_NUMBER

      public static final int FIRESTORE_DATA_ACCESS_MODE_FIELD_NUMBER
      See Also:

    • MONGODB_COMPATIBLE_DATA_ACCESS_MODE_FIELD_NUMBER

      public static final int MONGODB_COMPATIBLE_DATA_ACCESS_MODE_FIELD_NUMBER
      See Also:

  • 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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Database parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Database parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Database parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Database parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Database parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Database parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Database parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Database parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Database parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Database parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Database parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Database parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static Database.Builder newBuilder()

    • newBuilder

      public static Database.Builder newBuilder(Database prototype)

    • toBuilder

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

    • newBuilderForType

      protected Database.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Database getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Database> parser()

    • getParserForType

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

    • getDefaultInstanceForType

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