Class SpannerAction (6.66.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
Type Description
int

BATCH_DML_FIELD_NUMBER

public static final int BATCH_DML_FIELD_NUMBER
Field Value
Type Description
int

CLOSE_BATCH_TXN_FIELD_NUMBER

public static final int CLOSE_BATCH_TXN_FIELD_NUMBER
Field Value
Type Description
int

DATABASE_PATH_FIELD_NUMBER

public static final int DATABASE_PATH_FIELD_NUMBER
Field Value
Type Description
int

DML_FIELD_NUMBER

public static final int DML_FIELD_NUMBER
Field Value
Type Description
int

EXECUTE_CHANGE_STREAM_QUERY_FIELD_NUMBER

public static final int EXECUTE_CHANGE_STREAM_QUERY_FIELD_NUMBER
Field Value
Type Description
int

EXECUTE_PARTITION_FIELD_NUMBER

public static final int EXECUTE_PARTITION_FIELD_NUMBER
Field Value
Type Description
int

FINISH_FIELD_NUMBER

public static final int FINISH_FIELD_NUMBER
Field Value
Type Description
int

GENERATE_DB_PARTITIONS_QUERY_FIELD_NUMBER

public static final int GENERATE_DB_PARTITIONS_QUERY_FIELD_NUMBER
Field Value
Type Description
int

GENERATE_DB_PARTITIONS_READ_FIELD_NUMBER

public static final int GENERATE_DB_PARTITIONS_READ_FIELD_NUMBER
Field Value
Type Description
int

MUTATION_FIELD_NUMBER

public static final int MUTATION_FIELD_NUMBER
Field Value
Type Description
int

PARTITIONED_UPDATE_FIELD_NUMBER

public static final int PARTITIONED_UPDATE_FIELD_NUMBER
Field Value
Type Description
int

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER
Field Value
Type Description
int

READ_FIELD_NUMBER

public static final int READ_FIELD_NUMBER
Field Value
Type Description
int

SPANNER_OPTIONS_FIELD_NUMBER

public static final int SPANNER_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

START_BATCH_TXN_FIELD_NUMBER

public static final int START_BATCH_TXN_FIELD_NUMBER
Field Value
Type Description
int

START_FIELD_NUMBER

public static final int START_FIELD_NUMBER
Field Value
Type Description
int

WRITE_FIELD_NUMBER

public static final int WRITE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SpannerAction getDefaultInstance()
Returns
Type Description
SpannerAction

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SpannerAction.Builder newBuilder()
Returns
Type Description
SpannerAction.Builder

newBuilder(SpannerAction prototype)

public static SpannerAction.Builder newBuilder(SpannerAction prototype)
Parameter
Name Description
prototype SpannerAction
Returns
Type Description
SpannerAction.Builder

parseDelimitedFrom(InputStream input)

public static SpannerAction parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SpannerAction
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SpannerAction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpannerAction
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SpannerAction parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SpannerAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SpannerAction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpannerAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SpannerAction parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SpannerAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SpannerAction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpannerAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SpannerAction parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SpannerAction
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SpannerAction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpannerAction
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SpannerAction parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SpannerAction
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SpannerAction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpannerAction
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SpannerAction parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SpannerAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SpannerAction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpannerAction
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SpannerAction> parser()
Returns
Type Description
Parser<SpannerAction>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getActionCase()

public SpannerAction.ActionCase getActionCase()
Returns
Type Description
SpannerAction.ActionCase

getAdmin()

public AdminAction getAdmin()

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

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

Returns
Type Description
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
Type Description
AdminActionOrBuilder

getBatchDml()

public BatchDmlAction getBatchDml()

Action to a batch DML.

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

Returns
Type Description
BatchDmlAction

The batchDml.

getBatchDmlOrBuilder()

public BatchDmlActionOrBuilder getBatchDmlOrBuilder()

Action to a batch DML.

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

Returns
Type Description
BatchDmlActionOrBuilder

getCloseBatchTxn()

public CloseBatchTransactionAction getCloseBatchTxn()

Action to close a batch transaction.

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

Returns
Type Description
CloseBatchTransactionAction

The closeBatchTxn.

getCloseBatchTxnOrBuilder()

public CloseBatchTransactionActionOrBuilder getCloseBatchTxnOrBuilder()

Action to close a batch transaction.

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

Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for databasePath.

getDefaultInstanceForType()

public SpannerAction getDefaultInstanceForType()
Returns
Type Description
SpannerAction

getDml()

public DmlAction getDml()

Action to a DML.

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

Returns
Type Description
DmlAction

The dml.

getDmlOrBuilder()

public DmlActionOrBuilder getDmlOrBuilder()

Action to a DML.

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

Returns
Type Description
DmlActionOrBuilder

getExecuteChangeStreamQuery()

public ExecuteChangeStreamQuery getExecuteChangeStreamQuery()

Action to execute change stream query.

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

Returns
Type Description
ExecuteChangeStreamQuery

The executeChangeStreamQuery.

getExecuteChangeStreamQueryOrBuilder()

public ExecuteChangeStreamQueryOrBuilder getExecuteChangeStreamQueryOrBuilder()

Action to execute change stream query.

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

Returns
Type Description
ExecuteChangeStreamQueryOrBuilder

getExecutePartition()

public ExecutePartitionAction getExecutePartition()

Action to execute batch actions on generated partitions.

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

Returns
Type Description
ExecutePartitionAction

The executePartition.

getExecutePartitionOrBuilder()

public ExecutePartitionActionOrBuilder getExecutePartitionOrBuilder()

Action to execute batch actions on generated partitions.

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

Returns
Type Description
ExecutePartitionActionOrBuilder

getFinish()

public FinishTransactionAction getFinish()

Action to finish a transaction.

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

Returns
Type Description
FinishTransactionAction

The finish.

getFinishOrBuilder()

public FinishTransactionActionOrBuilder getFinishOrBuilder()

Action to finish a transaction.

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

Returns
Type Description
FinishTransactionActionOrBuilder

getGenerateDbPartitionsQuery()

public GenerateDbPartitionsForQueryAction getGenerateDbPartitionsQuery()

Action to generate database partitions for batch query.

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

Returns
Type Description
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
Type Description
GenerateDbPartitionsForQueryActionOrBuilder

getGenerateDbPartitionsRead()

public GenerateDbPartitionsForReadAction getGenerateDbPartitionsRead()

Action to generate database partitions for batch read.

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

Returns
Type Description
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
Type Description
GenerateDbPartitionsForReadActionOrBuilder

getMutation()

public MutationAction getMutation()

Action to buffer a mutation.

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

Returns
Type Description
MutationAction

The mutation.

getMutationOrBuilder()

public MutationActionOrBuilder getMutationOrBuilder()

Action to buffer a mutation.

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

Returns
Type Description
MutationActionOrBuilder

getParserForType()

public Parser<SpannerAction> getParserForType()
Returns
Type Description
Parser<SpannerAction>
Overrides

getPartitionedUpdate()

publ