Interface CreateDatabaseRequestOrBuilder (6.65.1)

public interface CreateDatabaseRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCreateStatement()

public abstract String getCreateStatement()

Required. A CREATE DATABASE statement, which specifies the ID of the new database. The database ID must conform to the regular expression a-z*[a-z0-9] and be between 2 and 30 characters in length. If the database ID is a reserved word or if it contains a hyphen, the database ID must be enclosed in backticks ( `).

string create_statement = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The createStatement.

getCreateStatementBytes()

public abstract ByteString getCreateStatementBytes()

Required. A CREATE DATABASE statement, which specifies the ID of the new database. The database ID must conform to the regular expression a-z*[a-z0-9] and be between 2 and 30 characters in length. If the database ID is a reserved word or if it contains a hyphen, the database ID must be enclosed in backticks ( `).

string create_statement = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for createStatement.

getDatabaseDialect()

public abstract DatabaseDialect getDatabaseDialect()

Optional. The dialect of the Cloud Spanner Database.

.google.spanner.admin.database.v1.DatabaseDialect database_dialect = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DatabaseDialect

The databaseDialect.

getDatabaseDialectValue()

public abstract int getDatabaseDialectValue()

Optional. The dialect of the Cloud Spanner Database.

.google.spanner.admin.database.v1.DatabaseDialect database_dialect = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for databaseDialect.

getEncryptionConfig()

public abstract EncryptionConfig getEncryptionConfig()

Optional. The encryption configuration for the database. If this field is not specified, Cloud Spanner will encrypt/decrypt all data at rest using Google default encryption.

.google.spanner.admin.database.v1.EncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EncryptionConfig

The encryptionConfig.

getEncryptionConfigOrBuilder()

public abstract EncryptionConfigOrBuilder getEncryptionConfigOrBuilder()

Optional. The encryption configuration for the database. If this field is not specified, Cloud Spanner will encrypt/decrypt all data at rest using Google default encryption.

.google.spanner.admin.database.v1.EncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EncryptionConfigOrBuilder

getExtraStatements(int index)

public abstract String getExtraStatements(int index)

Optional. A list of DDL statements to run inside the newly created database. Statements can create tables, indexes, etc. These statements execute atomically with the creation of the database: if there is an error in any statement, the database is not created.

repeated string extra_statements = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The extraStatements at the given index.

getExtraStatementsBytes(int index)

public abstract ByteString getExtraStatementsBytes(int index)

Optional. A list of DDL statements to run inside the newly created database. Statements can create tables, indexes, etc. These statements execute atomically with the creation of the database: if there is an error in any statement, the database is not created.

repeated string extra_statements = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the extraStatements at the given index.

getExtraStatementsCount()

public abstract int getExtraStatementsCount()

Optional. A list of DDL statements to run inside the newly created database. Statements can create tables, indexes, etc. These statements execute atomically with the creation of the database: if there is an error in any statement, the database is not created.

repeated string extra_statements = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of extraStatements.

getExtraStatementsList()

public abstract List<String> getExtraStatementsList()

Optional. A list of DDL statements to run inside the newly created database. Statements can create tables, indexes, etc. These statements execute atomically with the creation of the database: if there is an error in any statement, the database is not created.

repeated string extra_statements = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<String>

A list containing the extraStatements.

getParent()

public abstract String getParent()

Required. The name of the instance that will serve the new database. Values are of the form projects/<project>/instances/<instance>.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

Required. The name of the instance that will serve the new database. Values are of the form projects/<project>/instances/<instance>.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getProtoDescriptors()

public abstract ByteString getProtoDescriptors()

Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements in 'extra_statements' above. Contains a protobuf-serialized google.protobuf.FileDescriptorSet. To generate it, install and run protoc with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run <code><code> $protoc --proto_path=/app_path --proto_path=/lib_path &#92; --include_imports &#92; --descriptor_set_out=descriptors.data &#92; moon/shot/app.proto </code></code> For more details, see protobuffer self description.

bytes proto_descriptors = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The protoDescriptors.

hasEncryptionConfig()

public abstract boolean hasEncryptionConfig()

Optional. The encryption configuration for the database. If this field is not specified, Cloud Spanner will encrypt/decrypt all data at rest using Google default encryption.

.google.spanner.admin.database.v1.EncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the encryptionConfig field is set.