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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ExecuteBatchDmlRequest.Statement.BuilderImplements
ExecuteBatchDmlRequest.StatementOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ExecuteBatchDmlRequest.Statement.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ExecuteBatchDmlRequest.Statement.Builder |
build()
public ExecuteBatchDmlRequest.Statement build()
Returns | |
---|---|
Type | Description |
ExecuteBatchDmlRequest.Statement |
buildPartial()
public ExecuteBatchDmlRequest.Statement buildPartial()
Returns | |
---|---|
Type | Description |
ExecuteBatchDmlRequest.Statement |
clear()
public ExecuteBatchDmlRequest.Statement.Builder clear()
Returns | |
---|---|
Type | Description |
ExecuteBatchDmlRequest.Statement.Builder |
clearField(Descriptors.FieldDescriptor field)
public ExecuteBatchDmlRequest.Statement.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
ExecuteBatchDmlRequest.Statement.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public ExecuteBatchDmlRequest.Statement.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
ExecuteBatchDmlRequest.Statement.Builder |
clearParamTypes()
public ExecuteBatchDmlRequest.Statement.Builder clearParamTypes()
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
ExecuteBatchDmlRequest.Statement.Builder |
clearSql()
public ExecuteBatchDmlRequest.Statement.Builder clearSql()
Required. The DML string.
string sql = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
ExecuteBatchDmlRequest.Statement.Builder |
This builder for chaining. |
clone()
public ExecuteBatchDmlRequest.Statement.Builder clone()
Returns | |
---|---|
Type | Description |
ExecuteBatchDmlRequest.Statement.Builder |
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 | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
boolean |
getDefaultInstanceForType()
public ExecuteBatchDmlRequest.Statement getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
ExecuteBatchDmlRequest.Statement |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getMutableParamTypes() (deprecated)
public Map<String,Type> getMutableParamTypes()
Use alternate mutation accessors instead.
Returns | |
---|---|
Type | Description |
Map<String,Type> |
getParamTypes() (deprecated)
public Map<String,Type> getParamTypes()
Use #getParamTypesMap() instead.
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
key |
String |
defaultValue |
Type |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
StructOrBuilder |
getSql()
public String getSql()
Required. The DML string.
string sql = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
String |
The sql. |
getSqlBytes()
public ByteString getSqlBytes()
Required. The DML string.
string sql = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
boolean |
Whether the params field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter | |
---|---|
Name | Description |
number |
int |
Returns | |
---|---|
Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter | |
---|---|
Name | Description |
number |
int |
Returns | |
---|---|
Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ExecuteBatchDmlRequest.Statement.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ExecuteBatchDmlRequest.Statement.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public ExecuteBatchDmlRequest.Statement.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
ExecuteBatchDmlRequest.Statement.Builder |
mergeFrom(ExecuteBatchDmlRequest.Statement other)
public ExecuteBatchDmlRequest.Statement.Builder mergeFrom(ExecuteBatchDmlRequest.Statement other)
Parameter | |
---|---|
Name | Description |
other |
ExecuteBatchDmlRequest.Statement |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
Struct |
Returns | |
---|---|
Type | Description |
ExecuteBatchDmlRequest.Statement.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ExecuteBatchDmlRequest.Statement.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ExecuteBatchDmlRequest.Statement.Builder |
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 | |
---|---|
Name | Description |
values |
Map<String,Type> |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
key |
String |
value |
Type |
Returns | |
---|---|
Type | Description |
ExecuteBatchDmlRequest.Statement.Builder |
putParamTypesBuilderIfAbsent(String key)
public Type.Builder putParamTypesBuilderIfAbsent(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 | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
Type.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 | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
ExecuteBatchDmlRequest.Statement.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public ExecuteBatchDmlRequest.Statement.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ExecuteBatchDmlRequest.Statement.Builder |
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 | |
---|---|
Name | Description |
value |
Struct |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
ExecuteBatchDmlRequest.Statement.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ExecuteBatchDmlRequest.Statement.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
ExecuteBatchDmlRequest.Statement.Builder |
setSql(String value)
public ExecuteBatchDmlRequest.Statement.Builder setSql(String value)
Required. The DML string.
string sql = 1 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
String The sql to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
ByteString The bytes for sql to set. |
Returns | |
---|---|
Type | Description |
ExecuteBatchDmlRequest.Statement.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final ExecuteBatchDmlRequest.Statement.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ExecuteBatchDmlRequest.Statement.Builder |