Class DatabaseInfo (6.25.0)

public class DatabaseInfo

Represents a Cloud Spanner database.

Inheritance

Object > DatabaseInfo

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

DatabaseInfo(DatabaseId id, DatabaseInfo.State state)

public DatabaseInfo(DatabaseId id, DatabaseInfo.State state)

Parameters

Name	Description
id	`DatabaseId`
state	`DatabaseInfo.State`

Methods

equals(Object o)

public boolean equals(Object o)

Parameter

Name	Description
o	`Object`

Returns

Type	Description
boolean

Overrides

Object.equals(Object)

getCreateTime()

public Timestamp getCreateTime()

Returns the creation time of the database.

Returns

Type	Description
com.google.cloud.Timestamp

getDefaultLeader()

public String getDefaultLeader()

The read-write region which contains the database's leader replicas. If this value was not explicitly set during a create database or update database ddl operations, it will be NULL.

Returns

Type	Description
String

getDialect()

public Dialect getDialect()

The dialect that is used by the database. It can be one of the values as specified in Dialect#values().

Returns

Type	Description
Dialect

getEarliestVersionTime()

public Timestamp getEarliestVersionTime()

Returns the earliest version time of the database. This is the oldest timestamp that can be used to read old versions of the data.

Returns

Type	Description
com.google.cloud.Timestamp

getEncryptionConfig()

public CustomerManagedEncryption getEncryptionConfig()

Returns the CustomerManagedEncryption of the database if the database is encrypted, or null if this database is not encrypted.

Returns

Type	Description
CustomerManagedEncryption

getId()

public DatabaseId getId()

Returns the database id.

Returns

Type	Description
DatabaseId

getProto()

public Database getProto()

Returns the raw proto instance that was used to construct this Database.

Returns

Type	Description
Database

getRestoreInfo()

public RestoreInfo getRestoreInfo()

Returns the RestoreInfo of the database if any is available, or null if no RestoreInfo is available for this database.

Returns

Type	Description
RestoreInfo

getState()

public DatabaseInfo.State getState()

Returns the state of the database.

Returns

Type	Description
DatabaseInfo.State

getVersionRetentionPeriod()

public String getVersionRetentionPeriod()

Returns the version retention period of the database. This is the period for which Cloud Spanner retains all versions of data for the database. For instance, if set to 3 days, Cloud Spanner will retain data versions that are up to 3 days old.

Returns

Type	Description
String

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

Object.hashCode()

toString()

public String toString()

Returns

Type	Description
String

Overrides

Object.toString()