com.google.spanner.v1

Class ExecuteBatchDmlRequest.Statement.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<ExecuteBatchDmlRequest.Statement.Builder>

com.google.spanner.v1.ExecuteBatchDmlRequest.Statement.Builder

All Implemented Interfaces:

Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, ExecuteBatchDmlRequest.StatementOrBuilder, Cloneable

Enclosing class:

ExecuteBatchDmlRequest.Statement

public static final class ExecuteBatchDmlRequest.Statement.Builder
extends GeneratedMessageV3.Builder<ExecuteBatchDmlRequest.Statement.Builder>
implements ExecuteBatchDmlRequest.StatementOrBuilder

 A single DML statement.
 

Protobuf type google.spanner.v1.ExecuteBatchDmlRequest.Statement

Method Summary

Modifier and Type	Method and Description
ExecuteBatchDmlRequest.Statement.Builder	addRepeatedField(Descriptors.FieldDescriptor field, Object value)
ExecuteBatchDmlRequest.Statement	build()
ExecuteBatchDmlRequest.Statement	buildPartial()
ExecuteBatchDmlRequest.Statement.Builder	clear()
ExecuteBatchDmlRequest.Statement.Builder	clearField(Descriptors.FieldDescriptor field)
ExecuteBatchDmlRequest.Statement.Builder	clearOneof(Descriptors.OneofDescriptor oneof)
ExecuteBatchDmlRequest.Statement.Builder	clearParams() Parameter names and values that bind to placeholders in the DML string.
ExecuteBatchDmlRequest.Statement.Builder	clearParamTypes()
ExecuteBatchDmlRequest.Statement.Builder	clearSql() Required.
ExecuteBatchDmlRequest.Statement.Builder	clone()
boolean	containsParamTypes(String key) It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value.
ExecuteBatchDmlRequest.Statement	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType()
Map<String,Type>	getMutableParamTypes() Deprecated.
Struct	getParams() Parameter names and values that bind to placeholders in the DML string.
Struct.Builder	getParamsBuilder() Parameter names and values that bind to placeholders in the DML string.
StructOrBuilder	getParamsOrBuilder() Parameter names and values that bind to placeholders in the DML string.
Map<String,Type>	getParamTypes() Deprecated.
int	getParamTypesCount() It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value.
Map<String,Type>	getParamTypesMap() It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value.
Type	getParamTypesOrDefault(String key, Type defaultValue) It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value.
Type	getParamTypesOrThrow(String key) It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value.
String	getSql() Required.
ByteString	getSqlBytes() Required.
boolean	hasParams() Parameter names and values that bind to placeholders in the DML string.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected MapField	internalGetMapField(int number)
protected MapField	internalGetMutableMapField(int number)
boolean	isInitialized()
ExecuteBatchDmlRequest.Statement.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
ExecuteBatchDmlRequest.Statement.Builder	mergeFrom(ExecuteBatchDmlRequest.Statement other)
ExecuteBatchDmlRequest.Statement.Builder	mergeFrom(Message other)
ExecuteBatchDmlRequest.Statement.Builder	mergeParams(Struct value) Parameter names and values that bind to placeholders in the DML string.
ExecuteBatchDmlRequest.Statement.Builder	mergeUnknownFields(UnknownFieldSet unknownFields)
ExecuteBatchDmlRequest.Statement.Builder	putAllParamTypes(Map<String,Type> values) It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value.
ExecuteBatchDmlRequest.Statement.Builder	putParamTypes(String key, Type value) It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value.
ExecuteBatchDmlRequest.Statement.Builder	removeParamTypes(String key) It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value.
ExecuteBatchDmlRequest.Statement.Builder	setField(Descriptors.FieldDescriptor field, Object value)
ExecuteBatchDmlRequest.Statement.Builder	setParams(Struct.Builder builderForValue) Parameter names and values that bind to placeholders in the DML string.
ExecuteBatchDmlRequest.Statement.Builder	setParams(Struct value) Parameter names and values that bind to placeholders in the DML string.
ExecuteBatchDmlRequest.Statement.Builder	setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
ExecuteBatchDmlRequest.Statement.Builder	setSql(String value) Required.
ExecuteBatchDmlRequest.Statement.Builder	setSqlBytes(ByteString value) Required.
ExecuteBatchDmlRequest.Statement.Builder	setUnknownFields(UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetMapField

protected MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class GeneratedMessageV3.Builder<ExecuteBatchDmlRequest.Statement.Builder>

internalGetMutableMapField

protected MapField internalGetMutableMapField(int number)

Overrides:

internalGetMutableMapField in class GeneratedMessageV3.Builder<ExecuteBatchDmlRequest.Statement.Builder>

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<ExecuteBatchDmlRequest.Statement.Builder>

clear

public ExecuteBatchDmlRequest.Statement.Builder clear()

Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<ExecuteBatchDmlRequest.Statement.Builder>

getDescriptorForType

public Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<ExecuteBatchDmlRequest.Statement.Builder>

getDefaultInstanceForType

public ExecuteBatchDmlRequest.Statement getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build

public ExecuteBatchDmlRequest.Statement build()

Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial

public ExecuteBatchDmlRequest.Statement buildPartial()

Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone

public ExecuteBatchDmlRequest.Statement.Builder clone()

Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<ExecuteBatchDmlRequest.Statement.Builder>

setField

public ExecuteBatchDmlRequest.Statement.Builder setField(Descriptors.FieldDescriptor field,
                                                         Object value)

Specified by:

setField in interface Message.Builder

Overrides:

setField in class GeneratedMessageV3.Builder<ExecuteBatchDmlRequest.Statement.Builder>

clearField

public ExecuteBatchDmlRequest.Statement.Builder clearField(Descriptors.FieldDescriptor field)

Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<ExecuteBatchDmlRequest.Statement.Builder>

clearOneof

public ExecuteBatchDmlRequest.Statement.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<ExecuteBatchDmlRequest.Statement.Builder>

setRepeatedField

public ExecuteBatchDmlRequest.Statement.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                                                 int index,
                                                                 Object value)

