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
DATABASE_DIALECT_FIELD_NUMBER
public static final int DATABASE_DIALECT_FIELD_NUMBER
Field Value
ENCRYPTION_CONFIG_FIELD_NUMBER
public static final int ENCRYPTION_CONFIG_FIELD_NUMBER
Field Value
public static final int EXTRA_STATEMENTS_FIELD_NUMBER
Field Value
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static CreateDatabaseRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static CreateDatabaseRequest.Builder newBuilder()
Returns
newBuilder(CreateDatabaseRequest prototype)
public static CreateDatabaseRequest.Builder newBuilder(CreateDatabaseRequest prototype)
Parameter
Returns
public static CreateDatabaseRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static CreateDatabaseRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static CreateDatabaseRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CreateDatabaseRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static CreateDatabaseRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CreateDatabaseRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static CreateDatabaseRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static CreateDatabaseRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static CreateDatabaseRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static CreateDatabaseRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static CreateDatabaseRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CreateDatabaseRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<CreateDatabaseRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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];
| 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];
| 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];
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];
| Type | Description |
| int | The enum numeric value on the wire for databaseDialect.
|
getDefaultInstanceForType()
public CreateDatabaseRequest getDefaultInstanceForType()
Returns
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];
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];
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];
| Name | Description |
| index | int
The index of the element to return.
|
Returns
| Type | Description |
| String | The extraStatements at the given 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];
| Name | Description |
| index | int
The index of the value to return.
|
Returns
| Type | Description |
| ByteString | The bytes of the extraStatements at the given index.
|
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];
| Type | Description |
| int | The count of extraStatements.
|
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];
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) = { ... }
| 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) = { ... }
getParserForType()
public Parser<CreateDatabaseRequest> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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];
| Type | Description |
| boolean | Whether the encryptionConfig field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public CreateDatabaseRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CreateDatabaseRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public CreateDatabaseRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
