Class Database (6.25.1)

public final class Database extends GeneratedMessageV3 implements DatabaseOrBuilder

A Cloud Spanner database.

Protobuf type google.spanner.admin.database.v1.Database

Implements

DatabaseOrBuilder

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DATABASE_DIALECT_FIELD_NUMBER

public static final int DATABASE_DIALECT_FIELD_NUMBER
Field Value
TypeDescription
int

DEFAULT_LEADER_FIELD_NUMBER

public static final int DEFAULT_LEADER_FIELD_NUMBER
Field Value
TypeDescription
int

EARLIEST_VERSION_TIME_FIELD_NUMBER

public static final int EARLIEST_VERSION_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

ENCRYPTION_CONFIG_FIELD_NUMBER

public static final int ENCRYPTION_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

ENCRYPTION_INFO_FIELD_NUMBER

public static final int ENCRYPTION_INFO_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

RESTORE_INFO_FIELD_NUMBER

public static final int RESTORE_INFO_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

VERSION_RETENTION_PERIOD_FIELD_NUMBER

public static final int VERSION_RETENTION_PERIOD_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Database getDefaultInstance()
Returns
TypeDescription
Database

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Database.Builder newBuilder()
Returns
TypeDescription
Database.Builder

newBuilder(Database prototype)

public static Database.Builder newBuilder(Database prototype)
Parameter
NameDescription
prototypeDatabase
Returns
TypeDescription
Database.Builder

parseDelimitedFrom(InputStream input)

public static Database parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Database
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Database parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Database
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Database parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Database
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Database parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Database
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Database parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Database
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Database parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Database
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Database parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Database
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Database parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Database
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Database parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Database
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Database parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Database
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Database parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Database
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Database parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Database
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Database> parser()
Returns
TypeDescription
Parser<Database>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCreateTime()

public 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
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

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

Returns
TypeDescription
TimestampOrBuilder

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

Returns
TypeDescription
DatabaseDialect

The databaseDialect.

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

Returns
TypeDescription
int

The enum numeric value on the wire for databaseDialect.

getDefaultInstanceForType()

public Database getDefaultInstanceForType()
Returns
TypeDescription
Database

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

Returns
TypeDescription
String

The defaultLeader.

getDefaultLeaderBytes()

public 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
TypeDescription
ByteString

The bytes for defaultLeader.

getEarliestVersionTime()

public 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
TypeDescription
Timestamp

The earliestVersionTime.

getEarliestVersionTimeOrBuilder()

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

Returns
TypeDescription
TimestampOrBuilder

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

Returns
TypeDescription
EncryptionConfig

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

Returns
TypeDescription
EncryptionConfigOrBuilder

getEncryptionInfo(int index)

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

Parameter
NameDescription
indexint
Returns
TypeDescription
EncryptionInfo

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

Returns
TypeDescription
int

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

Returns
TypeDescription
List<EncryptionInfo>

getEncryptionInfoOrBuilder(int index)

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

Parameter
NameDescription
indexint
Returns
TypeDescription
EncryptionInfoOrBuilder

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

Returns
TypeDescription
List<? extends com.google.spanner.admin.database.v1.EncryptionInfoOrBuilder>

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

Returns
TypeDescription
String

The name.

getNameBytes()

public 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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Database> getParserForType()
Returns
TypeDescription
Parser<Database>
Overrides

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

Returns
TypeDescription
RestoreInfo

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

Returns
TypeDescription
RestoreInfoOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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

Returns
TypeDescription
Database.State

The state.

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

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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. Defaults to 1 hour, if not set.

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

Returns
TypeDescription
String

The versionRetentionPeriod.

getVersionRetentionPeriodBytes()

public 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. Defaults to 1 hour, if not set.

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

Returns
TypeDescription
ByteString

The bytes for versionRetentionPeriod.

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

Returns
TypeDescription
boolean

Whether the createTime field is set.

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

Returns
TypeDescription
boolean

Whether the earliestVersionTime field is set.

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

Returns
TypeDescription
boolean

Whether the encryptionConfig field is set.

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

Returns
TypeDescription
boolean

Whether the restoreInfo field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Database.Builder newBuilderForType()
Returns
TypeDescription
Database.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Database.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Database.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Database.Builder toBuilder()
Returns
TypeDescription
Database.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException