Class DatabaseInfo.Builder (6.74.0)

public abstract static class DatabaseInfo.Builder

Inheritance

java.lang.Object > DatabaseInfo.Builder

Constructors

Builder()

public Builder()

Methods

build()

public abstract Database build()

Builds the database from this builder.

Returns
Type Description
Database

disableDropProtection()

public DatabaseInfo.Builder disableDropProtection()
Returns
Type Description
DatabaseInfo.Builder

enableDropProtection()

public DatabaseInfo.Builder enableDropProtection()
Returns
Type Description
DatabaseInfo.Builder

setDefaultLeader(String defaultLeader)

public DatabaseInfo.Builder setDefaultLeader(String defaultLeader)

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.

Parameter
Name Description
defaultLeader String
Returns
Type Description
DatabaseInfo.Builder

setDialect(Dialect dialect)

public DatabaseInfo.Builder setDialect(Dialect dialect)
Parameter
Name Description
dialect Dialect
Returns
Type Description
DatabaseInfo.Builder

setEncryptionConfig(CustomerManagedEncryption encryptionConfig)

public abstract DatabaseInfo.Builder setEncryptionConfig(CustomerManagedEncryption encryptionConfig)

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.

Parameter
Name Description
encryptionConfig CustomerManagedEncryption
Returns
Type Description
DatabaseInfo.Builder

setProtoDescriptors(byte[] protoDescriptors)

public abstract DatabaseInfo.Builder setProtoDescriptors(byte[] protoDescriptors)

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

Parameter
Name Description
protoDescriptors byte[]

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

Returns
Type Description
DatabaseInfo.Builder Builder

setProtoDescriptors(InputStream inputStream)

public abstract DatabaseInfo.Builder setProtoDescriptors(InputStream inputStream)

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

Parameter
Name Description
inputStream InputStream

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

Returns
Type Description
DatabaseInfo.Builder Builder
Exceptions
Type Description
IOException

if there is a problem reading the underlying stream.

setReconciling(boolean reconciling)

protected DatabaseInfo.Builder setReconciling(boolean reconciling)
Parameter
Name Description
reconciling boolean
Returns
Type Description
DatabaseInfo.Builder