Interface DatabaseOrBuilder (3.30.0) 

public interface DatabaseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAppEngineIntegrationMode()

public abstract 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
Type Description
Database.AppEngineIntegrationMode

The appEngineIntegrationMode.

getAppEngineIntegrationModeValue()

public abstract int getAppEngineIntegrationModeValue()

The App Engine integration mode to use for this database.

.google.firestore.admin.v1.Database.AppEngineIntegrationMode app_engine_integration_mode = 19;

Returns
Type Description
int

The enum numeric value on the wire for appEngineIntegrationMode.

getCmekConfig()

public abstract 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
Type Description
Database.CmekConfig

The cmekConfig.

getCmekConfigOrBuilder()

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

Returns
Type Description
Database.CmekConfigOrBuilder

getConcurrencyMode()

public abstract Database.ConcurrencyMode getConcurrencyMode()

The concurrency control mode to use for this database.

.google.firestore.admin.v1.Database.ConcurrencyMode concurrency_mode = 15;

Returns
Type Description
Database.ConcurrencyMode

The concurrencyMode.

getConcurrencyModeValue()

public abstract int getConcurrencyModeValue()

The concurrency control mode to use for this database.

.google.firestore.admin.v1.Database.ConcurrencyMode concurrency_mode = 15;

Returns
Type Description
int

The enum numeric value on the wire for concurrencyMode.

getCreateTime()

public abstract 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
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

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

Returns
Type Description
TimestampOrBuilder

getDeleteProtectionState()

public abstract Database.DeleteProtectionState getDeleteProtectionState()

State of delete protection for the database.

.google.firestore.admin.v1.Database.DeleteProtectionState delete_protection_state = 22;

Returns
Type Description
Database.DeleteProtectionState

The deleteProtectionState.

getDeleteProtectionStateValue()

public abstract int getDeleteProtectionStateValue()

State of delete protection for the database.

.google.firestore.admin.v1.Database.DeleteProtectionState delete_protection_state = 22;

Returns
Type Description
int

The enum numeric value on the wire for deleteProtectionState.

getDeleteTime()

public abstract 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
Type Description
Timestamp

The deleteTime.

getDeleteTimeOrBuilder()

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

Returns
Type Description
TimestampOrBuilder

getEarliestVersionTime()

public abstract 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
Type Description
Timestamp

The earliestVersionTime.

getEarliestVersionTimeOrBuilder()

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

Returns
Type Description
TimestampOrBuilder

getEtag()

public abstract 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
Type Description
String

The etag.

getEtagBytes()

public abstract 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
Type Description
ByteString

The bytes for etag.

getKeyPrefix()

public abstract 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
Type Description
String

The keyPrefix.

getKeyPrefixBytes()

public abstract 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
Type Description
ByteString

The bytes for keyPrefix.

getLocationId()

public abstract String getLocationId()

The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.

string location_id = 9;

Returns
Type Description
String

The locationId.

getLocationIdBytes()

public abstract ByteString getLocationIdBytes()

The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.

string location_id = 9;

Returns
Type Description
ByteString

The bytes for locationId.

getName()

public abstract String getName()

The resource name of the Database. Format: projects/{project}/databases/{database}

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

The resource name of the Database. Format: projects/{project}/databases/{database}

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getPointInTimeRecoveryEnablement()

public abstract 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
Type Description
Database.PointInTimeRecoveryEnablement

The pointInTimeRecoveryEnablement.

getPointInTimeRecoveryEnablementValue()

public abstract int getPointInTimeRecoveryEnablementValue()

Whether to enable the PITR feature on this database.

.google.firestore.admin.v1.Database.PointInTimeRecoveryEnablement point_in_time_recovery_enablement = 21;

Returns
Type Description
int

The enum numeric value on the wire for pointInTimeRecoveryEnablement.

getPreviousId()

public abstract 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
Type Description
String

The previousId.

getPreviousIdBytes()

public abstract 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
Type Description
ByteString

The bytes for previousId.

getSourceInfo()

public abstract 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
Type Description
Database.SourceInfo

The sourceInfo.

getSourceInfoOrBuilder()

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

Returns
Type Description
Database.SourceInfoOrBuilder

getType()

public abstract 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
Type Description
Database.DatabaseType

The type.

getTypeValue()

public abstract 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
Type Description
int

The enum numeric value on the wire for type.

getUid()

public abstract String getUid()

Output only. The system-generated UUID4 for this Database.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The uid.

getUidBytes()

public abstract ByteString getUidBytes()

Output only. The system-generated UUID4 for this Database.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for uid.

getUpdateTime()

public abstract 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
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

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

Returns
Type Description
TimestampOrBuilder

getVersionRetentionPeriod()

public abstract Duration getVersionRetentionPeriod()

Output only. The period during which past versions of data are retained in the database.

Any read or query 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
Type Description
Duration

The versionRetentionPeriod.

getVersionRetentionPeriodOrBuilder()

public abstract DurationOrBuilder getVersionRetentionPeriodOrBuilder()

Output only. The period during which past versions of data are retained in the database.

Any read or query 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
Type Description
DurationOrBuilder

hasCmekConfig()

public abstract 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
Type Description
boolean

Whether the cmekConfig field is set.

hasCreateTime()

public abstract 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
Type Description
boolean

Whether the createTime field is set.

hasDeleteTime()

public abstract 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
Type Description
boolean

Whether the deleteTime field is set.

hasEarliestVersionTime()

public abstract 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
Type Description
boolean

Whether the earliestVersionTime field is set.

hasSourceInfo()

public abstract 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
Type Description
boolean

Whether the sourceInfo field is set.

hasUpdateTime()

public abstract 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
Type Description
boolean

Whether the updateTime field is set.

hasVersionRetentionPeriod()

public abstract boolean hasVersionRetentionPeriod()

Output only. The period during which past versions of data are retained in the database.

Any read or query 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
Type Description
boolean

Whether the versionRetentionPeriod field is set.