Package com.google.spanner.executor.v1

Class SpannerAction

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.spanner.executor.v1.SpannerAction
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SpannerActionOrBuilder, Serializable
public final class SpannerAction extends com.google.protobuf.GeneratedMessageV3 implements SpannerActionOrBuilder
 SpannerAction defines a primitive action that can be performed against
 Spanner, such as begin or commit a transaction, or perform a read or
 mutation.
Protobuf type google.spanner.executor.v1.SpannerAction
See Also:

  • Field Details

    • DATABASE_PATH_FIELD_NUMBER

      public static final int DATABASE_PATH_FIELD_NUMBER
      See Also:

    • START_FIELD_NUMBER

      public static final int START_FIELD_NUMBER
      See Also:

    • FINISH_FIELD_NUMBER

      public static final int FINISH_FIELD_NUMBER
      See Also:

    • READ_FIELD_NUMBER

      public static final int READ_FIELD_NUMBER
      See Also:

    • QUERY_FIELD_NUMBER

      public static final int QUERY_FIELD_NUMBER
      See Also:

    • MUTATION_FIELD_NUMBER

      public static final int MUTATION_FIELD_NUMBER
      See Also:

    • DML_FIELD_NUMBER

      public static final int DML_FIELD_NUMBER
      See Also:

    • BATCH_DML_FIELD_NUMBER

      public static final int BATCH_DML_FIELD_NUMBER
      See Also:

    • WRITE_FIELD_NUMBER

      public static final int WRITE_FIELD_NUMBER
      See Also:

    • PARTITIONED_UPDATE_FIELD_NUMBER

      public static final int PARTITIONED_UPDATE_FIELD_NUMBER
      See Also:

    • ADMIN_FIELD_NUMBER

      public static final int ADMIN_FIELD_NUMBER
      See Also:

    • START_BATCH_TXN_FIELD_NUMBER

      public static final int START_BATCH_TXN_FIELD_NUMBER
      See Also:

    • CLOSE_BATCH_TXN_FIELD_NUMBER

      public static final int CLOSE_BATCH_TXN_FIELD_NUMBER
      See Also:

    • GENERATE_DB_PARTITIONS_READ_FIELD_NUMBER

      public static final int GENERATE_DB_PARTITIONS_READ_FIELD_NUMBER
      See Also:

    • GENERATE_DB_PARTITIONS_QUERY_FIELD_NUMBER

      public static final int GENERATE_DB_PARTITIONS_QUERY_FIELD_NUMBER
      See Also:

    • EXECUTE_PARTITION_FIELD_NUMBER

      public static final int EXECUTE_PARTITION_FIELD_NUMBER
      See Also:

    • EXECUTE_CHANGE_STREAM_QUERY_FIELD_NUMBER

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

    • getActionCase

      public SpannerAction.ActionCase getActionCase()
      Specified by:
      getActionCase in interface SpannerActionOrBuilder

    • getDatabasePath

      public String getDatabasePath()
       Database against which to perform action.
 In a context where a series of actions take place, an action may omit
 database path if it applies to the same database as the previous action.
      string database_path = 1;
      Specified by:
      getDatabasePath in interface SpannerActionOrBuilder
      Returns:
      The databasePath.

    • getDatabasePathBytes

      public com.google.protobuf.ByteString getDatabasePathBytes()
       Database against which to perform action.
 In a context where a series of actions take place, an action may omit
 database path if it applies to the same database as the previous action.
      string database_path = 1;
      Specified by:
      getDatabasePathBytes in interface SpannerActionOrBuilder
      Returns:
      The bytes for databasePath.

    • hasStart

      public boolean hasStart()
       Action to start a transaction.
      .google.spanner.executor.v1.StartTransactionAction start = 10;
      Specified by:
      hasStart in interface SpannerActionOrBuilder
      Returns:
      Whether the start field is set.

    • getStart

      public StartTransactionAction getStart()
       Action to start a transaction.
      .google.spanner.executor.v1.StartTransactionAction start = 10;
      Specified by:
      getStart in interface SpannerActionOrBuilder
      Returns:
      The start.

    • getStartOrBuilder

      public StartTransactionActionOrBuilder getStartOrBuilder()
       Action to start a transaction.
      .google.spanner.executor.v1.StartTransactionAction start = 10;
      Specified by:
      getStartOrBuilder in interface SpannerActionOrBuilder

    • hasFinish

      public boolean hasFinish()
       Action to finish a transaction.
      .google.spanner.executor.v1.FinishTransactionAction finish = 11;
      Specified by:
      hasFinish in interface SpannerActionOrBuilder
      Returns:
      Whether the finish field is set.

    • getFinish

      public FinishTransactionAction getFinish()
       Action to finish a transaction.
      .google.spanner.executor.v1.FinishTransactionAction finish = 11;
      Specified by:
      getFinish in interface SpannerActionOrBuilder
      Returns:
      The finish.

    • getFinishOrBuilder

      public FinishTransactionActionOrBuilder getFinishOrBuilder()
       Action to finish a transaction.
      .google.spanner.executor.v1.FinishTransactionAction finish = 11;
      Specified by:
      getFinishOrBuilder in interface SpannerActionOrBuilder

    • hasRead

      public boolean hasRead()
       Action to do a normal read.
      .google.spanner.executor.v1.ReadAction read = 20;
      Specified by:
      hasRead in interface SpannerActionOrBuilder
      Returns:
      Whether the read field is set.

    • getRead

      public ReadAction getRead()
       Action to do a normal read.
      .google.spanner.executor.v1.ReadAction read = 20;
      Specified by:
      getRead in interface SpannerActionOrBuilder
      Returns:
      The read.

    • getReadOrBuilder

      public ReadActionOrBuilder getReadOrBuilder()
       Action to do a normal read.
      .google.spanner.executor.v1.ReadAction read = 20;
      Specified by:
      getReadOrBuilder in interface SpannerActionOrBuilder

    • hasQuery

      public boolean hasQuery()
       Action to do a query.
      .google.spanner.executor.v1.QueryAction query = 21;
      Specified by:
      hasQuery in interface SpannerActionOrBuilder
      Returns:
      Whether the query field is set.

    • getQuery

      public QueryAction getQuery()
       Action to do a query.
      .google.spanner.executor.v1.QueryAction query = 21;
      Specified by:
      getQuery in interface SpannerActionOrBuilder
      Returns:
      The query.

    • getQueryOrBuilder

      public QueryActionOrBuilder getQueryOrBuilder()
       Action to do a query.
      .google.spanner.executor.v1.QueryAction query = 21;
      Specified by:
      getQueryOrBuilder in interface SpannerActionOrBuilder

    • hasMutation

      public boolean hasMutation()
       Action to buffer a mutation.
      .google.spanner.executor.v1.MutationAction mutation = 22;
      Specified by:
      hasMutation in interface SpannerActionOrBuilder
      Returns:
      Whether the mutation field is set.

    • getMutation

      public MutationAction getMutation()
       Action to buffer a mutation.
      .google.spanner.executor.v1.MutationAction mutation = 22;
      Specified by:
      getMutation in interface SpannerActionOrBuilder
      Returns:
      The mutation.

    • getMutationOrBuilder

      public MutationActionOrBuilder getMutationOrBuilder()
       Action to buffer a mutation.
      .google.spanner.executor.v1.MutationAction mutation = 22;
      Specified by:
      getMutationOrBuilder in interface SpannerActionOrBuilder

    • hasDml

      public boolean hasDml()
       Action to a DML.
      .google.spanner.executor.v1.DmlAction dml = 23;
      Specified by:
      hasDml in interface SpannerActionOrBuilder
      Returns:
      Whether the dml field is set.

    • getDml

      public DmlAction getDml()
       Action to a DML.
      .google.spanner.executor.v1.DmlAction dml = 23;
      Specified by:
      getDml in interface SpannerActionOrBuilder
      Returns:
      The dml.

    • getDmlOrBuilder

      public DmlActionOrBuilder getDmlOrBuilder()
       Action to a DML.
      .google.spanner.executor.v1.DmlAction dml = 23;
      Specified by:
      getDmlOrBuilder in interface SpannerActionOrBuilder

    • hasBatchDml

      public boolean hasBatchDml()
       Action to a batch DML.
      .google.spanner.executor.v1.BatchDmlAction batch_dml = 24;
      Specified by:
      hasBatchDml in interface SpannerActionOrBuilder
      Returns:
      Whether the batchDml field is set.

    • getBatchDml

      public BatchDmlAction getBatchDml()
       Action to a batch DML.
      .google.spanner.executor.v1.BatchDmlAction batch_dml = 24;
      Specified by:
      getBatchDml in interface SpannerActionOrBuilder
      Returns:
      The batchDml.

    • getBatchDmlOrBuilder

      public BatchDmlActionOrBuilder getBatchDmlOrBuilder()
       Action to a batch DML.
      .google.spanner.executor.v1.BatchDmlAction batch_dml = 24;
      Specified by:
      getBatchDmlOrBuilder in interface SpannerActionOrBuilder

    • hasWrite

      public boolean hasWrite()
       Action to write a mutation.
      .google.spanner.executor.v1.WriteMutationsAction write = 25;
      Specified by:
      hasWrite in interface SpannerActionOrBuilder
      Returns:
      Whether the write field is set.

    • getWrite

      public WriteMutationsAction getWrite()
       Action to write a mutation.
      .google.spanner.executor.v1.WriteMutationsAction write = 25;
      Specified by:
      getWrite in interface SpannerActionOrBuilder
      Returns:
      The write.

    • getWriteOrBuilder

      public WriteMutationsActionOrBuilder getWriteOrBuilder()
       Action to write a mutation.
      .google.spanner.executor.v1.WriteMutationsAction write = 25;
      Specified by:
      getWriteOrBuilder in interface SpannerActionOrBuilder

    • hasPartitionedUpdate

      public boolean hasPartitionedUpdate()
       Action to a partitioned update.
      .google.spanner.executor.v1.PartitionedUpdateAction partitioned_update = 27;
      Specified by:
      hasPartitionedUpdate in interface SpannerActionOrBuilder
      Returns:
      Whether the partitionedUpdate field is set.

    • getPartitionedUpdate

      public PartitionedUpdateAction getPartitionedUpdate()
       Action to a partitioned update.
      .google.spanner.executor.v1.PartitionedUpdateAction partitioned_update = 27;
      Specified by:
      getPartitionedUpdate in interface SpannerActionOrBuilder
      Returns:
      The partitionedUpdate.

    • getPartitionedUpdateOrBuilder

      public PartitionedUpdateActionOrBuilder getPartitionedUpdateOrBuilder()
       Action to a partitioned update.
      .google.spanner.executor.v1.PartitionedUpdateAction partitioned_update = 27;
      Specified by:
      getPartitionedUpdateOrBuilder in interface SpannerActionOrBuilder

    • hasAdmin

      public boolean hasAdmin()
       Action that contains any administrative operation, like database,
 instance manipulation.
      .google.spanner.executor.v1.AdminAction admin = 30;
      Specified by:
      hasAdmin in interface SpannerActionOrBuilder
      Returns:
      Whether the admin field is set.

    • getAdmin

      public AdminAction getAdmin()
       Action that contains any administrative operation, like database,
 instance manipulation.
      .google.spanner.executor.v1.AdminAction admin = 30;
      Specified by:
      getAdmin in interface SpannerActionOrBuilder
      Returns:
      The admin.

    • getAdminOrBuilder

      public AdminActionOrBuilder getAdminOrBuilder()
       Action that contains any administrative operation, like database,
 instance manipulation.
      .google.spanner.executor.v1.AdminAction admin = 30;
      Specified by:
      getAdminOrBuilder in interface SpannerActionOrBuilder

    • hasStartBatchTxn

      public boolean hasStartBatchTxn()
       Action to start a batch transaction.
      .google.spanner.executor.v1.StartBatchTransactionAction start_batch_txn = 40;
      Specified by:
      hasStartBatchTxn in interface SpannerActionOrBuilder
      Returns:
      Whether the startBatchTxn field is set.

    • getStartBatchTxn

      public StartBatchTransactionAction getStartBatchTxn()
       Action to start a batch transaction.
      .google.spanner.executor.v1.StartBatchTransactionAction start_batch_txn = 40;
      Specified by:
      getStartBatchTxn in interface SpannerActionOrBuilder
      Returns:
      The startBatchTxn.

    • getStartBatchTxnOrBuilder

      public StartBatchTransactionActionOrBuilder getStartBatchTxnOrBuilder()
       Action to start a batch transaction.
      .google.spanner.executor.v1.StartBatchTransactionAction start_batch_txn = 40;
      Specified by:
      getStartBatchTxnOrBuilder in interface SpannerActionOrBuilder

    • hasCloseBatchTxn

      public boolean hasCloseBatchTxn()
       Action to close a batch transaction.
      .google.spanner.executor.v1.CloseBatchTransactionAction close_batch_txn = 41;
      Specified by:
      hasCloseBatchTxn in interface SpannerActionOrBuilder
      Returns:
      Whether the closeBatchTxn field is set.

    • getCloseBatchTxn

      public CloseBatchTransactionAction getCloseBatchTxn()
       Action to close a batch transaction.
      .google.spanner.executor.v1.CloseBatchTransactionAction close_batch_txn = 41;
      Specified by:
      getCloseBatchTxn in interface SpannerActionOrBuilder
      Returns:
      The closeBatchTxn.

    • getCloseBatchTxnOrBuilder

      public CloseBatchTransactionActionOrBuilder getCloseBatchTxnOrBuilder()
       Action to close a batch transaction.
      .google.spanner.executor.v1.CloseBatchTransactionAction close_batch_txn = 41;
      Specified by:
      getCloseBatchTxnOrBuilder in interface SpannerActionOrBuilder

    • hasGenerateDbPartitionsRead

      public boolean hasGenerateDbPartitionsRead()
       Action to generate database partitions for batch read.
      .google.spanner.executor.v1.GenerateDbPartitionsForReadAction generate_db_partitions_read = 42;
      Specified by:
      hasGenerateDbPartitionsRead in interface SpannerActionOrBuilder
      Returns:
      Whether the generateDbPartitionsRead field is set.

    • getGenerateDbPartitionsRead

      public GenerateDbPartitionsForReadAction getGenerateDbPartitionsRead()
       Action to generate database partitions for batch read.
      .google.spanner.executor.v1.GenerateDbPartitionsForReadAction generate_db_partitions_read = 42;
      Specified by:
      getGenerateDbPartitionsRead in interface SpannerActionOrBuilder
      Returns:
      The generateDbPartitionsRead.

    • getGenerateDbPartitionsReadOrBuilder

      public GenerateDbPartitionsForReadActionOrBuilder getGenerateDbPartitionsReadOrBuilder()
       Action to generate database partitions for batch read.
      .google.spanner.executor.v1.GenerateDbPartitionsForReadAction generate_db_partitions_read = 42;
      Specified by:
      getGenerateDbPartitionsReadOrBuilder in interface SpannerActionOrBuilder

    • hasGenerateDbPartitionsQuery

      public boolean hasGenerateDbPartitionsQuery()
       Action to generate database partitions for batch query.
      .google.spanner.executor.v1.GenerateDbPartitionsForQueryAction generate_db_partitions_query = 43;
      Specified by:
      hasGenerateDbPartitionsQuery in interface SpannerActionOrBuilder
      Returns:
      Whether the generateDbPartitionsQuery field is set.

    • getGenerateDbPartitionsQuery

      public GenerateDbPartitionsForQueryAction getGenerateDbPartitionsQuery()
       Action to generate database partitions for batch query.
      .google.spanner.executor.v1.GenerateDbPartitionsForQueryAction generate_db_partitions_query = 43;
      Specified by:
      getGenerateDbPartitionsQuery in interface SpannerActionOrBuilder
      Returns:
      The generateDbPartitionsQuery.

    • getGenerateDbPartitionsQueryOrBuilder

      public GenerateDbPartitionsForQueryActionOrBuilder getGenerateDbPartitionsQueryOrBuilder()
       Action to generate database partitions for batch query.
      .google.spanner.executor.v1.GenerateDbPartitionsForQueryAction generate_db_partitions_query = 43;
      Specified by:
      getGenerateDbPartitionsQueryOrBuilder in interface SpannerActionOrBuilder

    • hasExecutePartition

      public boolean hasExecutePartition()
       Action to execute batch actions on generated partitions.
      .google.spanner.executor.v1.ExecutePartitionAction execute_partition = 44;
      Specified by:
      hasExecutePartition in interface SpannerActionOrBuilder
      Returns:
      Whether the executePartition field is set.

    • getExecutePartition

      public ExecutePartitionAction getExecutePartition()
       Action to execute batch actions on generated partitions.
      .google.spanner.executor.v1.ExecutePartitionAction execute_partition = 44;
      Specified by:
      getExecutePartition in interface SpannerActionOrBuilder
      Returns:
      The executePartition.

    • getExecutePartitionOrBuilder

      public ExecutePartitionActionOrBuilder getExecutePartitionOrBuilder()
       Action to execute batch actions on generated partitions.
      .google.spanner.executor.v1.ExecutePartitionAction execute_partition = 44;
      Specified by:
      getExecutePartitionOrBuilder in interface SpannerActionOrBuilder

    • hasExecuteChangeStreamQuery

      public boolean hasExecuteChangeStreamQuery()
       Action to execute change stream query.
      .google.spanner.executor.v1.ExecuteChangeStreamQuery execute_change_stream_query = 50;
      Specified by:
      hasExecuteChangeStreamQuery in interface SpannerActionOrBuilder
      Returns:
      Whether the executeChangeStreamQuery field is set.

    • getExecuteChangeStreamQuery

      public ExecuteChangeStreamQuery getExecuteChangeStreamQuery()
       Action to execute change stream query.
      .google.spanner.executor.v1.ExecuteChangeStreamQuery execute_change_stream_query = 50;
      Specified by:
      getExecuteChangeStreamQuery in interface SpannerActionOrBuilder
      Returns:
      The executeChangeStreamQuery.

    • getExecuteChangeStreamQueryOrBuilder

      public ExecuteChangeStreamQueryOrBuilder getExecuteChangeStreamQueryOrBuilder()
       Action to execute change stream query.
      .google.spanner.executor.v1.ExecuteChangeStreamQuery execute_change_stream_query = 50;
      Specified by:
      getExecuteChangeStreamQueryOrBuilder in interface SpannerActionOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static SpannerAction.Builder newBuilder()

    • newBuilder

      public static SpannerAction.Builder newBuilder(SpannerAction prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static SpannerAction getDefaultInstance()

    • parser

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

    • getParserForType

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