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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SpannerActionImplements
SpannerActionOrBuilderStatic 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 |
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 |
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> |
getPartitionedUpdate()
public PartitionedUpdateAction getPartitionedUpdate()
Action to a partitioned update.
.google.spanner.executor.v1.PartitionedUpdateAction partitioned_update = 27;
Returns | |
---|---|
Type | Description |
PartitionedUpdateAction | The partitionedUpdate. |
getPartitionedUpdateOrBuilder()
public PartitionedUpdateActionOrBuilder getPartitionedUpdateOrBuilder()
Action to a partitioned update.
.google.spanner.executor.v1.PartitionedUpdateAction partitioned_update = 27;
Returns | |
---|---|
Type | Description |
PartitionedUpdateActionOrBuilder |
getQuery()
public QueryAction getQuery()
Action to do a query.
.google.spanner.executor.v1.QueryAction query = 21;
Returns | |
---|---|
Type | Description |
QueryAction | The query. |
getQueryOrBuilder()
public QueryActionOrBuilder getQueryOrBuilder()
Action to do a query.
.google.spanner.executor.v1.QueryAction query = 21;
Returns | |
---|---|
Type | Description |
QueryActionOrBuilder |
getRead()
public ReadAction getRead()
Action to do a normal read.
.google.spanner.executor.v1.ReadAction read = 20;
Returns | |
---|---|
Type | Description |
ReadAction | The read. |
getReadOrBuilder()
public ReadActionOrBuilder getReadOrBuilder()
Action to do a normal read.
.google.spanner.executor.v1.ReadAction read = 20;
Returns | |
---|---|
Type | Description |
ReadActionOrBuilder |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
getStart()
public StartTransactionAction getStart()
Action to start a transaction.
.google.spanner.executor.v1.StartTransactionAction start = 10;
Returns | |
---|---|
Type | Description |
StartTransactionAction | The start. |
getStartBatchTxn()
public StartBatchTransactionAction getStartBatchTxn()
Action to start a batch transaction.
.google.spanner.executor.v1.StartBatchTransactionAction start_batch_txn = 40;
Returns | |
---|---|
Type | Description |
StartBatchTransactionAction | The startBatchTxn. |
getStartBatchTxnOrBuilder()
public StartBatchTransactionActionOrBuilder getStartBatchTxnOrBuilder()
Action to start a batch transaction.
.google.spanner.executor.v1.StartBatchTransactionAction start_batch_txn = 40;
Returns | |
---|---|
Type | Description |
StartBatchTransactionActionOrBuilder |
getStartOrBuilder()
public StartTransactionActionOrBuilder getStartOrBuilder()
Action to start a transaction.
.google.spanner.executor.v1.StartTransactionAction start = 10;
Returns | |
---|---|
Type | Description |
StartTransactionActionOrBuilder |
getWrite()
public WriteMutationsAction getWrite()
Action to write a mutation.
.google.spanner.executor.v1.WriteMutationsAction write = 25;
Returns | |
---|---|
Type | Description |
WriteMutationsAction | The write. |
getWriteOrBuilder()
public WriteMutationsActionOrBuilder getWriteOrBuilder()
Action to write a mutation.
.google.spanner.executor.v1.WriteMutationsAction write = 25;
Returns | |
---|---|
Type | Description |
WriteMutationsActionOrBuilder |
hasAdmin()
public boolean hasAdmin()
Action that contains any administrative operation, like database, instance manipulation.
.google.spanner.executor.v1.AdminAction admin = 30;
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
boolean | Whether the closeBatchTxn field is set. |
hasDml()
public boolean hasDml()
Action to a DML.
.google.spanner.executor.v1.DmlAction dml = 23;
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
boolean | Whether the executePartition field is set. |
hasFinish()
public boolean hasFinish()
Action to finish a transaction.
.google.spanner.executor.v1.FinishTransactionAction finish = 11;
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
boolean | Whether the generateDbPartitionsRead field is set. |
hasMutation()
public boolean hasMutation()
Action to buffer a mutation.
.google.spanner.executor.v1.MutationAction mutation = 22;
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
boolean | Whether the partitionedUpdate field is set. |
hasQuery()
public boolean hasQuery()
Action to do a query.
.google.spanner.executor.v1.QueryAction query = 21;
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
boolean | Whether the read field is set. |
hasStart()
public boolean hasStart()
Action to start a transaction.
.google.spanner.executor.v1.StartTransactionAction start = 10;
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
boolean | Whether the startBatchTxn field is set. |
hasWrite()
public boolean hasWrite()
Action to write a mutation.
.google.spanner.executor.v1.WriteMutationsAction write = 25;
Returns | |
---|---|
Type | Description |
boolean | Whether the write field is set. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public SpannerAction.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
SpannerAction.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SpannerAction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent | BuilderParent |
Returns | |
---|---|
Type | Description |
SpannerAction.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused | UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public SpannerAction.Builder toBuilder()
Returns | |
---|---|
Type | Description |
SpannerAction.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output | CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |