com.google.cloud.spanner

Class DatabaseInfo

java.lang.Object

com.google.cloud.spanner.DatabaseInfo

Direct Known Subclasses:

Database

public class DatabaseInfo
extends Object

Represents a Cloud Spanner database.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DatabaseInfo.Builder
static class	DatabaseInfo.State State of the database.

Constructor Summary

Constructors

Constructor and Description
DatabaseInfo(DatabaseId id, DatabaseInfo.State state)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
com.google.cloud.Timestamp	getCreateTime() Returns the creation time of the database.
String	getDefaultLeader() The read-write region which contains the database's leader replicas.
com.google.cloud.Timestamp	getEarliestVersionTime() Returns the earliest version time of the database.
CustomerManagedEncryption	getEncryptionConfig() Returns the CustomerManagedEncryption of the database if the database is encrypted, or null if this database is not encrypted.
DatabaseId	getId() Returns the database id.
Database	getProto() Returns the raw proto instance that was used to construct this Database.
RestoreInfo	getRestoreInfo() Returns the RestoreInfo of the database if any is available, or null if no RestoreInfo is available for this database.
DatabaseInfo.State	getState() Returns the state of the database.
String	getVersionRetentionPeriod() Returns the version retention period of the database.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseInfo

public DatabaseInfo(DatabaseId id,
                    DatabaseInfo.State state)

Method Detail

getId

public DatabaseId getId()

Returns the database id.

getState

public DatabaseInfo.State getState()

Returns the state of the database.

getCreateTime

public com.google.cloud.Timestamp getCreateTime()

Returns the creation time of the database.

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.

getEarliestVersionTime

public com.google.cloud.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.

getRestoreInfo

@Nullable
public RestoreInfo getRestoreInfo()

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

getEncryptionConfig

@Nullable
public CustomerManagedEncryption getEncryptionConfig()

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

getDefaultLeader

@Nullable
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.

getProto

@Nullable
public Database getProto()

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object