public final class Database extends GeneratedMessageV3 implements DatabaseOrBuilder
A Cloud Spanner database.
Protobuf type google.spanner.admin.database.v1.Database
Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DEFAULT_LEADER_FIELD_NUMBER
public static final int DEFAULT_LEADER_FIELD_NUMBER
Field Value
EARLIEST_VERSION_TIME_FIELD_NUMBER
public static final int EARLIEST_VERSION_TIME_FIELD_NUMBER
Field Value
ENCRYPTION_CONFIG_FIELD_NUMBER
public static final int ENCRYPTION_CONFIG_FIELD_NUMBER
Field Value
ENCRYPTION_INFO_FIELD_NUMBER
public static final int ENCRYPTION_INFO_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
RESTORE_INFO_FIELD_NUMBER
public static final int RESTORE_INFO_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
VERSION_RETENTION_PERIOD_FIELD_NUMBER
public static final int VERSION_RETENTION_PERIOD_FIELD_NUMBER
Field Value
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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];
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];
getDefaultInstance()
public static Database getDefaultInstance()
Returns
getDefaultInstanceForType()
public Database getDefaultInstanceForType()
Returns
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];
| Type |
Description |
| 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];
| Type |
Description |
| ByteString |
The bytes for defaultLeader.
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
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];
| Type |
Description |
| 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];
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];
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];
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];
| Name |
Description |
| index |
int
|
Returns
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];
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];
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];
| Name |
Description |
| index |
int
|
Returns
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];
| Type |
Description |
| List<? extends com.google.spanner.admin.database.v1.EncryptionInfoOrBuilder> |
|
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];
| Type |
Description |
| 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];
getParserForType()
public Parser<Database> getParserForType()
Returns
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];
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];
getSerializedSize()
public int getSerializedSize()
Returns
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];
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];
| Type |
Description |
| int |
The enum numeric value on the wire for state.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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];
| Type |
Description |
| 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];
| Type |
Description |
| 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];
| Type |
Description |
| 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];
| Type |
Description |
| 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];
| Type |
Description |
| 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];
| Type |
Description |
| boolean |
Whether the restoreInfo field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static Database.Builder newBuilder()
Returns
newBuilder(Database prototype)
public static Database.Builder newBuilder(Database prototype)
Parameter
Returns
newBuilderForType()
public Database.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Database.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static Database parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Database parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Database parseFrom(byte[] data)
Parameter
| Name |
Description |
| data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Database parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Database parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Database parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Database parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Database parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Database parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Database parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Database parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Database parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Database> parser()
Returns
toBuilder()
public Database.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
