Class SpannerAction (6.58.0)

public final class SpannerAction extends 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

Static Fields

ADMIN_FIELD_NUMBER

public static final int ADMIN_FIELD_NUMBER
Field Value
TypeDescription
int

BATCH_DML_FIELD_NUMBER

public static final int BATCH_DML_FIELD_NUMBER
Field Value
TypeDescription
int

CLOSE_BATCH_TXN_FIELD_NUMBER

public static final int CLOSE_BATCH_TXN_FIELD_NUMBER
Field Value
TypeDescription
int

DATABASE_PATH_FIELD_NUMBER

public static final int DATABASE_PATH_FIELD_NUMBER
Field Value
TypeDescription
int

DML_FIELD_NUMBER

public static final int DML_FIELD_NUMBER
Field Value
TypeDescription
int

EXECUTE_CHANGE_STREAM_QUERY_FIELD_NUMBER

public static final int EXECUTE_CHANGE_STREAM_QUERY_FIELD_NUMBER
Field Value
TypeDescription
int

EXECUTE_PARTITION_FIELD_NUMBER

public static final int EXECUTE_PARTITION_FIELD_NUMBER
Field Value
TypeDescription
int

FINISH_FIELD_NUMBER

public static final int FINISH_FIELD_NUMBER
Field Value
TypeDescription
int

GENERATE_DB_PARTITIONS_QUERY_FIELD_NUMBER

public static final int GENERATE_DB_PARTITIONS_QUERY_FIELD_NUMBER
Field Value
TypeDescription
int

GENERATE_DB_PARTITIONS_READ_FIELD_NUMBER

public static final int GENERATE_DB_PARTITIONS_READ_FIELD_NUMBER
Field Value
TypeDescription
int

MUTATION_FIELD_NUMBER

public static final int MUTATION_FIELD_NUMBER
Field Value
TypeDescription
int

PARTITIONED_UPDATE_FIELD_NUMBER

public static final int PARTITIONED_UPDATE_FIELD_NUMBER
Field Value
TypeDescription
int

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER
Field Value
TypeDescription
int

READ_FIELD_NUMBER

public static final int READ_FIELD_NUMBER
Field Value
TypeDescription
int

START_BATCH_TXN_FIELD_NUMBER

public static final int START_BATCH_TXN_FIELD_NUMBER
Field Value
TypeDescription
int

START_FIELD_NUMBER

public static final int START_FIELD_NUMBER
Field Value
TypeDescription
int

WRITE_FIELD_NUMBER

public static final int WRITE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SpannerAction getDefaultInstance()
Returns
TypeDescription
SpannerAction

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SpannerAction.Builder newBuilder()
Returns
TypeDescription
SpannerAction.Builder

newBuilder(SpannerAction prototype)

public static SpannerAction.Builder newBuilder(SpannerAction prototype)
Parameter
NameDescription
prototypeSpannerAction
Returns
TypeDescription
SpannerAction.Builder

parseDelimitedFrom(InputStream input)

public static SpannerAction parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SpannerAction
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SpannerAction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SpannerAction
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SpannerAction parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SpannerAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SpannerAction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SpannerAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SpannerAction parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SpannerAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SpannerAction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SpannerAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SpannerAction parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SpannerAction
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SpannerAction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SpannerAction
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SpannerAction parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SpannerAction
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SpannerAction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SpannerAction
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SpannerAction parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SpannerAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SpannerAction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SpannerAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SpannerAction> parser()
Returns
TypeDescription
Parser<SpannerAction>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getActionCase()

public SpannerAction.ActionCase getActionCase()
Returns
TypeDescription
SpannerAction.ActionCase

getAdmin()

public AdminAction getAdmin()

Action that contains any administrative operation, like database, instance manipulation.

.google.spanner.executor.v1.AdminAction admin = 30;

Returns
TypeDescription
AdminAction

The admin.

getAdminOrBuilder()

public AdminActionOrBuilder getAdminOrBuilder()

Action that contains any administrative operation, like database, instance manipulation.

.google.spanner.executor.v1.AdminAction admin = 30;

Returns
TypeDescription
AdminActionOrBuilder

getBatchDml()

public BatchDmlAction getBatchDml()

Action to a batch DML.

.google.spanner.executor.v1.BatchDmlAction batch_dml = 24;

