Class BatchWriteRequest (6.89.0)

publicfinalclassBatchWriteRequestextendsGeneratedMessageV3implementsBatchWriteRequestOrBuilder

The request for BatchWrite.

Protobuf type google.spanner.v1.BatchWriteRequest

Static Fields

EXCLUDE_TXN_FROM_CHANGE_STREAMS_FIELD_NUMBER

publicstaticfinalintEXCLUDE_TXN_FROM_CHANGE_STREAMS_FIELD_NUMBER
Field Value
TypeDescription
int

MUTATION_GROUPS_FIELD_NUMBER

publicstaticfinalintMUTATION_GROUPS_FIELD_NUMBER
Field Value
TypeDescription
int

REQUEST_OPTIONS_FIELD_NUMBER

publicstaticfinalintREQUEST_OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

SESSION_FIELD_NUMBER

publicstaticfinalintSESSION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

publicstaticBatchWriteRequestgetDefaultInstance()
Returns
TypeDescription
BatchWriteRequest

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

publicstaticBatchWriteRequest.BuildernewBuilder()
Returns
TypeDescription
BatchWriteRequest.Builder

newBuilder(BatchWriteRequest prototype)

publicstaticBatchWriteRequest.BuildernewBuilder(BatchWriteRequestprototype)
Parameter
NameDescription
prototypeBatchWriteRequest
Returns
TypeDescription
BatchWriteRequest.Builder

parseDelimitedFrom(InputStream input)

publicstaticBatchWriteRequestparseDelimitedFrom(InputStreaminput)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BatchWriteRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticBatchWriteRequestparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchWriteRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

publicstaticBatchWriteRequestparseFrom(byte[]data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
BatchWriteRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticBatchWriteRequestparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchWriteRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticBatchWriteRequestparseFrom(ByteStringdata)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
BatchWriteRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticBatchWriteRequestparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchWriteRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticBatchWriteRequestparseFrom(CodedInputStreaminput)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
BatchWriteRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticBatchWriteRequestparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchWriteRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

publicstaticBatchWriteRequestparseFrom(InputStreaminput)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BatchWriteRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticBatchWriteRequestparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchWriteRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

publicstaticBatchWriteRequestparseFrom(ByteBufferdata)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
BatchWriteRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticBatchWriteRequestparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchWriteRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

publicstaticParser<BatchWriteRequest>parser()
Returns
TypeDescription
Parser<BatchWriteRequest>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

publicBatchWriteRequestgetDefaultInstanceForType()
Returns
TypeDescription
BatchWriteRequest

getExcludeTxnFromChangeStreams()

publicbooleangetExcludeTxnFromChangeStreams()

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
TypeDescription
boolean

The excludeTxnFromChangeStreams.

getMutationGroups(int index)

publicBatchWriteRequest.MutationGroupgetMutationGroups(intindex)

Required. The groups of mutations to be applied.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
BatchWriteRequest.MutationGroup

getMutationGroupsCount()

publicintgetMutationGroupsCount()

Required. The groups of mutations to be applied.

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

Returns
TypeDescription
int

getMutationGroupsList()

publicList<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
TypeDescription
List<MutationGroup>

getMutationGroupsOrBuilder(int index)

publicBatchWriteRequest.MutationGroupOrBuildergetMutationGroupsOrBuilder(intindex)

Required. The groups of mutations to be applied.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
BatchWriteRequest.MutationGroupOrBuilder

getMutationGroupsOrBuilderList()

publicList<?extendsBatchWriteRequest.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
TypeDescription
List<? extends com.google.spanner.v1.BatchWriteRequest.MutationGroupOrBuilder>

getParserForType()

publicParser<BatchWriteRequest>getParserForType()
Returns
TypeDescription
Parser<BatchWriteRequest>
Overrides

getRequestOptions()

publicRequestOptionsgetRequestOptions()

Common options for this request.

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

Returns
TypeDescription
RequestOptions

The requestOptions.

getRequestOptionsOrBuilder()

publicRequestOptionsOrBuildergetRequestOptionsOrBuilder()

Common options for this request.

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

Returns
TypeDescription
RequestOptionsOrBuilder

getSerializedSize()

publicintgetSerializedSize()
Returns
TypeDescription
int
Overrides

getSession()

publicStringgetSession()

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
TypeDescription
String

The session.

getSessionBytes()

publicByteStringgetSessionBytes()

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
TypeDescription
ByteString

The bytes for session.

hasRequestOptions()

publicbooleanhasRequestOptions()

Common options for this request.

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

Returns
TypeDescription
boolean

Whether the requestOptions field is set.

hashCode()

publicinthashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

publicBatchWriteRequest.BuildernewBuilderForType()
Returns
TypeDescription
BatchWriteRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedBatchWriteRequest.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
BatchWriteRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

publicBatchWriteRequest.BuildertoBuilder()
Returns
TypeDescription
BatchWriteRequest.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException