Class CreateDatabaseRequest (6.69.0)

public final class CreateDatabaseRequest extends GeneratedMessageV3 implements CreateDatabaseRequestOrBuilder

The request for CreateDatabase.

Protobuf type google.spanner.admin.database.v1.CreateDatabaseRequest

Static Fields

CREATE_STATEMENT_FIELD_NUMBER

public static final int CREATE_STATEMENT_FIELD_NUMBER
Field Value
Type Description
int

DATABASE_DIALECT_FIELD_NUMBER

public static final int DATABASE_DIALECT_FIELD_NUMBER
Field Value
Type Description
int

ENCRYPTION_CONFIG_FIELD_NUMBER

public static final int ENCRYPTION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

EXTRA_STATEMENTS_FIELD_NUMBER

public static final int EXTRA_STATEMENTS_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

PROTO_DESCRIPTORS_FIELD_NUMBER

public static final int PROTO_DESCRIPTORS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateDatabaseRequest getDefaultInstance()
Returns
Type Description
CreateDatabaseRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CreateDatabaseRequest.Builder newBuilder()
Returns
Type Description
CreateDatabaseRequest.Builder

newBuilder(CreateDatabaseRequest prototype)

public static CreateDatabaseRequest.Builder newBuilder(CreateDatabaseRequest prototype)
Parameter
Name Description
prototype CreateDatabaseRequest
Returns
Type Description
CreateDatabaseRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateDatabaseRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateDatabaseRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateDatabaseRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateDatabaseRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CreateDatabaseRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CreateDatabaseRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateDatabaseRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateDatabaseRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateDatabaseRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CreateDatabaseRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateDatabaseRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateDatabaseRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateDatabaseRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CreateDatabaseRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateDatabaseRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateDatabaseRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CreateDatabaseRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateDatabaseRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateDatabaseRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateDatabaseRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CreateDatabaseRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CreateDatabaseRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateDatabaseRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateDatabaseRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CreateDatabaseRequest> parser()
Returns
Type Description
Parser<CreateDatabaseRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateStatement()

public 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 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 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 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.

getDefaultInstanceForType()

public CreateDatabaseRequest getDefaultInstanceForType()
Returns
Type Description
CreateDatabaseRequest

getEncryptionConfig()

public 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 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 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the extraStatements.

getParent()

public 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 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.

getParserForType()

public Parser<CreateDatabaseRequest> getParserForType()
Returns
Type Description
Parser<CreateDatabaseRequest>
Overrides

getProtoDescriptors()

public 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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasEncryptionConfig()

public 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CreateDatabaseRequest.Builder newBuilderForType()
Returns
Type Description
CreateDatabaseRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateDatabaseRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CreateDatabaseRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CreateDatabaseRequest.Builder toBuilder()
Returns
Type Description
CreateDatabaseRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException