Class BatchWriteRequest (6.71.0)

public final class BatchWriteRequest extends GeneratedMessageV3 implements BatchWriteRequestOrBuilder

The request for BatchWrite.

Protobuf type google.spanner.v1.BatchWriteRequest

Static Fields

EXCLUDE_TXN_FROM_CHANGE_STREAMS_FIELD_NUMBER

public static final int EXCLUDE_TXN_FROM_CHANGE_STREAMS_FIELD_NUMBER
Field Value
Type Description
int

MUTATION_GROUPS_FIELD_NUMBER

public static final int MUTATION_GROUPS_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_OPTIONS_FIELD_NUMBER

public static final int REQUEST_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

SESSION_FIELD_NUMBER

public static final int SESSION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BatchWriteRequest getDefaultInstance()
Returns
Type Description
BatchWriteRequest

getDescriptor()

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

newBuilder()

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

newBuilder(BatchWriteRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public BatchWriteRequest getDefaultInstanceForType()
Returns
Type Description
BatchWriteRequest

getExcludeTxnFromChangeStreams()

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

getParserForType()

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

getRequestOptions()

public RequestOptions getRequestOptions()

Common options for this request.

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

Returns
Type Description
RequestOptions

The requestOptions.

getRequestOptionsOrBuilder()

public RequestOptionsOrBuilder getRequestOptionsOrBuilder()

Common options for this request.

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

Returns
Type Description
RequestOptionsOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSession()

public 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 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 boolean hasRequestOptions()

Common options for this request.

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

Returns
Type Description
boolean

Whether the requestOptions 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 BatchWriteRequest.Builder newBuilderForType()
Returns
Type Description
BatchWriteRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public BatchWriteRequest.Builder toBuilder()
Returns
Type Description
BatchWriteRequest.Builder

writeTo(CodedOutputStream output)

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