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 type google.spanner.v1.CommitRequest
See Also:

  • Field Details

    • SESSION_FIELD_NUMBER

      public static final int SESSION_FIELD_NUMBER
      See Also:

    • TRANSACTION_ID_FIELD_NUMBER

      public static final int TRANSACTION_ID_FIELD_NUMBER
      See Also:

    • SINGLE_USE_TRANSACTION_FIELD_NUMBER

      public static final int SINGLE_USE_TRANSACTION_FIELD_NUMBER
      See Also:

    • MUTATIONS_FIELD_NUMBER

      public static final int MUTATIONS_FIELD_NUMBER
      See Also:

    • RETURN_COMMIT_STATS_FIELD_NUMBER

      public static final int RETURN_COMMIT_STATS_FIELD_NUMBER
      See Also:

    • MAX_COMMIT_DELAY_FIELD_NUMBER

      public static final int MAX_COMMIT_DELAY_FIELD_NUMBER
      See Also:

    • REQUEST_OPTIONS_FIELD_NUMBER

      public static final int REQUEST_OPTIONS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.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 class com.google.protobuf.GeneratedMessageV3

    • getTransactionCase

      public CommitRequest.TransactionCase getTransactionCase()
      Specified by:
      getTransactionCase in interface CommitRequestOrBuilder

    • 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 interface CommitRequestOrBuilder
      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 interface CommitRequestOrBuilder
      Returns:
      The bytes for session.

    • hasTransactionId

      public boolean hasTransactionId()
       Commit a previously-started transaction.
      bytes transaction_id = 2;
      Specified by:
      hasTransactionId in interface CommitRequestOrBuilder
      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 interface CommitRequestOrBuilder
      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 interface CommitRequestOrBuilder
      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 interface CommitRequestOrBuilder
      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 interface CommitRequestOrBuilder

    • 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 interface CommitRequestOrBuilder

    • 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 interface CommitRequestOrBuilder

    • 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 interface CommitRequestOrBuilder

    • 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 interface CommitRequestOrBuilder

    • 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 interface CommitRequestOrBuilder

    • 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 interface CommitRequestOrBuilder
      Returns:
      The returnCommitStats.

    • hasMaxCommitDelay

      public boolean hasMaxCommitDelay()
       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];
      Specified by:
      hasMaxCommitDelay in interface CommitRequestOrBuilder
      Returns:
      Whether the maxCommitDelay field is set.

    • getMaxCommitDelay

      public com.google.protobuf.Duration getMaxCommitDelay()
       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];
      Specified by:
      getMaxCommitDelay in interface CommitRequestOrBuilder
      Returns:
      The maxCommitDelay.

    • getMaxCommitDelayOrBuilder

      public com.google.protobuf.DurationOrBuilder getMaxCommitDelayOrBuilder()
       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];
      Specified by:
      getMaxCommitDelayOrBuilder in interface CommitRequestOrBuilder

    • hasRequestOptions

      public boolean hasRequestOptions()
       Common options for this request.
      .google.spanner.v1.RequestOptions request_options = 6;
      Specified by:
      hasRequestOptions in interface CommitRequestOrBuilder
      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 interface CommitRequestOrBuilder
      Returns:
      The requestOptions.

    • getRequestOptionsOrBuilder

      public RequestOptionsOrBuilder getRequestOptionsOrBuilder()
       Common options for this request.
      .google.spanner.v1.RequestOptions request_options = 6;
      Specified by:
      getRequestOptionsOrBuilder in interface CommitRequestOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.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 interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.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 interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected CommitRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.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 interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public CommitRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder