com.google.spanner.admin.database.v1

Interface DatabaseOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

Database, Database.Builder

public interface DatabaseOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Timestamp	getCreateTime() Output only.
TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
DatabaseDialect	getDatabaseDialect() Output only.
int	getDatabaseDialectValue() Output only.
String	getDefaultLeader() Output only.
ByteString	getDefaultLeaderBytes() Output only.
Timestamp	getEarliestVersionTime() Output only.
TimestampOrBuilder	getEarliestVersionTimeOrBuilder() Output only.
EncryptionConfig	getEncryptionConfig() Output only.
EncryptionConfigOrBuilder	getEncryptionConfigOrBuilder() Output only.
EncryptionInfo	getEncryptionInfo(int index) Output only.
int	getEncryptionInfoCount() Output only.
List<EncryptionInfo>	getEncryptionInfoList() Output only.
EncryptionInfoOrBuilder	getEncryptionInfoOrBuilder(int index) Output only.
List<? extends EncryptionInfoOrBuilder>	getEncryptionInfoOrBuilderList() Output only.
String	getName() Required.
ByteString	getNameBytes() Required.
RestoreInfo	getRestoreInfo() Output only.
RestoreInfoOrBuilder	getRestoreInfoOrBuilder() Output only.
Database.State	getState() Output only.
int	getStateValue() Output only.
String	getVersionRetentionPeriod() Output only.
ByteString	getVersionRetentionPeriodBytes() Output only.
boolean	hasCreateTime() Output only.
boolean	hasEarliestVersionTime() Output only.
boolean	hasEncryptionConfig() Output only.
boolean	hasRestoreInfo() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Required. The name of the database. Values are of the form
 `projects/<project>/instances/<instance>/databases/<database>`,
 where `<database>` is as specified in the `CREATE DATABASE`
 statement. This name can be passed to other API methods to
 identify the database.
 

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

The name.

getNameBytes

ByteString getNameBytes()

 Required. The name of the database. Values are of the form
 `projects/<project>/instances/<instance>/databases/<database>`,
 where `<database>` is as specified in the `CREATE DATABASE`
 statement. This name can be passed to other API methods to
 identify the database.
 

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

The bytes for name.

getStateValue

int getStateValue()

 Output only. The current database state.
 

.google.spanner.admin.database.v1.Database.State state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The enum numeric value on the wire for state.

getState

Database.State getState()

 Output only. The current database state.
 

.google.spanner.admin.database.v1.Database.State state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The state.

hasCreateTime

boolean hasCreateTime()

 Output only. If exists, the time at which the database creation started.
 

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the createTime field is set.

getCreateTime

Timestamp getCreateTime()

 Output only. If exists, the time at which the database creation started.
 

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The createTime.

getCreateTimeOrBuilder

TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. If exists, the time at which the database creation started.
 

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasRestoreInfo

boolean hasRestoreInfo()

 Output only. Applicable only for restored databases. Contains information
 about the restore source.
 

.google.spanner.admin.database.v1.RestoreInfo restore_info = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the restoreInfo field is set.

getRestoreInfo

RestoreInfo getRestoreInfo()

 Output only. Applicable only for restored databases. Contains information
 about the restore source.
 

.google.spanner.admin.database.v1.RestoreInfo restore_info = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The restoreInfo.

getRestoreInfoOrBuilder

RestoreInfoOrBuilder getRestoreInfoOrBuilder()

 Output only. Applicable only for restored databases. Contains information
 about the restore source.
 

.google.spanner.admin.database.v1.RestoreInfo restore_info = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasEncryptionConfig

boolean hasEncryptionConfig()

 Output only. For databases that are using customer managed encryption, this
 field contains the encryption configuration for the database.
 For databases that are using Google default or other types of encryption,
 this field is empty.
 

.google.spanner.admin.database.v1.EncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the encryptionConfig field is set.

getEncryptionConfig

EncryptionConfig getEncryptionConfig()

 Output only. For databases that are using customer managed encryption, this
 field contains the encryption configuration for the database.
 For databases that are using Google default or other types of encryption,
 this field is empty.
 

.google.spanner.admin.database.v1.EncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The encryptionConfig.

getEncryptionConfigOrBuilder

EncryptionConfigOrBuilder getEncryptionConfigOrBuilder()

 Output only. For databases that are using customer managed encryption, this
 field contains the encryption configuration for the database.
 For databases that are using Google default or other types of encryption,
 this field is empty.
 

.google.spanner.admin.database.v1.EncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

getEncryptionInfoList

