Interface BatchWriteRequestOrBuilder (6.69.0)

Version 6.69.0

• 6.83.0 (latest)
• 6.82.0
• 6.80.1
• 6.79.0
• 6.77.0
• 6.74.1
• 6.72.0
• 6.71.0
• 6.69.0
• 6.68.0
• 6.66.0
• 6.65.1
• 6.62.0
• 6.60.0
• 6.58.0
• 6.57.0
• 6.56.0
• 6.55.0
• 6.54.0
• 6.53.0
• 6.52.1
• 6.51.0
• 6.50.1
• 6.49.0
• 6.25.1
• 6.24.0
• 6.23.4
• 6.22.0
• 6.21.2
• 6.20.0
• 6.19.1
• 6.18.0
• 6.17.4
• 6.14.1

public interface BatchWriteRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getExcludeTxnFromChangeStreams()

public abstract boolean getExcludeTxnFromChangeStreams()

Optional. When exclude_txn_from_change_streams is set to true:

• Mutations from all transactions in this batch write operation will not be recorded in change streams with DDL option allow_txn_exclusion=true that are tracking columns modified by these transactions.

• Mutations from all transactions in this batch write operation will be recorded in change streams with DDL option allow_txn_exclusion=false or not set that are tracking columns modified by these transactions.

  When exclude_txn_from_change_streams is set to false or not set, mutations from all transactions in this batch write operation will be recorded in all change streams that are tracking columns modified by these transactions.

bool exclude_txn_from_change_streams = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The excludeTxnFromChangeStreams.

getMutationGroups(int index)

public abstract BatchWriteRequest.MutationGroup getMutationGroups(int index)

Required. The groups of mutations to be applied.

repeated .google.spanner.v1.BatchWriteRequest.MutationGroup mutation_groups = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int

Returns
Type	Description
BatchWriteRequest.MutationGroup

getMutationGroupsCount()

public abstract int getMutationGroupsCount()

Required. The groups of mutations to be applied.

repeated .google.spanner.v1.BatchWriteRequest.MutationGroup mutation_groups = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int

getMutationGroupsList()

public abstract List<BatchWriteRequest.MutationGroup> getMutationGroupsList()

Required. The groups of mutations to be applied.

repeated .google.spanner.v1.BatchWriteRequest.MutationGroup mutation_groups = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
List<MutationGroup>

getMutationGroupsOrBuilder(int index)

public abstract BatchWriteRequest.MutationGroupOrBuilder getMutationGroupsOrBuilder(int index)

Required. The groups of mutations to be applied.

repeated .google.spanner.v1.BatchWriteRequest.MutationGroup mutation_groups = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int

Returns
Type	Description
BatchWriteRequest.MutationGroupOrBuilder

getMutationGroupsOrBuilderList()

public abstract List<? extends BatchWriteRequest.MutationGroupOrBuilder> getMutationGroupsOrBuilderList()

Required. The groups of mutations to be applied.

repeated .google.spanner.v1.BatchWriteRequest.MutationGroup mutation_groups = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
List<? extends com.google.spanner.v1.BatchWriteRequest.MutationGroupOrBuilder>

getRequestOptions()

public abstract RequestOptions getRequestOptions()

Common options for this request.

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

Returns
Type	Description
RequestOptions	The requestOptions.

getRequestOptionsOrBuilder()

public abstract RequestOptionsOrBuilder getRequestOptionsOrBuilder()

Common options for this request.

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

Returns
Type	Description
RequestOptionsOrBuilder

getSession()

public abstract String getSession()

Required. The session in which the batch request is to be run.

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

Returns
Type	Description
String	The session.

getSessionBytes()

public abstract ByteString getSessionBytes()

Required. The session in which the batch request is to be run.

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

Returns
Type	Description
ByteString	The bytes for session.

hasRequestOptions()

public abstract boolean hasRequestOptions()

Common options for this request.

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

Returns
Type	Description
boolean	Whether the requestOptions field is set.