com.google.api.services.spanner.v1.model

Class CreateDatabaseRequest

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.spanner.v1.model.CreateDatabaseRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class CreateDatabaseRequest
extends com.google.api.client.json.GenericJson

The request for CreateDatabase.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Spanner API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
CreateDatabaseRequest()

Method Summary

Modifier and Type	Method and Description
CreateDatabaseRequest	clone()
byte[]	decodeProtoDescriptors() Optional.
CreateDatabaseRequest	encodeProtoDescriptors(byte[] protoDescriptors) Optional.
String	getCreateStatement() Required.
String	getDatabaseDialect() Optional.
EncryptionConfig	getEncryptionConfig() Optional.
List<String>	getExtraStatements() Optional.
String	getProtoDescriptors() Optional.
CreateDatabaseRequest	set(String fieldName, Object value)
CreateDatabaseRequest	setCreateStatement(String createStatement) Required.
CreateDatabaseRequest	setDatabaseDialect(String databaseDialect) Optional.
CreateDatabaseRequest	setEncryptionConfig(EncryptionConfig encryptionConfig) Optional.
CreateDatabaseRequest	setExtraStatements(List<String> extraStatements) Optional.
CreateDatabaseRequest	setProtoDescriptors(String protoDescriptors) Optional.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

CreateDatabaseRequest

public CreateDatabaseRequest()

Method Detail

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 (`` ` ``).

Returns:

value or null for none

setCreateStatement

public CreateDatabaseRequest setCreateStatement(String createStatement)

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 (`` ` ``).

Parameters:

createStatement - createStatement or null for none

getDatabaseDialect

public String getDatabaseDialect()

Optional. The dialect of the Cloud Spanner Database.

Returns:

value or null for none

setDatabaseDialect

public CreateDatabaseRequest setDatabaseDialect(String databaseDialect)

Optional. The dialect of the Cloud Spanner Database.

Parameters:

databaseDialect - databaseDialect or null for none

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.

Returns:

value or null for none

setEncryptionConfig

public CreateDatabaseRequest setEncryptionConfig(EncryptionConfig encryptionConfig)

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.

Parameters:

encryptionConfig - encryptionConfig or null for none

getExtraStatements

public List<String> getExtraStatements()

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.

Returns:

value or null for none

setExtraStatements

public CreateDatabaseRequest setExtraStatements(List<String> extraStatements)

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.

Parameters:

extraStatements - extraStatements or null for none

getProtoDescriptors

public String getProtoDescriptors()

Optional. Proto descriptors used by `CREATE/ALTER PROTO BUNDLE` statements in 'extra_statements'. Contains a protobuf-serialized [`google.protobuf.FileDescriptorSet`](https: //github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto) descriptor set. To generate it, [install](https://grpc.io/docs/protoc-installation/) and run `protoc` with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run ``` $protoc --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ --descriptor_set_out=descriptors.data \ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol- buffers/docs/techniques#self-description).

Returns:

value or null for none

See Also:

decodeProtoDescriptors()

decodeProtoDescriptors

public byte[] decodeProtoDescriptors()

Optional. Proto descriptors used by `CREATE/ALTER PROTO BUNDLE` statements in 'extra_statements'. Contains a protobuf-serialized [`google.protobuf.FileDescriptorSet`](https: //github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto) descriptor set. To generate it, [install](https://grpc.io/docs/protoc-installation/) and run `protoc` with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run ``` $protoc --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ --descriptor_set_out=descriptors.data \ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol- buffers/docs/techniques#self-description).

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getProtoDescriptors()

setProtoDescriptors

public CreateDatabaseRequest setProtoDescriptors(String protoDescriptors)

Optional. Proto descriptors used by `CREATE/ALTER PROTO BUNDLE` statements in 'extra_statements'. Contains a protobuf-serialized [`google.protobuf.FileDescriptorSet`](https: //github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto) descriptor set. To generate it, [install](https://grpc.io/docs/protoc-installation/) and run `protoc` with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run ``` $protoc --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ --descriptor_set_out=descriptors.data \ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol- buffers/docs/techniques#self-description).

Parameters:

protoDescriptors - protoDescriptors or null for none

See Also:

#encodeProtoDescriptors()

encodeProtoDescriptors

public CreateDatabaseRequest encodeProtoDescriptors(byte[] protoDescriptors)

Optional. Proto descriptors used by `CREATE/ALTER PROTO BUNDLE` statements in 'extra_statements'. Contains a protobuf-serialized [`google.protobuf.FileDescriptorSet`](https: //github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto) descriptor set. To generate it, [install](https://grpc.io/docs/protoc-installation/) and run `protoc` with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run ``` $protoc --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ --descriptor_set_out=descriptors.data \ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol- buffers/docs/techniques#self-description).

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

set

public CreateDatabaseRequest set(String fieldName,
                                 Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public CreateDatabaseRequest clone()

Overrides:

clone in class com.google.api.client.json.GenericJson