Class ExecuteBatchDmlRequest (6.71.0)

public final class ExecuteBatchDmlRequest extends GeneratedMessageV3 implements ExecuteBatchDmlRequestOrBuilder

The request for ExecuteBatchDml.

Protobuf type google.spanner.v1.ExecuteBatchDmlRequest

Static Fields

REQUEST_OPTIONS_FIELD_NUMBER

public static final int REQUEST_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

SEQNO_FIELD_NUMBER

public static final int SEQNO_FIELD_NUMBER
Field Value
Type Description
int

SESSION_FIELD_NUMBER

public static final int SESSION_FIELD_NUMBER
Field Value
Type Description
int

STATEMENTS_FIELD_NUMBER

public static final int STATEMENTS_FIELD_NUMBER
Field Value
Type Description
int

TRANSACTION_FIELD_NUMBER

public static final int TRANSACTION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExecuteBatchDmlRequest getDefaultInstance()
Returns
Type Description
ExecuteBatchDmlRequest

getDescriptor()

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

newBuilder()

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

newBuilder(ExecuteBatchDmlRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ExecuteBatchDmlRequest getDefaultInstanceForType()
Returns
Type Description
ExecuteBatchDmlRequest

getParserForType()

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

getRequestOptions()

public RequestOptions getRequestOptions()

Common options for this request.

.google.spanner.v1.RequestOptions request_options = 5;

Returns
Type Description
RequestOptions

The requestOptions.

getRequestOptionsOrBuilder()

public RequestOptionsOrBuilder getRequestOptionsOrBuilder()

Common options for this request.

.google.spanner.v1.RequestOptions request_options = 5;

Returns
Type Description
RequestOptionsOrBuilder

getSeqno()

public long getSeqno()

Required. A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one will succeed.

The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution.

int64 seqno = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
long

The seqno.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSession()

public String getSession()

Required. The session in which the DML statements should be performed.

string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The session.

getSessionBytes()

public ByteString getSessionBytes()

Required. The session in which the DML statements should be performed.

string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for session.

getStatements(int index)

public ExecuteBatchDmlRequest.Statement getStatements(int index)

Required. The list of statements to execute in this batch. Statements are executed serially, such that the effects of statement i are visible to statement i+1. Each statement must be a DML statement. Execution stops at the first failed statement; the remaining statements are not executed.

Callers must provide at least one statement.

repeated .google.spanner.v1.ExecuteBatchDmlRequest.Statement statements = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
ExecuteBatchDmlRequest.Statement

getStatementsCount()

public int getStatementsCount()

Required. The list of statements to execute in this batch. Statements are executed serially, such that the effects of statement i are visible to statement i+1. Each statement must be a DML statement. Execution stops at the first failed statement; the remaining statements are not executed.

Callers must provide at least one statement.

repeated .google.spanner.v1.ExecuteBatchDmlRequest.Statement statements = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getStatementsList()

public List<ExecuteBatchDmlRequest.Statement> getStatementsList()

Required. The list of statements to execute in this batch. Statements are executed serially, such that the effects of statement i are visible to statement i+1. Each statement must be a DML statement. Execution stops at the first failed statement; the remaining statements are not executed.

Callers must provide at least one statement.

repeated .google.spanner.v1.ExecuteBatchDmlRequest.Statement statements = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Statement>

getStatementsOrBuilder(int index)

public ExecuteBatchDmlRequest.StatementOrBuilder getStatementsOrBuilder(int index)

Required. The list of statements to execute in this batch. Statements are executed serially, such that the effects of statement i are visible to statement i+1. Each statement must be a DML statement. Execution stops at the first failed statement; the remaining statements are not executed.

Callers must provide at least one statement.

repeated .google.spanner.v1.ExecuteBatchDmlRequest.Statement statements = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
ExecuteBatchDmlRequest.StatementOrBuilder

getStatementsOrBuilderList()

public List<? extends ExecuteBatchDmlRequest.StatementOrBuilder> getStatementsOrBuilderList()

Required. The list of statements to execute in this batch. Statements are executed serially, such that the effects of statement i are visible to statement i+1. Each statement must be a DML statement. Execution stops at the first failed statement; the remaining statements are not executed.

Callers must provide at least one statement.

repeated .google.spanner.v1.ExecuteBatchDmlRequest.Statement statements = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.spanner.v1.ExecuteBatchDmlRequest.StatementOrBuilder>

getTransaction()

public TransactionSelector getTransaction()

Required. The transaction to use. Must be a read-write transaction.

To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction.

.google.spanner.v1.TransactionSelector transaction = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TransactionSelector

The transaction.

getTransactionOrBuilder()

public TransactionSelectorOrBuilder getTransactionOrBuilder()

Required. The transaction to use. Must be a read-write transaction.

To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction.

.google.spanner.v1.TransactionSelector transaction = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TransactionSelectorOrBuilder

hasRequestOptions()

public boolean hasRequestOptions()

Common options for this request.

.google.spanner.v1.RequestOptions request_options = 5;

Returns
Type Description
boolean

Whether the requestOptions field is set.

hasTransaction()

public boolean hasTransaction()

Required. The transaction to use. Must be a read-write transaction.

To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction.

.google.spanner.v1.TransactionSelector transaction = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the transaction field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExecuteBatchDmlRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ExecuteBatchDmlRequest.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.Builder toBuilder()
Returns
Type Description
ExecuteBatchDmlRequest.Builder

writeTo(CodedOutputStream output)

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