publicfinalclassCommitRequestextendsGeneratedMessageV3implementsCommitRequestOrBuilder
The request for Commit.
Protobuf type google.spanner.v1.CommitRequest
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
MAX_COMMIT_DELAY_FIELD_NUMBER
publicstaticfinalintMAX_COMMIT_DELAY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MUTATIONS_FIELD_NUMBER
publicstaticfinalintMUTATIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PRECOMMIT_TOKEN_FIELD_NUMBER
publicstaticfinalintPRECOMMIT_TOKEN_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
REQUEST_OPTIONS_FIELD_NUMBER
publicstaticfinalintREQUEST_OPTIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RETURN_COMMIT_STATS_FIELD_NUMBER
publicstaticfinalintRETURN_COMMIT_STATS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SESSION_FIELD_NUMBER
publicstaticfinalintSESSION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SINGLE_USE_TRANSACTION_FIELD_NUMBER
publicstaticfinalintSINGLE_USE_TRANSACTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TRANSACTION_ID_FIELD_NUMBER
publicstaticfinalintTRANSACTION_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
publicstaticCommitRequestgetDefaultInstance()
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()
newBuilder()
publicstaticCommitRequest.BuildernewBuilder()
newBuilder(CommitRequest prototype)
publicstaticCommitRequest.BuildernewBuilder(CommitRequestprototype)
publicstaticCommitRequestparseDelimitedFrom(InputStreaminput)
publicstaticCommitRequestparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(byte[] data)
publicstaticCommitRequestparseFrom(byte[]data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticCommitRequestparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteString data)
publicstaticCommitRequestparseFrom(ByteStringdata)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticCommitRequestparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
publicstaticCommitRequestparseFrom(CodedInputStreaminput)
publicstaticCommitRequestparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
publicstaticCommitRequestparseFrom(InputStreaminput)
publicstaticCommitRequestparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteBuffer data)
publicstaticCommitRequestparseFrom(ByteBufferdata)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticCommitRequestparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
parser()
publicstaticParser<CommitRequest>parser()
Methods
equals(Object obj)
publicbooleanequals(Objectobj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
OverridesgetDefaultInstanceForType()
publicCommitRequestgetDefaultInstanceForType()
getMaxCommitDelay()
publicDurationgetMaxCommitDelay()
Optional. The amount of latency this request is willing to incur in order to improve throughput. If this field is not set, Spanner assumes requests are relatively latency sensitive and automatically determines an appropriate delay time. You can specify a batching delay value between 0 and 500 ms.
.google.protobuf.Duration max_commit_delay = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
Duration | The maxCommitDelay. |
getMaxCommitDelayOrBuilder()
publicDurationOrBuildergetMaxCommitDelayOrBuilder()
Optional. The amount of latency this request is willing to incur in order to improve throughput. If this field is not set, Spanner assumes requests are relatively latency sensitive and automatically determines an appropriate delay time. You can specify a batching delay value between 0 and 500 ms.
.google.protobuf.Duration max_commit_delay = 8 [(.google.api.field_behavior) = OPTIONAL];
getMutations(int index)
publicMutationgetMutations(intindex)
The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.
repeated .google.spanner.v1.Mutation mutations = 4;
| Parameter |
|---|
| Name | Description |
index | int
|
getMutationsCount()
publicintgetMutationsCount()
The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.
repeated .google.spanner.v1.Mutation mutations = 4;
| Returns |
|---|
| Type | Description |
int | |
getMutationsList()
publicList<Mutation>getMutationsList()
The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.
repeated .google.spanner.v1.Mutation mutations = 4;
getMutationsOrBuilder(int index)
publicMutationOrBuildergetMutationsOrBuilder(intindex)
The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.
repeated .google.spanner.v1.Mutation mutations = 4;
| Parameter |
|---|
| Name | Description |
index | int
|
getMutationsOrBuilderList()
publicList<?extendsMutationOrBuilder>getMutationsOrBuilderList()
The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.
repeated .google.spanner.v1.Mutation mutations = 4;
| Returns |
|---|
| Type | Description |
List<? extends com.google.spanner.v1.MutationOrBuilder> | |
getParserForType()
publicParser<CommitRequest>getParserForType()
getPrecommitToken()
publicMultiplexedSessionPrecommitTokengetPrecommitToken()
Optional. If the read-write transaction was executed on a multiplexed session, the precommit token with the highest sequence number received in this transaction attempt, should be included here. Failing to do so will result in a FailedPrecondition error. This feature is not yet supported and will result in an UNIMPLEMENTED error.
.google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 9 [(.google.api.field_behavior) = OPTIONAL];
getPrecommitTokenOrBuilder()
publicMultiplexedSessionPrecommitTokenOrBuildergetPrecommitTokenOrBuilder()
Optional. If the read-write transaction was executed on a multiplexed session, the precommit token with the highest sequence number received in this transaction attempt, should be included here. Failing to do so will result in a FailedPrecondition error. This feature is not yet supported and will result in an UNIMPLEMENTED error.
.google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 9 [(.google.api.field_behavior) = OPTIONAL];
getRequestOptions()
publicRequestOptionsgetRequestOptions()
Common options for this request.
.google.spanner.v1.RequestOptions request_options = 6;
getRequestOptionsOrBuilder()
publicRequestOptionsOrBuildergetRequestOptionsOrBuilder()
Common options for this request.
.google.spanner.v1.RequestOptions request_options = 6;
getReturnCommitStats()
publicbooleangetReturnCommitStats()
If true, then statistics related to the transaction will be included in the CommitResponse. Default value is false.
bool return_commit_stats = 5;
| Returns |
|---|
| Type | Description |
boolean | The returnCommitStats. |
getSerializedSize()
publicintgetSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
OverridesgetSession()
Required. The session in which the transaction to be committed is running.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
String | The session. |
getSessionBytes()
publicByteStringgetSessionBytes()
Required. The session in which the transaction to be committed is running.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
ByteString | The bytes for session. |
getSingleUseTransaction()
publicTransactionOptionsgetSingleUseTransaction()
Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the CommitRequest is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it is possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead.
.google.spanner.v1.TransactionOptions single_use_transaction = 3;
getSingleUseTransactionOrBuilder()
publicTransactionOptionsOrBuildergetSingleUseTransactionOrBuilder()
Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the CommitRequest is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it is possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead.
.google.spanner.v1.TransactionOptions single_use_transaction = 3;
getTransactionCase()
publicCommitRequest.TransactionCasegetTransactionCase()
getTransactionId()
publicByteStringgetTransactionId()
Commit a previously-started transaction.
bytes transaction_id = 2;
| Returns |
|---|
| Type | Description |
ByteString | The transactionId. |
hasMaxCommitDelay()
publicbooleanhasMaxCommitDelay()
Optional. The amount of latency this request is willing to incur in order to improve throughput. If this field is not set, Spanner assumes requests are relatively latency sensitive and automatically determines an appropriate delay time. You can specify a batching delay value between 0 and 500 ms.
.google.protobuf.Duration max_commit_delay = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
boolean | Whether the maxCommitDelay field is set. |
hasPrecommitToken()
publicbooleanhasPrecommitToken()
Optional. If the read-write transaction was executed on a multiplexed session, the precommit token with the highest sequence number received in this transaction attempt, should be included here. Failing to do so will result in a FailedPrecondition error. This feature is not yet supported and will result in an UNIMPLEMENTED error.
.google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
boolean | Whether the precommitToken field is set. |
hasRequestOptions()
publicbooleanhasRequestOptions()
Common options for this request.
.google.spanner.v1.RequestOptions request_options = 6;
| Returns |
|---|
| Type | Description |
boolean | Whether the requestOptions field is set. |
hasSingleUseTransaction()
publicbooleanhasSingleUseTransaction()
Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the CommitRequest is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it is possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead.
.google.spanner.v1.TransactionOptions single_use_transaction = 3;
| Returns |
|---|
| Type | Description |
boolean | Whether the singleUseTransaction field is set. |
hasTransactionId()
publicbooleanhasTransactionId()
Commit a previously-started transaction.
bytes transaction_id = 2;
| Returns |
|---|
| Type | Description |
boolean | Whether the transactionId field is set. |
hashCode()
| Returns |
|---|
| Type | Description |
int | |
OverridesinternalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
isInitialized()
publicfinalbooleanisInitialized()
newBuilderForType()
publicCommitRequest.BuildernewBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedCommitRequest.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
toBuilder()
publicCommitRequest.BuildertoBuilder()
writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)
