Package com.google.cloud.spanner

Class Database.Builder

java.lang.Object

com.google.cloud.spanner.DatabaseInfo.Builder

com.google.cloud.spanner.Database.Builder

Enclosing class:

Database

public static class Database.Builder
extends DatabaseInfo.Builder

Field Summary

Fields

Modifier and Type	Field	Description
protected final DatabaseId	id

Method Summary

Modifier and Type	Method	Description
Database	build()	Builds the database from this builder.
DatabaseInfo.Builder	disableDropProtection()
DatabaseInfo.Builder	enableDropProtection()
DatabaseInfo.Builder	setDefaultLeader(String defaultLeader)	The read-write region which will be used for the database's leader replicas.
DatabaseInfo.Builder	setDialect(Dialect dialect)
DatabaseInfo.Builder	setEncryptionConfig(CustomerManagedEncryption encryptionConfig)	Optional for creating a new backup.
DatabaseInfo.Builder	setProtoDescriptors(byte[] protoDescriptors)	Optional for creating a new database.
DatabaseInfo.Builder	setProtoDescriptors(InputStream inputStream)	Optional for creating a new database.
protected DatabaseInfo.Builder	setReconciling(boolean reconciling)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

id

protected final DatabaseId id

Method Details

build

public Database build()

Description copied from class: DatabaseInfo.Builder

Builds the database from this builder.

Specified by:

build in class DatabaseInfo.Builder

setEncryptionConfig

public DatabaseInfo.Builder setEncryptionConfig(@Nullable
 CustomerManagedEncryption encryptionConfig)

Description copied from class: DatabaseInfo.Builder

Optional for creating a new backup.

The encryption configuration to be used for the database. The only encryption, other than Google's default encryption, is a customer managed encryption with a provided key. If no encryption is provided, Google's default encryption will be used.

Specified by:

setEncryptionConfig in class DatabaseInfo.Builder

setDefaultLeader

public DatabaseInfo.Builder setDefaultLeader(String defaultLeader)

Description copied from class: DatabaseInfo.Builder

The read-write region which will be used for the database's leader replicas. This can be one of the values as specified in https://cloud.google.com/spanner/docs/instances#available-configurations-multi-region.

Overrides:

setDefaultLeader in class DatabaseInfo.Builder

setDialect

public DatabaseInfo.Builder setDialect(Dialect dialect)

Overrides:

setDialect in class DatabaseInfo.Builder

enableDropProtection

public DatabaseInfo.Builder enableDropProtection()

Overrides:

enableDropProtection in class DatabaseInfo.Builder

disableDropProtection

public DatabaseInfo.Builder disableDropProtection()

Overrides:

disableDropProtection in class DatabaseInfo.Builder

setReconciling

protected DatabaseInfo.Builder setReconciling(boolean reconciling)

Overrides:

setReconciling in class DatabaseInfo.Builder

setProtoDescriptors

public DatabaseInfo.Builder setProtoDescriptors(@Nonnull
 byte[] protoDescriptors)

Description copied from class: DatabaseInfo.Builder

Optional for creating a new database.

It is used by CREATE/ALTER PROTO BUNDLE statements which are part of DDL statements. Contains a protobuf-serialized [google.protobuf.FileDescriptorSet]. To generate a proto descriptors file run protoc --include_imports --descriptor_set_out=DESCRIPTOR_OUTPUT_LOCATION LOCATION-OF-PROTO-FILES

Specified by:

setProtoDescriptors in class DatabaseInfo.Builder

Parameters:

protoDescriptors - The proto descriptors input as byte[] to be used for the database.

Returns:

DatabaseInfo.Builder

setProtoDescriptors

public DatabaseInfo.Builder setProtoDescriptors(@Nonnull
 InputStream inputStream)
                                         throws IOException

Description copied from class: DatabaseInfo.Builder

Optional for creating a new database.

It is used by CREATE/ALTER PROTO BUNDLE statements which are part of DDL statements. Contains a protobuf-serialized [google.protobuf.FileDescriptorSet]. To generate a proto descriptors file run protoc --include_imports --descriptor_set_out=DESCRIPTOR_OUTPUT_LOCATION LOCATION-OF-PROTO-FILES

Specified by:

setProtoDescriptors in class DatabaseInfo.Builder

Parameters:

inputStream - The proto descriptors input as InputStream to be used for the database.

Returns:

DatabaseInfo.Builder

Throws:

IOException - if there is a problem reading the underlying stream.