Returns
TypeDescription
BatchDmlAction

The batchDml.

getBatchDmlOrBuilder()

public BatchDmlActionOrBuilder getBatchDmlOrBuilder()

Action to a batch DML.

.google.spanner.executor.v1.BatchDmlAction batch_dml = 24;

Returns
TypeDescription
BatchDmlActionOrBuilder

getCloseBatchTxn()

public CloseBatchTransactionAction getCloseBatchTxn()

Action to close a batch transaction.

.google.spanner.executor.v1.CloseBatchTransactionAction close_batch_txn = 41;

Returns
TypeDescription
CloseBatchTransactionAction

The closeBatchTxn.

getCloseBatchTxnOrBuilder()

public CloseBatchTransactionActionOrBuilder getCloseBatchTxnOrBuilder()

Action to close a batch transaction.

.google.spanner.executor.v1.CloseBatchTransactionAction close_batch_txn = 41;

Returns
TypeDescription
CloseBatchTransactionActionOrBuilder

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;

Returns
TypeDescription
String

The databasePath.

getDatabasePathBytes()

public 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;

Returns
TypeDescription
ByteString

The bytes for databasePath.

getDefaultInstanceForType()

public SpannerAction getDefaultInstanceForType()
Returns
TypeDescription
SpannerAction

getDml()

public DmlAction getDml()

Action to a DML.

.google.spanner.executor.v1.DmlAction dml = 23;

Returns
TypeDescription
DmlAction

The dml.

getDmlOrBuilder()

public DmlActionOrBuilder getDmlOrBuilder()

Action to a DML.

.google.spanner.executor.v1.DmlAction dml = 23;

Returns
TypeDescription
DmlActionOrBuilder

getExecuteChangeStreamQuery()

public ExecuteChangeStreamQuery getExecuteChangeStreamQuery()

Action to execute change stream query.

.google.spanner.executor.v1.ExecuteChangeStreamQuery execute_change_stream_query = 50;

Returns
TypeDescription
ExecuteChangeStreamQuery

The executeChangeStreamQuery.

getExecuteChangeStreamQueryOrBuilder()

public ExecuteChangeStreamQueryOrBuilder getExecuteChangeStreamQueryOrBuilder()

Action to execute change stream query.

.google.spanner.executor.v1.ExecuteChangeStreamQuery execute_change_stream_query = 50;

Returns
TypeDescription
ExecuteChangeStreamQueryOrBuilder

getExecutePartition()

public ExecutePartitionAction getExecutePartition()

Action to execute batch actions on generated partitions.

.google.spanner.executor.v1.ExecutePartitionAction execute_partition = 44;

Returns
TypeDescription
ExecutePartitionAction

The executePartition.

getExecutePartitionOrBuilder()

public ExecutePartitionActionOrBuilder getExecutePartitionOrBuilder()

Action to execute batch actions on generated partitions.

.google.spanner.executor.v1.ExecutePartitionAction execute_partition = 44;

Returns
TypeDescription
ExecutePartitionActionOrBuilder

getFinish()

public FinishTransactionAction getFinish()

Action to finish a transaction.

.google.spanner.executor.v1.FinishTransactionAction finish = 11;

Returns
TypeDescription
FinishTransactionAction

The finish.

getFinishOrBuilder()

public FinishTransactionActionOrBuilder getFinishOrBuilder()

Action to finish a transaction.

.google.spanner.executor.v1.FinishTransactionAction finish = 11;

Returns
TypeDescription
FinishTransactionActionOrBuilder

getGenerateDbPartitionsQuery()

public GenerateDbPartitionsForQueryAction getGenerateDbPartitionsQuery()

Action to generate database partitions for batch query.

.google.spanner.executor.v1.GenerateDbPartitionsForQueryAction generate_db_partitions_query = 43;

Returns
TypeDescription
GenerateDbPartitionsForQueryAction

The generateDbPartitionsQuery.

getGenerateDbPartitionsQueryOrBuilder()

public GenerateDbPartitionsForQueryActionOrBuilder getGenerateDbPartitionsQueryOrBuilder()

Action to generate database partitions for batch query.

.google.spanner.executor.v1.GenerateDbPartitionsForQueryAction generate_db_partitions_query = 43;