List<EncryptionInfo> getEncryptionInfoList()

 Output only. For databases that are using customer managed encryption, this
 field contains the encryption information for the database, such as
 encryption state and the Cloud KMS key versions that are in use.
 For databases that are using Google default or other types of encryption,
 this field is empty.
 This field is propagated lazily from the backend. There might be a delay
 from when a key version is being used and when it appears in this field.
 

repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

getEncryptionInfo

EncryptionInfo getEncryptionInfo(int index)

 Output only. For databases that are using customer managed encryption, this
 field contains the encryption information for the database, such as
 encryption state and the Cloud KMS key versions that are in use.
 For databases that are using Google default or other types of encryption,
 this field is empty.
 This field is propagated lazily from the backend. There might be a delay
 from when a key version is being used and when it appears in this field.
 

repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

getEncryptionInfoCount

int getEncryptionInfoCount()

 Output only. For databases that are using customer managed encryption, this
 field contains the encryption information for the database, such as
 encryption state and the Cloud KMS key versions that are in use.
 For databases that are using Google default or other types of encryption,
 this field is empty.
 This field is propagated lazily from the backend. There might be a delay
 from when a key version is being used and when it appears in this field.
 

repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

getEncryptionInfoOrBuilderList

List<? extends EncryptionInfoOrBuilder> getEncryptionInfoOrBuilderList()

 Output only. For databases that are using customer managed encryption, this
 field contains the encryption information for the database, such as
 encryption state and the Cloud KMS key versions that are in use.
 For databases that are using Google default or other types of encryption,
 this field is empty.
 This field is propagated lazily from the backend. There might be a delay
 from when a key version is being used and when it appears in this field.
 

repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

getEncryptionInfoOrBuilder

EncryptionInfoOrBuilder getEncryptionInfoOrBuilder(int index)

 Output only. For databases that are using customer managed encryption, this
 field contains the encryption information for the database, such as
 encryption state and the Cloud KMS key versions that are in use.
 For databases that are using Google default or other types of encryption,
 this field is empty.
 This field is propagated lazily from the backend. There might be a delay
 from when a key version is being used and when it appears in this field.
 

repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

getVersionRetentionPeriod

String getVersionRetentionPeriod()

 Output only. The period in which Cloud Spanner retains all versions of data
 for the database. This is the same as the value of version_retention_period
 database option set using
 [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl]. Defaults to 1 hour,
 if not set.
 

string version_retention_period = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The versionRetentionPeriod.

getVersionRetentionPeriodBytes

ByteString getVersionRetentionPeriodBytes()

 Output only. The period in which Cloud Spanner retains all versions of data
 for the database. This is the same as the value of version_retention_period
 database option set using
 [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl]. Defaults to 1 hour,
 if not set.
 

string version_retention_period = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The bytes for versionRetentionPeriod.

hasEarliestVersionTime

boolean hasEarliestVersionTime()

 Output only. Earliest timestamp at which older versions of the data can be
 read. This value is continuously updated by Cloud Spanner 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 = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the earliestVersionTime field is set.

getEarliestVersionTime

Timestamp getEarliestVersionTime()

 Output only. Earliest timestamp at which older versions of the data can be
 read. This value is continuously updated by Cloud Spanner 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 = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The earliestVersionTime.

getEarliestVersionTimeOrBuilder

TimestampOrBuilder getEarliestVersionTimeOrBuilder()

 Output only. Earliest timestamp at which older versions of the data can be
 read. This value is continuously updated by Cloud Spanner 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 = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

getDefaultLeader

String getDefaultLeader()

 Output only. The read-write region which contains the database's leader
 replicas.
 This is the same as the value of default_leader
 database option set using DatabaseAdmin.CreateDatabase or
 DatabaseAdmin.UpdateDatabaseDdl. If not explicitly set, this is empty.
 

string default_leader = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The defaultLeader.

getDefaultLeaderBytes

ByteString getDefaultLeaderBytes()

 Output only. The read-write region which contains the database's leader
 replicas.
 This is the same as the value of default_leader
 database option set using DatabaseAdmin.CreateDatabase or
 DatabaseAdmin.UpdateDatabaseDdl. If not explicitly set, this is empty.
 

string default_leader = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The bytes for defaultLeader.

getDatabaseDialectValue

int getDatabaseDialectValue()

 Output only. The dialect of the Cloud Spanner Database.
 

.google.spanner.admin.database.v1.DatabaseDialect database_dialect = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The enum numeric value on the wire for databaseDialect.

getDatabaseDialect

DatabaseDialect getDatabaseDialect()

 Output only. The dialect of the Cloud Spanner Database.
 

.google.spanner.admin.database.v1.DatabaseDialect database_dialect = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The databaseDialect.