Class ExecuteBatchDmlRequest.Builder (6.66.0)

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

The request for ExecuteBatchDml.

Protobuf type google.spanner.v1.ExecuteBatchDmlRequest

Static Methods

getDescriptor()

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

Methods

addAllStatements(Iterable<? extends ExecuteBatchDmlRequest.Statement> values)

public ExecuteBatchDmlRequest.Builder addAllStatements(Iterable<? extends ExecuteBatchDmlRequest.Statement> values)

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
values Iterable<? extends com.google.spanner.v1.ExecuteBatchDmlRequest.Statement>
Returns
Type Description
ExecuteBatchDmlRequest.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ExecuteBatchDmlRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ExecuteBatchDmlRequest.Builder
Overrides

addStatements(ExecuteBatchDmlRequest.Statement value)

public ExecuteBatchDmlRequest.Builder addStatements(ExecuteBatchDmlRequest.Statement value)

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
value ExecuteBatchDmlRequest.Statement
Returns
Type Description
ExecuteBatchDmlRequest.Builder

addStatements(ExecuteBatchDmlRequest.Statement.Builder builderForValue)

public ExecuteBatchDmlRequest.Builder addStatements(ExecuteBatchDmlRequest.Statement.Builder builderForValue)

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
builderForValue ExecuteBatchDmlRequest.Statement.Builder
Returns
Type Description
ExecuteBatchDmlRequest.Builder

addStatements(int index, ExecuteBatchDmlRequest.Statement value)

public ExecuteBatchDmlRequest.Builder addStatements(int index, ExecuteBatchDmlRequest.Statement value)

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];

Parameters
Name Description
index int
value ExecuteBatchDmlRequest.Statement
Returns
Type Description
ExecuteBatchDmlRequest.Builder

addStatements(int index, ExecuteBatchDmlRequest.Statement.Builder builderForValue)

public ExecuteBatchDmlRequest.Builder addStatements(int index, ExecuteBatchDmlRequest.Statement.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue ExecuteBatchDmlRequest.Statement.Builder
Returns
Type Description
ExecuteBatchDmlRequest.Builder

addStatementsBuilder()

public ExecuteBatchDmlRequest.Statement.Builder addStatementsBuilder()

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
ExecuteBatchDmlRequest.Statement.Builder

addStatementsBuilder(int index)

public ExecuteBatchDmlRequest.Statement.Builder addStatementsBuilder(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.Builder

build()

public ExecuteBatchDmlRequest build()
Returns
Type Description
ExecuteBatchDmlRequest

buildPartial()

public ExecuteBatchDmlRequest buildPartial()
Returns
Type Description
ExecuteBatchDmlRequest

clear()

public ExecuteBatchDmlRequest.Builder clear()
Returns
Type Description
ExecuteBatchDmlRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ExecuteBatchDmlRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ExecuteBatchDmlRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ExecuteBatchDmlRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ExecuteBatchDmlRequest.Builder
Overrides

clearRequestOptions()

public ExecuteBatchDmlRequest.Builder clearRequestOptions()

Common options for this request.

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

Returns
Type Description
ExecuteBatchDmlRequest.Builder

clearSeqno()

public ExecuteBatchDmlRequest.Builder clearSeqno()

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
ExecuteBatchDmlRequest.Builder

This builder for chaining.

clearSession()

public ExecuteBatchDmlRequest.Builder clearSession()

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
ExecuteBatchDmlRequest.Builder

This builder for chaining.

clearStatements()

public ExecuteBatchDmlRequest.Builder clearStatements()

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
ExecuteBatchDmlRequest.Builder

clearTransaction()

public ExecuteBatchDmlRequest.Builder clearTransaction()

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
ExecuteBatchDmlRequest.Builder

clone()

public ExecuteBatchDmlRequest.Builder clone()
Returns
Type Description
ExecuteBatchDmlRequest.Builder
Overrides

getDefaultInstanceForType()

public ExecuteBatchDmlRequest getDefaultInstanceForType()
Returns
Type Description
ExecuteBatchDmlRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getRequestOptions()

public RequestOptions getRequestOptions()

Common options for this request.

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

Returns
Type Description
RequestOptions

The requestOptions.

getRequestOptionsBuilder()

public RequestOptions.Builder getRequestOptionsBuilder()

Common options for this request.

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

Returns
Type Description
RequestOptions.Builder

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.

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

getStatementsBuilder(int index)

public ExecuteBatchDmlRequest.Statement.Builder getStatementsBuilder(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.Builder

getStatementsBuilderList()

public List<ExecuteBatchDmlRequest.Statement.Builder> getStatementsBuilderList()

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<Builder>

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.

getTransactionBuilder()

public TransactionSelector.Builder getTransactionBuilder()

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.Builder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExecuteBatchDmlRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteBatchDmlRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ExecuteBatchDmlRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ExecuteBatchDmlRequest.Builder
Overrides

mergeFrom(ExecuteBatchDmlRequest other)

public ExecuteBatchDmlRequest.Builder mergeFrom(ExecuteBatchDmlRequest other)
Parameter
Name Description
other ExecuteBatchDmlRequest
Returns
Type Description
ExecuteBatchDmlRequest.Builder

mergeRequestOptions(RequestOptions value)

public ExecuteBatchDmlRequest.Builder mergeRequestOptions(RequestOptions value)

Common options for this request.

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

Parameter
Name Description
value RequestOptions
Returns
Type Description
ExecuteBatchDmlRequest.Builder

mergeTransaction(TransactionSelector value)

public ExecuteBatchDmlRequest.Builder mergeTransaction(TransactionSelector value)

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];

Parameter
Name Description
value TransactionSelector
Returns
Type Description
ExecuteBatchDmlRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ExecuteBatchDmlRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ExecuteBatchDmlRequest.Builder
Overrides

removeStatements(int index)

public ExecuteBatchDmlRequest.Builder removeStatements(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.Builder