Returns
TypeDescription
GenerateDbPartitionsForQueryActionOrBuilder

getGenerateDbPartitionsRead()

public GenerateDbPartitionsForReadAction getGenerateDbPartitionsRead()

Action to generate database partitions for batch read.

.google.spanner.executor.v1.GenerateDbPartitionsForReadAction generate_db_partitions_read = 42;

Returns
TypeDescription
GenerateDbPartitionsForReadAction

The generateDbPartitionsRead.

getGenerateDbPartitionsReadOrBuilder()

public GenerateDbPartitionsForReadActionOrBuilder getGenerateDbPartitionsReadOrBuilder()

Action to generate database partitions for batch read.

.google.spanner.executor.v1.GenerateDbPartitionsForReadAction generate_db_partitions_read = 42;

Returns
TypeDescription
GenerateDbPartitionsForReadActionOrBuilder

getMutation()

public MutationAction getMutation()

Action to buffer a mutation.

.google.spanner.executor.v1.MutationAction mutation = 22;

Returns
TypeDescription
MutationAction

The mutation.

getMutationOrBuilder()

public MutationActionOrBuilder getMutationOrBuilder()

Action to buffer a mutation.

.google.spanner.executor.v1.MutationAction mutation = 22;

Returns
TypeDescription
MutationActionOrBuilder

getParserForType()

public Parser<SpannerAction> getParserForType()
Returns
TypeDescription
Parser<SpannerAction>
Overrides

getPartitionedUpdate()

public PartitionedUpdateAction getPartitionedUpdate()

Action to a partitioned update.

.google.spanner.executor.v1.PartitionedUpdateAction partitioned_update = 27;

Returns
TypeDescription
PartitionedUpdateAction

The partitionedUpdate.

getPartitionedUpdateOrBuilder()

public PartitionedUpdateActionOrBuilder getPartitionedUpdateOrBuilder()

Action to a partitioned update.

.google.spanner.executor.v1.PartitionedUpdateAction partitioned_update = 27;

Returns
TypeDescription
PartitionedUpdateActionOrBuilder

getQuery()

public QueryAction getQuery()

Action to do a query.

.google.spanner.executor.v1.QueryAction query = 21;

Returns
TypeDescription
QueryAction

The query.

getQueryOrBuilder()

public QueryActionOrBuilder getQueryOrBuilder()

Action to do a query.

.google.spanner.executor.v1.QueryAction query = 21;

Returns
TypeDescription
QueryActionOrBuilder

getRead()

public ReadAction getRead()

Action to do a normal read.

.google.spanner.executor.v1.ReadAction read = 20;

Returns
TypeDescription
ReadAction

The read.

getReadOrBuilder()

public ReadActionOrBuilder getReadOrBuilder()

Action to do a normal read.

.google.spanner.executor.v1.ReadAction read = 20;

Returns
TypeDescription
ReadActionOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStart()

public StartTransactionAction getStart()

Action to start a transaction.

.google.spanner.executor.v1.StartTransactionAction start = 10;

Returns
TypeDescription
StartTransactionAction

The start.

getStartBatchTxn()

public StartBatchTransactionAction getStartBatchTxn()

Action to start a batch transaction.

.google.spanner.executor.v1.StartBatchTransactionAction start_batch_txn = 40;

Returns
TypeDescription
StartBatchTransactionAction

The startBatchTxn.

getStartBatchTxnOrBuilder()

public StartBatchTransactionActionOrBuilder getStartBatchTxnOrBuilder()

Action to start a batch transaction.

.google.spanner.executor.v1.StartBatchTransactionAction start_batch_txn = 40;

Returns
TypeDescription
StartBatchTransactionActionOrBuilder

getStartOrBuilder()

public StartTransactionActionOrBuilder getStartOrBuilder()

Action to start a transaction.

.google.spanner.executor.v1.StartTransactionAction start = 10;

Returns
TypeDescription
StartTransactionActionOrBuilder

getWrite()

public WriteMutationsAction getWrite()

Action to write a mutation.

.google.spanner.executor.v1.WriteMutationsAction write = 25;

Returns
TypeDescription
WriteMutationsAction

The write.

getWriteOrBuilder()

public WriteMutationsActionOrBuilder getWriteOrBuilder()

Action to write a mutation.

.google.spanner.executor.v1.WriteMutationsAction write = 25;

Returns
TypeDescription
WriteMutationsActionOrBuilder

hasAdmin()

public boolean hasAdmin()

Action that contains any administrative operation, like database, instance manipulation.

.google.spanner.executor.v1.AdminAction admin = 30;

Returns
TypeDescription
boolean

Whether the admin field is set.

hasBatchDml()

public boolean hasBatchDml()

Action to a batch DML.

.google.spanner.executor.v1.BatchDmlAction batch_dml = 24;

Returns
TypeDescription
boolean

Whether the batchDml field is set.

hasCloseBatchTxn()

public boolean hasCloseBatchTxn()

Action to close a batch transaction.

.google.spanner.executor.v1.CloseBatchTransactionAction close_batch_txn = 41;

Returns
TypeDescription
boolean

Whether the closeBatchTxn field is set.

hasDml()

public boolean hasDml()

Action to a DML.

.google.spanner.executor.v1.DmlAction dml = 23;

Returns
TypeDescription
boolean

Whether the dml field is set.

hasExecuteChangeStreamQuery()

public boolean hasExecuteChangeStreamQuery()

Action to execute change stream query.

.google.spanner.executor.v1.ExecuteChangeStreamQuery execute_change_stream_query = 50;

Returns
TypeDescription
boolean

Whether the executeChangeStreamQuery field is set.

hasExecutePartition()

public boolean hasExecutePartition()

Action to execute batch actions on generated partitions.

.google.spanner.executor.v1.ExecutePartitionAction execute_partition = 44;

Returns
TypeDescription
boolean

Whether the executePartition field is set.

hasFinish()

public boolean hasFinish()

Action to finish a transaction.

.google.spanner.executor.v1.FinishTransactionAction finish = 11;

Returns
TypeDescription
boolean

Whether the finish field is set.

hasGenerateDbPartitionsQuery()

public boolean hasGenerateDbPartitionsQuery()

Action to generate database partitions for batch query.

.google.spanner.executor.v1.GenerateDbPartitionsForQueryAction generate_db_partitions_query = 43;

Returns
TypeDescription
boolean

Whether the generateDbPartitionsQuery field is set.

hasGenerateDbPartitionsRead()

public boolean hasGenerateDbPartitionsRead()

Action to generate database partitions for batch read.

.google.spanner.executor.v1.GenerateDbPartitionsForReadAction generate_db_partitions_read = 42;

Returns
TypeDescription
boolean

Whether the generateDbPartitionsRead field is set.

hasMutation()

public boolean hasMutation()

Action to buffer a mutation.

.google.spanner.executor.v1.MutationAction mutation = 22;

Returns
TypeDescription
boolean

Whether the mutation field is set.

hasPartitionedUpdate()

public boolean hasPartitionedUpdate()

Action to a partitioned update.

.google.spanner.executor.v1.PartitionedUpdateAction partitioned_update = 27;

Returns
TypeDescription
boolean

Whether the partitionedUpdate field is set.

hasQuery()

public boolean hasQuery()

Action to do a query.

.google.spanner.executor.v1.QueryAction query = 21;

Returns
TypeDescription
boolean

Whether the query field is set.

hasRead()

public boolean hasRead()

Action to do a normal read.

.google.spanner.executor.v1.ReadAction read = 20;

Returns
TypeDescription
boolean

Whether the read field is set.

hasStart()

public boolean hasStart()

Action to start a transaction.

.google.spanner.executor.v1.StartTransactionAction start = 10;

Returns
TypeDescription
boolean

Whether the start field is set.

hasStartBatchTxn()

public boolean hasStartBatchTxn()

Action to start a batch transaction.

.google.spanner.executor.v1.StartBatchTransactionAction start_batch_txn = 40;

Returns
TypeDescription
boolean

Whether the startBatchTxn field is set.

hasWrite()

public boolean hasWrite()

Action to write a mutation.

.google.spanner.executor.v1.WriteMutationsAction write = 25;

Returns
TypeDescription
boolean

Whether the write field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SpannerAction.Builder newBuilderForType()
Returns
TypeDescription
SpannerAction.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SpannerAction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SpannerAction.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SpannerAction.Builder toBuilder()
Returns
TypeDescription
SpannerAction.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException