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

Class UpdateDatabaseDdlRequest

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Enqueues the given DDL statements to be applied, in order but not necessarily all at once, to the database schema at some point (or points) in the future. The server checks that the statements are executable (syntactically valid, name tables that exist, etc.) before enqueueing them, but they may still fail upon later execution (e.g., if a statement from another batch of statements is applied first and it conflicts in some way, or if there is some data-related problem like a `NULL` value in a column to which `NOT NULL` would be added). If a statement fails, all subsequent statements in the batch are automatically cancelled. Each batch of statements is assigned a name which can be used with the Operations API to monitor progress. See the operation_id field for more details.

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
UpdateDatabaseDdlRequest()

Method Summary

Modifier and Type	Method and Description
UpdateDatabaseDdlRequest	clone()
byte[]	decodeProtoDescriptors() Optional.
UpdateDatabaseDdlRequest	encodeProtoDescriptors(byte[] protoDescriptors) Optional.
String	getOperationId() If empty, the new update request is assigned an automatically-generated operation ID.
String	getProtoDescriptors() Optional.
List<String>	getStatements() Required.
UpdateDatabaseDdlRequest	set(String fieldName, Object value)
UpdateDatabaseDdlRequest	setOperationId(String operationId) If empty, the new update request is assigned an automatically-generated operation ID.
UpdateDatabaseDdlRequest	setProtoDescriptors(String protoDescriptors) Optional.
UpdateDatabaseDdlRequest	setStatements(List<String> statements) Required.

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

UpdateDatabaseDdlRequest

public UpdateDatabaseDdlRequest()

Method Detail

getOperationId

public String getOperationId()

If empty, the new update request is assigned an automatically-generated operation ID. Otherwise, `operation_id` is used to construct the name of the resulting Operation. Specifying an explicit operation ID simplifies determining whether the statements were executed in the event that the UpdateDatabaseDdl call is replayed, or the return value is otherwise lost: the database and `operation_id` fields can be combined to form the `name` of the resulting longrunning.Operation: `/operations/`. `operation_id` should be unique within the database, and must be a valid identifier: `a-z*`. Note that automatically-generated operation IDs always begin with an underscore. If the named operation already exists, UpdateDatabaseDdl returns `ALREADY_EXISTS`.

Returns:

value or null for none

setOperationId

public UpdateDatabaseDdlRequest setOperationId(String operationId)

If empty, the new update request is assigned an automatically-generated operation ID. Otherwise, `operation_id` is used to construct the name of the resulting Operation. Specifying an explicit operation ID simplifies determining whether the statements were executed in the event that the UpdateDatabaseDdl call is replayed, or the return value is otherwise lost: the database and `operation_id` fields can be combined to form the `name` of the resulting longrunning.Operation: `/operations/`. `operation_id` should be unique within the database, and must be a valid identifier: `a-z*`. Note that automatically-generated operation IDs always begin with an underscore. If the named operation already exists, UpdateDatabaseDdl returns `ALREADY_EXISTS`.

Parameters:

operationId - operationId or null for none

getProtoDescriptors

public String getProtoDescriptors()

Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements. Contains a protobuf- serialized [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob /main/src/google/protobuf/descriptor.proto). 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. Contains a protobuf- serialized [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob /main/src/google/protobuf/descriptor.proto). 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 UpdateDatabaseDdlRequest setProtoDescriptors(String protoDescriptors)

Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements. Contains a protobuf- serialized [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob /main/src/google/protobuf/descriptor.proto). 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 UpdateDatabaseDdlRequest encodeProtoDescriptors(byte[] protoDescriptors)

Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements. Contains a protobuf- serialized [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob /main/src/google/protobuf/descriptor.proto). 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.

getStatements

public List<String> getStatements()

Required. DDL statements to be applied to the database.

Returns:

value or null for none

setStatements

public UpdateDatabaseDdlRequest setStatements(List<String> statements)

Required. DDL statements to be applied to the database.

Parameters:

statements - statements or null for none

set

public UpdateDatabaseDdlRequest set(String fieldName,
                                    Object value)

Overrides:

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

clone

public UpdateDatabaseDdlRequest clone()

Overrides:

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