com.google.api.services.spanner.v1.model

Class Database

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.spanner.v1.model.Database

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Database
extends com.google.api.client.json.GenericJson

A Cloud Spanner database.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Spanner API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Database()

Method Summary

Modifier and Type	Method and Description
Database	clone()
String	getCreateTime() Output only.
String	getDatabaseDialect() Output only.
String	getDefaultLeader() Output only.
String	getEarliestVersionTime() Output only.
Boolean	getEnableDropProtection() Optional.
EncryptionConfig	getEncryptionConfig() Output only.
List<EncryptionInfo>	getEncryptionInfo() Output only.
String	getName() Required.
QuorumInfo	getQuorumInfo() Output only.
Boolean	getReconciling() Output only.
RestoreInfo	getRestoreInfo() Output only.
String	getState() Output only.
String	getVersionRetentionPeriod() Output only.
Database	set(String fieldName, Object value)
Database	setCreateTime(String createTime) Output only.
Database	setDatabaseDialect(String databaseDialect) Output only.
Database	setDefaultLeader(String defaultLeader) Output only.
Database	setEarliestVersionTime(String earliestVersionTime) Output only.
Database	setEnableDropProtection(Boolean enableDropProtection) Optional.
Database	setEncryptionConfig(EncryptionConfig encryptionConfig) Output only.
Database	setEncryptionInfo(List<EncryptionInfo> encryptionInfo) Output only.
Database	setName(String name) Required.
Database	setQuorumInfo(QuorumInfo quorumInfo) Output only.
Database	setReconciling(Boolean reconciling) Output only.
Database	setRestoreInfo(RestoreInfo restoreInfo) Output only.
Database	setState(String state) Output only.
Database	setVersionRetentionPeriod(String versionRetentionPeriod) Output only.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Database

public Database()

Method Detail

getCreateTime

public String getCreateTime()

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

Returns:

value or null for none

setCreateTime

public Database setCreateTime(String createTime)

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

Parameters:

createTime - createTime or null for none

getDatabaseDialect

public String getDatabaseDialect()

Output only. The dialect of the Cloud Spanner Database.

Returns:

value or null for none

setDatabaseDialect

public Database setDatabaseDialect(String databaseDialect)

Output only. The dialect of the Cloud Spanner Database.

Parameters:

databaseDialect - databaseDialect or null for none

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.

Returns:

value or null for none

setDefaultLeader

public Database setDefaultLeader(String defaultLeader)

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.

Parameters:

defaultLeader - defaultLeader or null for none

getEarliestVersionTime

public String 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.

Returns:

value or null for none

setEarliestVersionTime

public Database setEarliestVersionTime(String earliestVersionTime)

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.

Parameters:

earliestVersionTime - earliestVersionTime or null for none

getEnableDropProtection

public Boolean getEnableDropProtection()

Optional. 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).

Returns:

value or null for none

setEnableDropProtection

public Database setEnableDropProtection(Boolean enableDropProtection)

Optional. 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).

Parameters:

enableDropProtection - enableDropProtection or null for none

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.

Returns:

value or null for none

setEncryptionConfig

public Database setEncryptionConfig(EncryptionConfig encryptionConfig)

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.

Parameters:

encryptionConfig - encryptionConfig or null for none

getEncryptionInfo

public List<EncryptionInfo> getEncryptionInfo()

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.

Returns:

value or null for none

setEncryptionInfo

public Database setEncryptionInfo(List<EncryptionInfo> encryptionInfo)

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.

Parameters:

encryptionInfo - encryptionInfo or null for none

getName

public String getName()

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

Returns:

value or null for none

setName

public Database setName(String name)

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

Parameters:

name - name or null for none

getQuorumInfo

public QuorumInfo getQuorumInfo()

Output only. Applicable only for databases that use dual-region instance configurations. Contains information about the quorum.

Returns:

value or null for none

setQuorumInfo

public Database setQuorumInfo(QuorumInfo quorumInfo)

Output only. Applicable only for databases that use dual-region instance configurations. Contains information about the quorum.

Parameters:

quorumInfo - quorumInfo or null for none

getReconciling

public Boolean getReconciling()

Output only. If true, the database is being updated. If false, there are no ongoing update operations for the database.

Returns:

value or null for none

setReconciling

public Database setReconciling(Boolean reconciling)

Output only. If true, the database is being updated. If false, there are no ongoing update operations for the database.

Parameters:

reconciling - reconciling or null for none

getRestoreInfo

public RestoreInfo getRestoreInfo()

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

Returns:

value or null for none

setRestoreInfo

public Database setRestoreInfo(RestoreInfo restoreInfo)

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

Parameters:

restoreInfo - restoreInfo or null for none

getState

public String getState()

Output only. The current database state.

Returns:

value or null for none

setState

public Database setState(String state)

Output only. The current database state.

Parameters:

state - state or null for none

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.

Returns:

value or null for none

setVersionRetentionPeriod

public Database setVersionRetentionPeriod(String versionRetentionPeriod)

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.

Parameters:

versionRetentionPeriod - versionRetentionPeriod or null for none

set

public Database set(String fieldName,
                    Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Database clone()

Overrides:

clone in class com.google.api.client.json.GenericJson