Specified by:

setRepeatedField in interface Message.Builder

Overrides:

setRepeatedField in class GeneratedMessageV3.Builder<ExecuteBatchDmlRequest.Statement.Builder>

addRepeatedField

public ExecuteBatchDmlRequest.Statement.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                                                 Object value)

Specified by:

addRepeatedField in interface Message.Builder

Overrides:

addRepeatedField in class GeneratedMessageV3.Builder<ExecuteBatchDmlRequest.Statement.Builder>

mergeFrom

public ExecuteBatchDmlRequest.Statement.Builder mergeFrom(Message other)

Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<ExecuteBatchDmlRequest.Statement.Builder>

mergeFrom

public ExecuteBatchDmlRequest.Statement.Builder mergeFrom(ExecuteBatchDmlRequest.Statement other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<ExecuteBatchDmlRequest.Statement.Builder>

mergeFrom

public ExecuteBatchDmlRequest.Statement.Builder mergeFrom(CodedInputStream input,
                                                          ExtensionRegistryLite extensionRegistry)
                                                   throws IOException

Specified by:

mergeFrom in interface Message.Builder

Specified by:

mergeFrom in interface MessageLite.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<ExecuteBatchDmlRequest.Statement.Builder>

Throws:

IOException

getSql

public String getSql()

 Required. The DML string.
 

string sql = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getSql in interface ExecuteBatchDmlRequest.StatementOrBuilder

Returns:

The sql.

getSqlBytes

public ByteString getSqlBytes()

 Required. The DML string.
 

string sql = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getSqlBytes in interface ExecuteBatchDmlRequest.StatementOrBuilder

Returns:

The bytes for sql.

setSql

public ExecuteBatchDmlRequest.Statement.Builder setSql(String value)

 Required. The DML string.
 

string sql = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters:

value - The sql to set.

Returns:

This builder for chaining.

clearSql

public ExecuteBatchDmlRequest.Statement.Builder clearSql()

 Required. The DML string.
 

string sql = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

This builder for chaining.

setSqlBytes

public ExecuteBatchDmlRequest.Statement.Builder setSqlBytes(ByteString value)

 Required. The DML string.
 

string sql = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters:

value - The bytes for sql to set.

Returns:

This builder for chaining.

hasParams

public boolean hasParams()

 Parameter names and values that bind to placeholders in the DML string.
 A parameter placeholder consists of the `@` character followed by the
 parameter name (for example, `@firstName`). Parameter names can contain
 letters, numbers, and underscores.
 Parameters can appear anywhere that a literal value is expected.  The
 same parameter name can be used more than once, for example:
 `"WHERE id > @msg_id AND id < @msg_id + 100"`
 It is an error to execute a SQL statement with unbound parameters.
 

.google.protobuf.Struct params = 2;

Specified by:

hasParams in interface ExecuteBatchDmlRequest.StatementOrBuilder

Returns:

Whether the params field is set.

getParams

public Struct getParams()

 Parameter names and values that bind to placeholders in the DML string.
 A parameter placeholder consists of the `@` character followed by the
 parameter name (for example, `@firstName`). Parameter names can contain
 letters, numbers, and underscores.
 Parameters can appear anywhere that a literal value is expected.  The
 same parameter name can be used more than once, for example:
 `"WHERE id > @msg_id AND id < @msg_id + 100"`
 It is an error to execute a SQL statement with unbound parameters.
 

.google.protobuf.Struct params = 2;

Specified by:

getParams in interface ExecuteBatchDmlRequest.StatementOrBuilder

Returns:

The params.

setParams

public ExecuteBatchDmlRequest.Statement.Builder setParams(Struct value)

 Parameter names and values that bind to placeholders in the DML string.
 A parameter placeholder consists of the `@` character followed by the
 parameter name (for example, `@firstName`). Parameter names can contain
 letters, numbers, and underscores.
 Parameters can appear anywhere that a literal value is expected.  The
 same parameter name can be used more than once, for example:
 `"WHERE id > @msg_id AND id < @msg_id + 100"`
 It is an error to execute a SQL statement with unbound parameters.
 

.google.protobuf.Struct params = 2;

setParams

public ExecuteBatchDmlRequest.Statement.Builder setParams(Struct.Builder builderForValue)

 Parameter names and values that bind to placeholders in the DML string.
 A parameter placeholder consists of the `@` character followed by the
 parameter name (for example, `@firstName`). Parameter names can contain
 letters, numbers, and underscores.
 Parameters can appear anywhere that a literal value is expected.  The
 same parameter name can be used more than once, for example:
 `"WHERE id > @msg_id AND id < @msg_id + 100"`
 It is an error to execute a SQL statement with unbound parameters.
 

.google.protobuf.Struct params = 2;

mergeParams

public ExecuteBatchDmlRequest.Statement.Builder mergeParams(Struct value)

 Parameter names and values that bind to placeholders in the DML string.
 A parameter placeholder consists of the `@` character followed by the
 parameter name (for example, `@firstName`). Parameter names can contain
 letters, numbers, and underscores.
 Parameters can appear anywhere that a literal value is expected.  The
 same parameter name can be used more than once, for example:
 `"WHERE id > @msg_id AND id < @msg_id + 100"`
 It is an error to execute a SQL statement with unbound parameters.
 

.google.protobuf.Struct params = 2;

clearParams

public ExecuteBatchDmlRequest.Statement.Builder clearParams()

 Parameter names and values that bind to placeholders in the DML string.
 A parameter placeholder consists of the `@` character followed by the
 parameter name (for example, `@firstName`). Parameter names can contain
 letters, numbers, and underscores.
 Parameters can appear anywhere that a literal value is expected.  The
 same parameter name can be used more than once, for example:
 `"WHERE id > @msg_id AND id < @msg_id + 100"`
 It is an error to execute a SQL statement with unbound parameters.
 

.google.protobuf.Struct params = 2;

getParamsBuilder

public Struct.Builder getParamsBuilder()

 Parameter names and values that bind to placeholders in the DML string.
 A parameter placeholder consists of the `@` character followed by the
 parameter name (for example, `@firstName`). Parameter names can contain
 letters, numbers, and underscores.
 Parameters can appear anywhere that a literal value is expected.  The
 same parameter name can be used more than once, for example:
 `"WHERE id > @msg_id AND id < @msg_id + 100"`
 It is an error to execute a SQL statement with unbound parameters.
 

.google.protobuf.Struct params = 2;

getParamsOrBuilder

public StructOrBuilder getParamsOrBuilder()

 Parameter names and values that bind to placeholders in the DML string.
 A parameter placeholder consists of the `@` character followed by the
 parameter name (for example, `@firstName`). Parameter names can contain
 letters, numbers, and underscores.
 Parameters can appear anywhere that a literal value is expected.  The
 same parameter name can be used more than once, for example:
 `"WHERE id > @msg_id AND id < @msg_id + 100"`
 It is an error to execute a SQL statement with unbound parameters.
 

.google.protobuf.Struct params = 2;

Specified by:

getParamsOrBuilder in interface ExecuteBatchDmlRequest.StatementOrBuilder

getParamTypesCount

public int getParamTypesCount()

Description copied from interface: ExecuteBatchDmlRequest.StatementOrBuilder

 It is not always possible for Cloud Spanner to infer the right SQL type
 from a JSON value.  For example, values of type `BYTES` and values
 of type `STRING` both appear in [params][google.spanner.v1.ExecuteBatchDmlRequest.Statement.params] as JSON strings.
 In these cases, `param_types` can be used to specify the exact
 SQL type for some or all of the SQL statement parameters. See the
 definition of [Type][google.spanner.v1.Type] for more information
 about SQL types.
 

map<string, .google.spanner.v1.Type> param_types = 3;

Specified by:

getParamTypesCount in interface ExecuteBatchDmlRequest.StatementOrBuilder

containsParamTypes

public boolean containsParamTypes(String key)

 It is not always possible for Cloud Spanner to infer the right SQL type
 from a JSON value.  For example, values of type `BYTES` and values
 of type `STRING` both appear in [params][google.spanner.v1.ExecuteBatchDmlRequest.Statement.params] as JSON strings.
 In these cases, `param_types` can be used to specify the exact
 SQL type for some or all of the SQL statement parameters. See the
 definition of [Type][google.spanner.v1.Type] for more information
 about SQL types.
 

map<string, .google.spanner.v1.Type> param_types = 3;

Specified by:

containsParamTypes in interface ExecuteBatchDmlRequest.StatementOrBuilder

getParamTypes

@Deprecated
public Map<String,Type> getParamTypes()

Deprecated.

Use getParamTypesMap() instead.

Specified by:

getParamTypes in interface ExecuteBatchDmlRequest.StatementOrBuilder

getParamTypesMap

public Map<String,Type> getParamTypesMap()

 It is not always possible for Cloud Spanner to infer the right SQL type
 from a JSON value.  For example, values of type `BYTES` and values
 of type `STRING` both appear in [params][google.spanner.v1.ExecuteBatchDmlRequest.Statement.params] as JSON strings.
 In these cases, `param_types` can be used to specify the exact
 SQL type for some or all of the SQL statement parameters. See the
 definition of [Type][google.spanner.v1.Type] for more information
 about SQL types.
 

map<string, .google.spanner.v1.Type> param_types = 3;

Specified by:

getParamTypesMap in interface ExecuteBatchDmlRequest.StatementOrBuilder

getParamTypesOrDefault

public Type getParamTypesOrDefault(String key,
                                   Type defaultValue)

 It is not always possible for Cloud Spanner to infer the right SQL type
 from a JSON value.  For example, values of type `BYTES` and values
 of type `STRING` both appear in [params][google.spanner.v1.ExecuteBatchDmlRequest.Statement.params] as JSON strings.
 In these cases, `param_types` can be used to specify the exact
 SQL type for some or all of the SQL statement parameters. See the
 definition of [Type][google.spanner.v1.Type] for more information
 about SQL types.
 

map<string, .google.spanner.v1.Type> param_types = 3;

Specified by:

getParamTypesOrDefault in interface ExecuteBatchDmlRequest.StatementOrBuilder

getParamTypesOrThrow

public Type getParamTypesOrThrow(String key)

 It is not always possible for Cloud Spanner to infer the right SQL type
 from a JSON value.  For example, values of type `BYTES` and values
 of type `STRING` both appear in [params][google.spanner.v1.ExecuteBatchDmlRequest.Statement.params] as JSON strings.
 In these cases, `param_types` can be used to specify the exact
 SQL type for some or all of the SQL statement parameters. See the
 definition of [Type][google.spanner.v1.Type] for more information
 about SQL types.
 

map<string, .google.spanner.v1.Type> param_types = 3;

Specified by:

getParamTypesOrThrow in interface ExecuteBatchDmlRequest.StatementOrBuilder

clearParamTypes

public ExecuteBatchDmlRequest.Statement.Builder clearParamTypes()

removeParamTypes

public ExecuteBatchDmlRequest.Statement.Builder removeParamTypes(String key)

 It is not always possible for Cloud Spanner to infer the right SQL type
 from a JSON value.  For example, values of type `BYTES` and values
 of type `STRING` both appear in [params][google.spanner.v1.ExecuteBatchDmlRequest.Statement.params] as JSON strings.
 In these cases, `param_types` can be used to specify the exact
 SQL type for some or all of the SQL statement parameters. See the
 definition of [Type][google.spanner.v1.Type] for more information
 about SQL types.
 

map<string, .google.spanner.v1.Type> param_types = 3;

getMutableParamTypes

@Deprecated
public Map<String,Type> getMutableParamTypes()

Deprecated.

Use alternate mutation accessors instead.

putParamTypes

public ExecuteBatchDmlRequest.Statement.Builder putParamTypes(String key,
                                                              Type value)

 It is not always possible for Cloud Spanner to infer the right SQL type
 from a JSON value.  For example, values of type `BYTES` and values
 of type `STRING` both appear in [params][google.spanner.v1.ExecuteBatchDmlRequest.Statement.params] as JSON strings.
 In these cases, `param_types` can be used to specify the exact
 SQL type for some or all of the SQL statement parameters. See the
 definition of [Type][google.spanner.v1.Type] for more information
 about SQL types.
 

map<string, .google.spanner.v1.Type> param_types = 3;

putAllParamTypes

public ExecuteBatchDmlRequest.Statement.Builder putAllParamTypes(Map<String,Type> values)

 It is not always possible for Cloud Spanner to infer the right SQL type
 from a JSON value.  For example, values of type `BYTES` and values
 of type `STRING` both appear in [params][google.spanner.v1.ExecuteBatchDmlRequest.Statement.params] as JSON strings.
 In these cases, `param_types` can be used to specify the exact
 SQL type for some or all of the SQL statement parameters. See the
 definition of [Type][google.spanner.v1.Type] for more information
 about SQL types.
 

map<string, .google.spanner.v1.Type> param_types = 3;

setUnknownFields

public final ExecuteBatchDmlRequest.Statement.Builder setUnknownFields(UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface Message.Builder

Overrides:

setUnknownFields in class GeneratedMessageV3.Builder<ExecuteBatchDmlRequest.Statement.Builder>

mergeUnknownFields

public final ExecuteBatchDmlRequest.Statement.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface Message.Builder

Overrides:

mergeUnknownFields in class GeneratedMessageV3.Builder<ExecuteBatchDmlRequest.Statement.Builder>