Package com.google.spanner.admin.database.v1

Class Database

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.spanner.admin.database.v1.Database
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, DatabaseOrBuilder, Serializable
public final class Database extends com.google.protobuf.GeneratedMessageV3 implements DatabaseOrBuilder
 A Cloud Spanner database.
Protobuf type google.spanner.admin.database.v1.Database
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • RESTORE_INFO_FIELD_NUMBER

      public static final int RESTORE_INFO_FIELD_NUMBER
      See Also:

    • ENCRYPTION_CONFIG_FIELD_NUMBER

      public static final int ENCRYPTION_CONFIG_FIELD_NUMBER
      See Also:

    • ENCRYPTION_INFO_FIELD_NUMBER

      public static final int ENCRYPTION_INFO_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:

    • DEFAULT_LEADER_FIELD_NUMBER

      public static final int DEFAULT_LEADER_FIELD_NUMBER
      See Also:

    • DATABASE_DIALECT_FIELD_NUMBER

      public static final int DATABASE_DIALECT_FIELD_NUMBER
      See Also:

    • ENABLE_DROP_PROTECTION_FIELD_NUMBER

      public static final int ENABLE_DROP_PROTECTION_FIELD_NUMBER
      See Also:

    • RECONCILING_FIELD_NUMBER

      public static final int RECONCILING_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getName

      public 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];
      Specified by:
      getName in interface DatabaseOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.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];
      Specified by:
      getNameBytes in interface DatabaseOrBuilder
      Returns:
      The bytes for name.

    • getStateValue

      public int getStateValue()
       Output only. The current database state.
      .google.spanner.admin.database.v1.Database.State state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStateValue in interface DatabaseOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • getState

      public Database.State getState()
       Output only. The current database state.
      .google.spanner.admin.database.v1.Database.State state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getState in interface DatabaseOrBuilder
      Returns:
      The state.

    • hasCreateTime

      public 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];
      Specified by:
      hasCreateTime in interface DatabaseOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.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];
      Specified by:
      getCreateTime in interface DatabaseOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.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];
      Specified by:
      getCreateTimeOrBuilder in interface DatabaseOrBuilder

    • hasRestoreInfo

      public 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];
      Specified by:
      hasRestoreInfo in interface DatabaseOrBuilder
      Returns:
      Whether the restoreInfo field is set.

    • getRestoreInfo

      public 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];
      Specified by:
      getRestoreInfo in interface DatabaseOrBuilder
      Returns:
      The restoreInfo.

    • getRestoreInfoOrBuilder

      public 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];
      Specified by:
      getRestoreInfoOrBuilder in interface DatabaseOrBuilder

    • hasEncryptionConfig

      public 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];
      Specified by:
      hasEncryptionConfig in interface DatabaseOrBuilder
      Returns:
      Whether the encryptionConfig field is set.

    • getEncryptionConfig

      public 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];
      Specified by:
      getEncryptionConfig in interface DatabaseOrBuilder
      Returns:
      The encryptionConfig.

    • getEncryptionConfigOrBuilder

      public 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];
      Specified by:
      getEncryptionConfigOrBuilder in interface DatabaseOrBuilder

    • getEncryptionInfoList

      public List<EncryptionInfo> getEncryptionInfoList()
       Output only. For databases that are using customer managed encryption, this
 field contains the encryption information for the database, such as
 all Cloud KMS key versions that are in use. The `encryption_status' field
 inside of each `EncryptionInfo` is not populated.

 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];
      Specified by:
      getEncryptionInfoList in interface DatabaseOrBuilder

    • getEncryptionInfoOrBuilderList

      public 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
 all Cloud KMS key versions that are in use. The `encryption_status' field
 inside of each `EncryptionInfo` is not populated.

 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];
      Specified by:
      getEncryptionInfoOrBuilderList in interface DatabaseOrBuilder

    • getEncryptionInfoCount

      public int getEncryptionInfoCount()
       Output only. For databases that are using customer managed encryption, this
 field contains the encryption information for the database, such as
 all Cloud KMS key versions that are in use. The `encryption_status' field
 inside of each `EncryptionInfo` is not populated.

 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];
      Specified by:
      getEncryptionInfoCount in interface DatabaseOrBuilder

    • getEncryptionInfo

      public 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
 all Cloud KMS key versions that are in use. The `encryption_status' field
 inside of each `EncryptionInfo` is not populated.

 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];
      Specified by:
      getEncryptionInfo in interface DatabaseOrBuilder

    • getEncryptionInfoOrBuilder

      public 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
 all Cloud KMS key versions that are in use. The `encryption_status' field
 inside of each `EncryptionInfo` is not populated.

 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];
      Specified by:
      getEncryptionInfoOrBuilder in interface DatabaseOrBuilder

    • getVersionRetentionPeriod

      public 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];
      Specified by:
      getVersionRetentionPeriod in interface DatabaseOrBuilder
      Returns:
      The versionRetentionPeriod.

    • getVersionRetentionPeriodBytes

      public com.google.protobuf.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];
      Specified by:
      getVersionRetentionPeriodBytes in interface DatabaseOrBuilder
      Returns:
      The bytes for versionRetentionPeriod.

    • hasEarliestVersionTime

      public 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];
      Specified by:
      hasEarliestVersionTime in interface DatabaseOrBuilder
      Returns:
      Whether the earliestVersionTime field is set.

    • getEarliestVersionTime

      public com.google.protobuf.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];
      Specified by:
      getEarliestVersionTime in interface DatabaseOrBuilder
      Returns:
      The earliestVersionTime.

    • getEarliestVersionTimeOrBuilder

      public com.google.protobuf.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];
      Specified by:
      getEarliestVersionTimeOrBuilder in interface DatabaseOrBuilder

    • getDefaultLeader

      public 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];
      Specified by:
      getDefaultLeader in interface DatabaseOrBuilder
      Returns:
      The defaultLeader.

    • getDefaultLeaderBytes

      public com.google.protobuf.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];
      Specified by:
      getDefaultLeaderBytes in interface DatabaseOrBuilder
      Returns:
      The bytes for defaultLeader.

    • getDatabaseDialectValue

      public 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];
      Specified by:
      getDatabaseDialectValue in interface DatabaseOrBuilder
      Returns:
      The enum numeric value on the wire for databaseDialect.

    • getDatabaseDialect

      public 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];
      Specified by:
      getDatabaseDialect in interface DatabaseOrBuilder
      Returns:
      The databaseDialect.

    • getEnableDropProtection

      public boolean getEnableDropProtection()
       Whether drop protection is enabled for this database. Defaults to false,
 if not set. For more details, please see how to [prevent accidental
 database
 deletion](https://cloud.google.com/spanner/docs/prevent-database-deletion).
      bool enable_drop_protection = 11;
      Specified by:
      getEnableDropProtection in interface DatabaseOrBuilder
      Returns:
      The enableDropProtection.

    • getReconciling

      public boolean getReconciling()
       Output only. If true, the database is being updated. If false, there are no
 ongoing update operations for the database.
      bool reconciling = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getReconciling in interface DatabaseOrBuilder
      Returns:
      The reconciling.

    • isInitialized

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

    • 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.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

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

    • 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.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

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

    • getDefaultInstanceForType

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