Package com.google.spanner.v1
Class CommitRequest
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.spanner.v1.CommitRequest
-
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,CommitRequestOrBuilder
,Serializable
public final class CommitRequest extends com.google.protobuf.GeneratedMessageV3 implements CommitRequestOrBuilder
The request for [Commit][google.spanner.v1.Spanner.Commit].
Protobuf typegoogle.spanner.v1.CommitRequest
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CommitRequest.Builder
The request for [Commit][google.spanner.v1.Spanner.Commit].static class
CommitRequest.TransactionCase
-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static int
MUTATIONS_FIELD_NUMBER
static int
REQUEST_OPTIONS_FIELD_NUMBER
static int
RETURN_COMMIT_STATS_FIELD_NUMBER
static int
SESSION_FIELD_NUMBER
static int
SINGLE_USE_TRANSACTION_FIELD_NUMBER
static int
TRANSACTION_ID_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
static CommitRequest
getDefaultInstance()
CommitRequest
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
Mutation
getMutations(int index)
The mutations to be executed when this transaction commits.int
getMutationsCount()
The mutations to be executed when this transaction commits.List<Mutation>
getMutationsList()
The mutations to be executed when this transaction commits.MutationOrBuilder
getMutationsOrBuilder(int index)
The mutations to be executed when this transaction commits.List<? extends MutationOrBuilder>
getMutationsOrBuilderList()
The mutations to be executed when this transaction commits.com.google.protobuf.Parser<CommitRequest>
getParserForType()
RequestOptions
getRequestOptions()
Common options for this request.RequestOptionsOrBuilder
getRequestOptionsOrBuilder()
Common options for this request.boolean
getReturnCommitStats()
If `true`, then statistics related to the transaction will be included in the [CommitResponse][google.spanner.v1.CommitResponse.commit_stats].int
getSerializedSize()
String
getSession()
Required.com.google.protobuf.ByteString
getSessionBytes()
Required.TransactionOptions
getSingleUseTransaction()
Execute mutations in a temporary transaction.TransactionOptionsOrBuilder
getSingleUseTransactionOrBuilder()
Execute mutations in a temporary transaction.CommitRequest.TransactionCase
getTransactionCase()
com.google.protobuf.ByteString
getTransactionId()
Commit a previously-started transaction.int
hashCode()
boolean
hasRequestOptions()
Common options for this request.boolean
hasSingleUseTransaction()
Execute mutations in a temporary transaction.boolean
hasTransactionId()
Commit a previously-started transaction.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static CommitRequest.Builder
newBuilder()
static CommitRequest.Builder
newBuilder(CommitRequest prototype)
CommitRequest.Builder
newBuilderForType()
protected CommitRequest.Builder
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static CommitRequest
parseDelimitedFrom(InputStream input)
static CommitRequest
parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CommitRequest
parseFrom(byte[] data)
static CommitRequest
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CommitRequest
parseFrom(com.google.protobuf.ByteString data)
static CommitRequest
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CommitRequest
parseFrom(com.google.protobuf.CodedInputStream input)
static CommitRequest
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CommitRequest
parseFrom(InputStream input)
static CommitRequest
parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CommitRequest
parseFrom(ByteBuffer data)
static CommitRequest
parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<CommitRequest>
parser()
CommitRequest.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)
-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
SESSION_FIELD_NUMBER
public static final int SESSION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TRANSACTION_ID_FIELD_NUMBER
public static final int TRANSACTION_ID_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SINGLE_USE_TRANSACTION_FIELD_NUMBER
public static final int SINGLE_USE_TRANSACTION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
MUTATIONS_FIELD_NUMBER
public static final int MUTATIONS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
RETURN_COMMIT_STATS_FIELD_NUMBER
public static final int RETURN_COMMIT_STATS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
REQUEST_OPTIONS_FIELD_NUMBER
public static final int REQUEST_OPTIONS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3
-
getTransactionCase
public CommitRequest.TransactionCase getTransactionCase()
- Specified by:
getTransactionCase
in interfaceCommitRequestOrBuilder
-
getSession
public String getSession()
Required. The session in which the transaction to be committed is running.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
- Specified by:
getSession
in interfaceCommitRequestOrBuilder
- Returns:
- The session.
-
getSessionBytes
public com.google.protobuf.ByteString getSessionBytes()
Required. The session in which the transaction to be committed is running.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
- Specified by:
getSessionBytes
in interfaceCommitRequestOrBuilder
- Returns:
- The bytes for session.
-
hasTransactionId
public boolean hasTransactionId()
Commit a previously-started transaction.
bytes transaction_id = 2;
- Specified by:
hasTransactionId
in interfaceCommitRequestOrBuilder
- Returns:
- Whether the transactionId field is set.
-
getTransactionId
public com.google.protobuf.ByteString getTransactionId()
Commit a previously-started transaction.
bytes transaction_id = 2;
- Specified by:
getTransactionId
in interfaceCommitRequestOrBuilder
- Returns:
- The transactionId.
-
hasSingleUseTransaction
public boolean hasSingleUseTransaction()
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][google.spanner.v1.Spanner.BeginTransaction] and [Commit][google.spanner.v1.Spanner.Commit] instead.
.google.spanner.v1.TransactionOptions single_use_transaction = 3;
- Specified by:
hasSingleUseTransaction
in interfaceCommitRequestOrBuilder
- Returns:
- Whether the singleUseTransaction field is set.
-
getSingleUseTransaction
public TransactionOptions getSingleUseTransaction()
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][google.spanner.v1.Spanner.BeginTransaction] and [Commit][google.spanner.v1.Spanner.Commit] instead.
.google.spanner.v1.TransactionOptions single_use_transaction = 3;
- Specified by:
getSingleUseTransaction
in interfaceCommitRequestOrBuilder
- Returns:
- The singleUseTransaction.
-
getSingleUseTransactionOrBuilder
public TransactionOptionsOrBuilder getSingleUseTransactionOrBuilder()
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][google.spanner.v1.Spanner.BeginTransaction] and [Commit][google.spanner.v1.Spanner.Commit] instead.
.google.spanner.v1.TransactionOptions single_use_transaction = 3;
- Specified by:
getSingleUseTransactionOrBuilder
in interfaceCommitRequestOrBuilder
-
getMutationsList
public List<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;
- Specified by:
getMutationsList
in interfaceCommitRequestOrBuilder
-
getMutationsOrBuilderList
public List<? extends MutationOrBuilder> 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;
- Specified by:
getMutationsOrBuilderList
in interfaceCommitRequestOrBuilder
-
getMutationsCount
public int getMutationsCount()
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;
- Specified by:
getMutationsCount
in interfaceCommitRequestOrBuilder
-
getMutations
public Mutation getMutations(int index)
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;
- Specified by:
getMutations
in interfaceCommitRequestOrBuilder
-
getMutationsOrBuilder
public MutationOrBuilder getMutationsOrBuilder(int index)
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;
- Specified by:
getMutationsOrBuilder
in interfaceCommitRequestOrBuilder
-
getReturnCommitStats
public boolean getReturnCommitStats()
If `true`, then statistics related to the transaction will be included in the [CommitResponse][google.spanner.v1.CommitResponse.commit_stats]. Default value is `false`.
bool return_commit_stats = 5;
- Specified by:
getReturnCommitStats
in interfaceCommitRequestOrBuilder
- Returns:
- The returnCommitStats.
-
hasRequestOptions
public boolean hasRequestOptions()
Common options for this request.
.google.spanner.v1.RequestOptions request_options = 6;
- Specified by:
hasRequestOptions
in interfaceCommitRequestOrBuilder
- Returns:
- Whether the requestOptions field is set.
-
getRequestOptions
public RequestOptions getRequestOptions()
Common options for this request.
.google.spanner.v1.RequestOptions request_options = 6;
- Specified by:
getRequestOptions
in interfaceCommitRequestOrBuilder
- Returns:
- The requestOptions.
-
getRequestOptionsOrBuilder
public RequestOptionsOrBuilder getRequestOptionsOrBuilder()
Common options for this request.
.google.spanner.v1.RequestOptions request_options = 6;
- Specified by:
getRequestOptionsOrBuilder
in interfaceCommitRequestOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static CommitRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CommitRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CommitRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CommitRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CommitRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CommitRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CommitRequest parseFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static CommitRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static CommitRequest parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static CommitRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static CommitRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static CommitRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public CommitRequest.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static CommitRequest.Builder newBuilder()
-
newBuilder
public static CommitRequest.Builder newBuilder(CommitRequest prototype)
-
toBuilder
public CommitRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected CommitRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static CommitRequest getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<CommitRequest> parser()
-
getParserForType
public com.google.protobuf.Parser<CommitRequest> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public CommitRequest getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-