Class ExecuteBatchDmlRequest.Statement (6.71.0)

public static final class ExecuteBatchDmlRequest.Statement extends GeneratedMessageV3 implements ExecuteBatchDmlRequest.StatementOrBuilder

A single DML statement.

Protobuf type google.spanner.v1.ExecuteBatchDmlRequest.Statement

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ExecuteBatchDmlRequest.Statement

Static Fields

PARAMS_FIELD_NUMBER

public static final int PARAMS_FIELD_NUMBER
Field Value
Type Description
int

PARAM_TYPES_FIELD_NUMBER

public static final int PARAM_TYPES_FIELD_NUMBER
Field Value
Type Description
int

SQL_FIELD_NUMBER

public static final int SQL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExecuteBatchDmlRequest.Statement getDefaultInstance()
Returns
Type Description
ExecuteBatchDmlRequest.Statement

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ExecuteBatchDmlRequest.Statement.Builder newBuilder()
Returns
Type Description
ExecuteBatchDmlRequest.Statement.Builder

newBuilder(ExecuteBatchDmlRequest.Statement prototype)

public static ExecuteBatchDmlRequest.Statement.Builder newBuilder(ExecuteBatchDmlRequest.Statement prototype)
Parameter
Name Description
prototype ExecuteBatchDmlRequest.Statement
Returns
Type Description
ExecuteBatchDmlRequest.Statement.Builder

parseDelimitedFrom(InputStream input)

public static ExecuteBatchDmlRequest.Statement parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExecuteBatchDmlRequest.Statement
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecuteBatchDmlRequest.Statement parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteBatchDmlRequest.Statement
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ExecuteBatchDmlRequest.Statement parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ExecuteBatchDmlRequest.Statement
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExecuteBatchDmlRequest.Statement parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteBatchDmlRequest.Statement
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExecuteBatchDmlRequest.Statement parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ExecuteBatchDmlRequest.Statement
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExecuteBatchDmlRequest.Statement parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteBatchDmlRequest.Statement
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExecuteBatchDmlRequest.Statement parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ExecuteBatchDmlRequest.Statement
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecuteBatchDmlRequest.Statement parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteBatchDmlRequest.Statement
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ExecuteBatchDmlRequest.Statement parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExecuteBatchDmlRequest.Statement
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecuteBatchDmlRequest.Statement parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteBatchDmlRequest.Statement
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ExecuteBatchDmlRequest.Statement parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ExecuteBatchDmlRequest.Statement
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExecuteBatchDmlRequest.Statement parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteBatchDmlRequest.Statement
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ExecuteBatchDmlRequest.Statement> parser()
Returns
Type Description
Parser<Statement>

Methods

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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ExecuteBatchDmlRequest.Statement getDefaultInstanceForType()
Returns
Type Description
ExecuteBatchDmlRequest.Statement

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.

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

getParserForType()

public Parser<ExecuteBatchDmlRequest.Statement> getParserForType()
Returns
Type Description
Parser<Statement>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ExecuteBatchDmlRequest.Statement.Builder newBuilderForType()
Returns
Type Description
ExecuteBatchDmlRequest.Statement.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExecuteBatchDmlRequest.Statement.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ExecuteBatchDmlRequest.Statement.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ExecuteBatchDmlRequest.Statement.Builder toBuilder()
Returns
Type Description
ExecuteBatchDmlRequest.Statement.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException