Class ExecuteBatchDmlRequest.Statement.Builder (6.58.0)

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ExecuteBatchDmlRequest.Statement.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ExecuteBatchDmlRequest.Statement.Builder
Overrides

build()

public ExecuteBatchDmlRequest.Statement build()
Returns
TypeDescription
ExecuteBatchDmlRequest.Statement

buildPartial()

public ExecuteBatchDmlRequest.Statement buildPartial()
Returns
TypeDescription
ExecuteBatchDmlRequest.Statement

clear()

public ExecuteBatchDmlRequest.Statement.Builder clear()
Returns
TypeDescription
ExecuteBatchDmlRequest.Statement.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ExecuteBatchDmlRequest.Statement.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ExecuteBatchDmlRequest.Statement.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ExecuteBatchDmlRequest.Statement.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ExecuteBatchDmlRequest.Statement.Builder
Overrides

clearParamTypes()

public ExecuteBatchDmlRequest.Statement.Builder clearParamTypes()
Returns
TypeDescription
ExecuteBatchDmlRequest.Statement.Builder

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;

Returns
TypeDescription
ExecuteBatchDmlRequest.Statement.Builder

clearSql()

public ExecuteBatchDmlRequest.Statement.Builder clearSql()

Required. The DML string.

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

Returns
TypeDescription
ExecuteBatchDmlRequest.Statement.Builder

This builder for chaining.

clone()

public ExecuteBatchDmlRequest.Statement.Builder clone()
Returns
TypeDescription
ExecuteBatchDmlRequest.Statement.Builder
Overrides

containsParamTypes(String key)

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 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 for more information about SQL types.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getDefaultInstanceForType()

public ExecuteBatchDmlRequest.Statement getDefaultInstanceForType()
Returns
TypeDescription
ExecuteBatchDmlRequest.Statement

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getMutableParamTypes()

public Map<String,Type> getMutableParamTypes()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,Type>

getParamTypes()

public Map<String,Type> getParamTypes()

Use #getParamTypesMap() instead.

Returns
TypeDescription
Map<String,Type>

getParamTypesCount()

public int getParamTypesCount()

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 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 for more information about SQL types.

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

Returns
TypeDescription
int

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 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 for more information about SQL types.

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

Returns
TypeDescription
Map<String,Type>

getParamTypesOrDefault(String key, Type defaultValue)

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 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 for more information about SQL types.

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

Parameters
NameDescription
keyString
defaultValueType
Returns
TypeDescription
Type

getParamTypesOrThrow(String key)

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 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 for more information about SQL types.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
Type

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;

Returns
TypeDescription
Struct

The params.

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;

Returns
TypeDescription
Builder

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;

Returns
TypeDescription
StructOrBuilder

getSql()

public String getSql()

Required. The DML string.

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

Returns
TypeDescription
String

The sql.

getSqlBytes()

public ByteString getSqlBytes()

Required. The DML string.

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

Returns
TypeDescription
ByteString

The bytes for sql.

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;

Returns
TypeDescription
boolean

Whether the params field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExecuteBatchDmlRequest.Statement.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecuteBatchDmlRequest.Statement.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ExecuteBatchDmlRequest.Statement.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ExecuteBatchDmlRequest.Statement.Builder
Overrides

mergeFrom(ExecuteBatchDmlRequest.Statement other)

public ExecuteBatchDmlRequest.Statement.Builder mergeFrom(ExecuteBatchDmlRequest.Statement other)
Parameter
NameDescription
otherExecuteBatchDmlRequest.Statement
Returns
TypeDescription
ExecuteBatchDmlRequest.Statement.Builder

mergeParams(Struct value)

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;

Parameter
NameDescription
valueStruct
Returns
TypeDescription
ExecuteBatchDmlRequest.Statement.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ExecuteBatchDmlRequest.Statement.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ExecuteBatchDmlRequest.Statement.Builder
Overrides

putAllParamTypes(Map<String,Type> values)

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 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 for more information about SQL types.

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

Parameter
NameDescription
valuesMap<String,Type>
Returns
TypeDescription
ExecuteBatchDmlRequest.Statement.Builder

putParamTypes(String key, Type value)

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 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 for more information about SQL types.

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

Parameters
NameDescription
keyString
valueType
Returns
TypeDescription
ExecuteBatchDmlRequest.Statement.Builder

removeParamTypes(String key)

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 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 for more information about SQL types.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
ExecuteBatchDmlRequest.Statement.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ExecuteBatchDmlRequest.Statement.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ExecuteBatchDmlRequest.Statement.Builder
Overrides

setParams(Struct value)

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;

Parameter
NameDescription
valueStruct
Returns
TypeDescription
ExecuteBatchDmlRequest.Statement.Builder

setParams(Struct.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ExecuteBatchDmlRequest.Statement.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ExecuteBatchDmlRequest.Statement.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ExecuteBatchDmlRequest.Statement.Builder
Overrides

setSql(String value)

public ExecuteBatchDmlRequest.Statement.Builder setSql(String value)

Required. The DML string.

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

Parameter
NameDescription
valueString

The sql to set.

Returns
TypeDescription
ExecuteBatchDmlRequest.Statement.Builder

This builder for chaining.

setSqlBytes(ByteString value)

public ExecuteBatchDmlRequest.Statement.Builder setSqlBytes(ByteString value)

Required. The DML string.

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

Parameter
NameDescription
valueByteString

The bytes for sql to set.

Returns
TypeDescription
ExecuteBatchDmlRequest.Statement.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ExecuteBatchDmlRequest.Statement.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ExecuteBatchDmlRequest.Statement.Builder
Overrides