Class SpannerAction.Builder (6.66.0)

public static final class SpannerAction.Builder extends GeneratedMessageV3.Builder<SpannerAction.Builder> 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 Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SpannerAction.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SpannerAction.Builder
Overrides

build()

public SpannerAction build()
Returns
Type Description
SpannerAction

buildPartial()

public SpannerAction buildPartial()
Returns
Type Description
SpannerAction

clear()

public SpannerAction.Builder clear()
Returns
Type Description
SpannerAction.Builder
Overrides

clearAction()

public SpannerAction.Builder clearAction()
Returns
Type Description
SpannerAction.Builder

clearAdmin()

public SpannerAction.Builder clearAdmin()

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

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

Returns
Type Description
SpannerAction.Builder

clearBatchDml()

public SpannerAction.Builder clearBatchDml()

Action to a batch DML.

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

Returns
Type Description
SpannerAction.Builder

clearCloseBatchTxn()

public SpannerAction.Builder clearCloseBatchTxn()

Action to close a batch transaction.

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

Returns
Type Description
SpannerAction.Builder

clearDatabasePath()

public SpannerAction.Builder clearDatabasePath()

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
SpannerAction.Builder

This builder for chaining.

clearDml()

public SpannerAction.Builder clearDml()

Action to a DML.

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

Returns
Type Description
SpannerAction.Builder

clearExecuteChangeStreamQuery()

public SpannerAction.Builder clearExecuteChangeStreamQuery()

Action to execute change stream query.

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

Returns
Type Description
SpannerAction.Builder

clearExecutePartition()

public SpannerAction.Builder clearExecutePartition()

Action to execute batch actions on generated partitions.

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

Returns
Type Description
SpannerAction.Builder

clearField(Descriptors.FieldDescriptor field)

public SpannerAction.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SpannerAction.Builder
Overrides

clearFinish()

public SpannerAction.Builder clearFinish()

Action to finish a transaction.

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

Returns
Type Description
SpannerAction.Builder

clearGenerateDbPartitionsQuery()

public SpannerAction.Builder clearGenerateDbPartitionsQuery()

Action to generate database partitions for batch query.

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

Returns
Type Description
SpannerAction.Builder

clearGenerateDbPartitionsRead()

public SpannerAction.Builder clearGenerateDbPartitionsRead()

Action to generate database partitions for batch read.

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

Returns
Type Description
SpannerAction.Builder

clearMutation()

public SpannerAction.Builder clearMutation()

Action to buffer a mutation.

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

Returns
Type Description
SpannerAction.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public SpannerAction.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SpannerAction.Builder
Overrides

clearPartitionedUpdate()

public SpannerAction.Builder clearPartitionedUpdate()

Action to a partitioned update.

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

Returns
Type Description
SpannerAction.Builder

clearQuery()

public SpannerAction.Builder clearQuery()

Action to do a query.

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

Returns
Type Description
SpannerAction.Builder

clearRead()

public SpannerAction.Builder clearRead()

Action to do a normal read.

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

Returns
Type Description
SpannerAction.Builder

clearSpannerOptions()

public SpannerAction.Builder clearSpannerOptions()

Configuration options for Spanner backend

.google.spanner.executor.v1.SpannerOptions spanner_options = 2;

Returns
Type Description
SpannerAction.Builder

clearStart()

public SpannerAction.Builder clearStart()

Action to start a transaction.

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

Returns
Type Description
SpannerAction.Builder

clearStartBatchTxn()

public SpannerAction.Builder clearStartBatchTxn()

Action to start a batch transaction.

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

Returns
Type Description
SpannerAction.Builder

clearWrite()

public SpannerAction.Builder clearWrite()

Action to write a mutation.

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

Returns
Type Description
SpannerAction.Builder

clone()

public SpannerAction.Builder clone()
Returns
Type Description
SpannerAction.Builder
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.

getAdminBuilder()

public AdminAction.Builder getAdminBuilder()

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

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

Returns
Type Description
AdminAction.Builder

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.

getBatchDmlBuilder()

public BatchDmlAction.Builder getBatchDmlBuilder()

Action to a batch DML.

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

Returns
Type Description
BatchDmlAction.Builder

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.

getCloseBatchTxnBuilder()

public CloseBatchTransactionAction.Builder getCloseBatchTxnBuilder()

Action to close a batch transaction.

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

Returns
Type Description
CloseBatchTransactionAction.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDml()

public DmlAction getDml()

Action to a DML.

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

Returns
Type Description
DmlAction

The dml.

getDmlBuilder()

public DmlAction.Builder getDmlBuilder()

Action to a DML.

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

Returns
Type Description
DmlAction.Builder

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.

getExecuteChangeStreamQueryBuilder()

public ExecuteChangeStreamQuery.Builder getExecuteChangeStreamQueryBuilder()

Action to execute change stream query.

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

Returns
Type Description
ExecuteChangeStreamQuery.Builder

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.

getExecutePartitionBuilder()

public ExecutePartitionAction.Builder getExecutePartitionBuilder()

Action to execute batch actions on generated partitions.

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

Returns
Type Description
ExecutePartitionAction.Builder

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.

getFinishBuilder()

public FinishTransactionAction.Builder getFinishBuilder()

Action to finish a transaction.

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

Returns
Type Description
FinishTransactionAction.Builder

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.

getGenerateDbPartitionsQueryBuilder()

public GenerateDbPartitionsForQueryAction.Builder getGenerateDbPartitionsQueryBuilder()

Action to generate database partitions for batch query.

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

Returns
Type Description
GenerateDbPartitionsForQueryAction.Builder

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.

getGenerateDbPartitionsReadBuilder()

public GenerateDbPartitionsForReadAction.Builder getGenerateDbPartitionsReadBuilder()

Action to generate database partitions for batch read.

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

Returns
Type Description
GenerateDbPartitionsForReadAction.Builder

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.

getMutationBuilder()

public MutationAction.Builder getMutationBuilder()

Action to buffer a mutation.

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

Returns
Type Description
MutationAction.Builder

getMutationOrBuilder()

public MutationActionOrBuilder getMutationOrBuilder()

Action to buffer a mutation.

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

Returns
Type Description
MutationActionOrBuilder

getPartitionedUpdate()

public PartitionedUpdateAction getPartitionedUpdate()

Action to a partitioned update.

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

Returns
Type Description
PartitionedUpdateAction

The partitionedUpdate.

getPartitionedUpdateBuilder()

public PartitionedUpdateAction.Builder getPartitionedUpdateBuilder()

Action to a partitioned update.

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

Returns
Type Description
PartitionedUpdateAction.Builder

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.

getQueryBuilder()

public QueryAction.Builder getQueryBuilder()

Action to do a query.

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

Returns
Type Description
QueryAction.Builder

getQueryOrBuilder()

public QueryActionOrBuilder getQueryOrBuilder()

Action to do a query.

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

Returns
Type Description