Package com.google.spanner.v1

Class BatchWriteRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.spanner.v1.BatchWriteRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, BatchWriteRequestOrBuilder, Serializable
public final class BatchWriteRequest extends com.google.protobuf.GeneratedMessageV3 implements BatchWriteRequestOrBuilder
 The request for [BatchWrite][google.spanner.v1.Spanner.BatchWrite].
Protobuf type google.spanner.v1.BatchWriteRequest
See Also:

  • Field Details

    • SESSION_FIELD_NUMBER

      public static final int SESSION_FIELD_NUMBER
      See Also:

    • REQUEST_OPTIONS_FIELD_NUMBER

      public static final int REQUEST_OPTIONS_FIELD_NUMBER
      See Also:

    • MUTATION_GROUPS_FIELD_NUMBER

      public static final int MUTATION_GROUPS_FIELD_NUMBER
      See Also:

    • EXCLUDE_TXN_FROM_CHANGE_STREAMS_FIELD_NUMBER

      public static final int EXCLUDE_TXN_FROM_CHANGE_STREAMS_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

    • 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) = { ... }
      Specified by:
      getSession in interface BatchWriteRequestOrBuilder
      Returns:
      The session.

    • getSessionBytes

      public com.google.protobuf.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) = { ... }
      Specified by:
      getSessionBytes in interface BatchWriteRequestOrBuilder
      Returns:
      The bytes for session.

    • hasRequestOptions

      public boolean hasRequestOptions()
       Common options for this request.
      .google.spanner.v1.RequestOptions request_options = 3;
      Specified by:
      hasRequestOptions in interface BatchWriteRequestOrBuilder
      Returns:
      Whether the requestOptions field is set.

    • getRequestOptions

      public RequestOptions getRequestOptions()
       Common options for this request.
      .google.spanner.v1.RequestOptions request_options = 3;
      Specified by:
      getRequestOptions in interface BatchWriteRequestOrBuilder
      Returns:
      The requestOptions.

    • getRequestOptionsOrBuilder

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

    • 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];
      Specified by:
      getMutationGroupsList in interface BatchWriteRequestOrBuilder

    • 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];
      Specified by:
      getMutationGroupsOrBuilderList in interface BatchWriteRequestOrBuilder

    • 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];
      Specified by:
      getMutationGroupsCount in interface BatchWriteRequestOrBuilder

    • getMutationGroups

      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];
      Specified by:
      getMutationGroups in interface BatchWriteRequestOrBuilder

    • getMutationGroupsOrBuilder

      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];
      Specified by:
      getMutationGroupsOrBuilder in interface BatchWriteRequestOrBuilder

    • 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];
      Specified by:
      getExcludeTxnFromChangeStreams in interface BatchWriteRequestOrBuilder
      Returns:
      The excludeTxnFromChangeStreams.

    • 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 BatchWriteRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BatchWriteRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BatchWriteRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BatchWriteRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BatchWriteRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BatchWriteRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BatchWriteRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BatchWriteRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static BatchWriteRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static BatchWriteRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BatchWriteRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BatchWriteRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public BatchWriteRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static BatchWriteRequest.Builder newBuilder()

    • newBuilder

      public static BatchWriteRequest.Builder newBuilder(BatchWriteRequest prototype)

    • toBuilder

      public BatchWriteRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected BatchWriteRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static BatchWriteRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<BatchWriteRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<BatchWriteRequest> 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 BatchWriteRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder