public static final class CreateDatabaseRequest.Builder extends GeneratedMessageV3.Builder<CreateDatabaseRequest.Builder> implements CreateDatabaseRequestOrBuilderThe request for CreateDatabase.
Protobuf type google.spanner.admin.database.v1.CreateDatabaseRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CreateDatabaseRequest.BuilderImplements
CreateDatabaseRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllExtraStatements(Iterable<String> values)
public CreateDatabaseRequest.Builder addAllExtraStatements(Iterable<String> values)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 |
values |
Iterable<String>The extraStatements to add. |
| Returns | |
|---|---|
| Type | Description |
CreateDatabaseRequest.Builder |
This builder for chaining. |
addExtraStatements(String value)
public CreateDatabaseRequest.Builder addExtraStatements(String value)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 |
value |
StringThe extraStatements to add. |
| Returns | |
|---|---|
| Type | Description |
CreateDatabaseRequest.Builder |
This builder for chaining. |
addExtraStatementsBytes(ByteString value)
public CreateDatabaseRequest.Builder addExtraStatementsBytes(ByteString value)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 |
value |
ByteStringThe bytes of the extraStatements to add. |
| Returns | |
|---|---|
| Type | Description |
CreateDatabaseRequest.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CreateDatabaseRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CreateDatabaseRequest.Builder |
|
build()
public CreateDatabaseRequest build()| Returns | |
|---|---|
| Type | Description |
CreateDatabaseRequest |
|
buildPartial()
public CreateDatabaseRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
CreateDatabaseRequest |
|
clear()
public CreateDatabaseRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
CreateDatabaseRequest.Builder |
|
clearCreateStatement()
public CreateDatabaseRequest.Builder clearCreateStatement() 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 |
CreateDatabaseRequest.Builder |
This builder for chaining. |
clearDatabaseDialect()
public CreateDatabaseRequest.Builder clearDatabaseDialect()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 |
CreateDatabaseRequest.Builder |
This builder for chaining. |
clearEncryptionConfig()
public CreateDatabaseRequest.Builder clearEncryptionConfig()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 |
CreateDatabaseRequest.Builder |
|
clearExtraStatements()
public CreateDatabaseRequest.Builder clearExtraStatements()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 |
CreateDatabaseRequest.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public CreateDatabaseRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
CreateDatabaseRequest.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public CreateDatabaseRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
CreateDatabaseRequest.Builder |
|
clearParent()
public CreateDatabaseRequest.Builder clearParent() 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 |
CreateDatabaseRequest.Builder |
This builder for chaining. |
clearProtoDescriptors()
public CreateDatabaseRequest.Builder clearProtoDescriptors() 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 \
--include_imports \
--descriptor_set_out=descriptors.data \
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 |
CreateDatabaseRequest.Builder |
This builder for chaining. |
clone()
public CreateDatabaseRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
CreateDatabaseRequest.Builder |
|
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 |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
getEncryptionConfigBuilder()
public EncryptionConfig.Builder getEncryptionConfigBuilder()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.Builder |
|
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 |
intThe 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 |
intThe 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. |
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 \
--include_imports \
--descriptor_set_out=descriptors.data \
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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeEncryptionConfig(EncryptionConfig value)
public CreateDatabaseRequest.Builder mergeEncryptionConfig(EncryptionConfig value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
EncryptionConfig |
| Returns | |
|---|---|
| Type | Description |
CreateDatabaseRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CreateDatabaseRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CreateDatabaseRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public CreateDatabaseRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
CreateDatabaseRequest.Builder |
|
mergeFrom(CreateDatabaseRequest other)
public CreateDatabaseRequest.Builder mergeFrom(CreateDatabaseRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
CreateDatabaseRequest |
| Returns | |
|---|---|
| Type | Description |
CreateDatabaseRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CreateDatabaseRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CreateDatabaseRequest.Builder |
|
setCreateStatement(String value)
public CreateDatabaseRequest.Builder setCreateStatement(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe createStatement to set. |
| Returns | |
|---|---|
| Type | Description |
CreateDatabaseRequest.Builder |
This builder for chaining. |
setCreateStatementBytes(ByteString value)
public CreateDatabaseRequest.Builder setCreateStatementBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for createStatement to set. |
| Returns | |
|---|---|
| Type | Description |
CreateDatabaseRequest.Builder |
This builder for chaining. |
setDatabaseDialect(DatabaseDialect value)
public CreateDatabaseRequest.Builder setDatabaseDialect(DatabaseDialect value)Optional. The dialect of the Cloud Spanner Database.
.google.spanner.admin.database.v1.DatabaseDialect database_dialect = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
DatabaseDialectThe databaseDialect to set. |
| Returns | |
|---|---|
| Type | Description |
CreateDatabaseRequest.Builder |
This builder for chaining. |
setDatabaseDialectValue(int value)
public CreateDatabaseRequest.Builder setDatabaseDialectValue(int value)Optional. The dialect of the Cloud Spanner Database.
.google.spanner.admin.database.v1.DatabaseDialect database_dialect = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for databaseDialect to set. |
| Returns | |
|---|---|
| Type | Description |
CreateDatabaseRequest.Builder |
This builder for chaining. |
setEncryptionConfig(EncryptionConfig value)
public CreateDatabaseRequest.Builder setEncryptionConfig(EncryptionConfig value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
EncryptionConfig |
| Returns | |
|---|---|
| Type | Description |
CreateDatabaseRequest.Builder |
|
setEncryptionConfig(EncryptionConfig.Builder builderForValue)
public CreateDatabaseRequest.Builder setEncryptionConfig(EncryptionConfig.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
EncryptionConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
CreateDatabaseRequest.Builder |
|
setExtraStatements(int index, String value)
public CreateDatabaseRequest.Builder setExtraStatements(int index, String value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe extraStatements to set. |
| Returns | |
|---|---|
| Type | Description |
CreateDatabaseRequest.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public CreateDatabaseRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CreateDatabaseRequest.Builder |
|
setParent(String value)
public CreateDatabaseRequest.Builder setParent(String value) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
CreateDatabaseRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public CreateDatabaseRequest.Builder setParentBytes(ByteString value) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
CreateDatabaseRequest.Builder |
This builder for chaining. |
setProtoDescriptors(ByteString value)
public CreateDatabaseRequest.Builder setProtoDescriptors(ByteString value) 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 \
--include_imports \
--descriptor_set_out=descriptors.data \
moon/shot/app.proto
</code></code>
For more details, see protobuffer self
description.
bytes proto_descriptors = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe protoDescriptors to set. |
| Returns | |
|---|---|
| Type | Description |
CreateDatabaseRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CreateDatabaseRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CreateDatabaseRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final CreateDatabaseRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CreateDatabaseRequest.Builder |
|