public final class BatchWriteRequest extends GeneratedMessageV3 implements BatchWriteRequestOrBuilder
The request for BatchWrite.
Protobuf type google.spanner.v1.BatchWriteRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static BatchWriteRequest.Builder newBuilder()
newBuilder(BatchWriteRequest prototype)
public static BatchWriteRequest.Builder newBuilder(BatchWriteRequest prototype)
public static BatchWriteRequest parseDelimitedFrom(InputStream input)
public static BatchWriteRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static BatchWriteRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BatchWriteRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static BatchWriteRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BatchWriteRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BatchWriteRequest parseFrom(CodedInputStream input)
public static BatchWriteRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static BatchWriteRequest parseFrom(InputStream input)
public static BatchWriteRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static BatchWriteRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BatchWriteRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<BatchWriteRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public BatchWriteRequest getDefaultInstanceForType()
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
|
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];
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
|
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()
Overrides
getRequestOptions()
public RequestOptions getRequestOptions()
Common options for this request.
.google.spanner.v1.RequestOptions request_options = 3;
getRequestOptionsOrBuilder()
public RequestOptionsOrBuilder getRequestOptionsOrBuilder()
Common options for this request.
.google.spanner.v1.RequestOptions request_options = 3;
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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public BatchWriteRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected BatchWriteRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public BatchWriteRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
