Class StartBatchTransactionAction.Builder (6.82.0)

Version 6.82.0

• 6.83.0 (latest)
• 6.82.0
• 6.80.1
• 6.79.0
• 6.77.0
• 6.74.1
• 6.72.0
• 6.71.0
• 6.69.0
• 6.68.0
• 6.66.0
• 6.65.1
• 6.62.0
• 6.60.0
• 6.58.0
• 6.57.0
• 6.56.0
• 6.55.0
• 6.54.0
• 6.53.0
• 6.52.1
• 6.51.0
• 6.50.1
• 6.49.0
• 6.25.1
• 6.24.0
• 6.23.4
• 6.22.0
• 6.21.2
• 6.20.0
• 6.19.1
• 6.18.0
• 6.17.4
• 6.14.1

public static final class StartBatchTransactionAction.Builder extends GeneratedMessageV3.Builder<StartBatchTransactionAction.Builder> implements StartBatchTransactionActionOrBuilder

Starts a batch read-only transaction in executor. Successful outcomes of this action will contain batch_txn_id--the identificator that can be used to start the same transaction in other Executors to parallelize partition processing.

Example of a batch read flow:

1. Start batch transaction with a timestamp (StartBatchTransactionAction)
2. Generate database partitions for a read or query (GenerateDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction)
3. Call ExecutePartitionAction for some or all partitions, process rows

4. Clean up the transaction (CloseBatchTransactionAction).

   More sophisticated example, with parallel processing:

5. Start batch transaction with a timestamp (StartBatchTransactionAction), note the returned BatchTransactionId
6. Generate database partitions for a read or query (GenerateDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction)

7. Distribute the partitions over a pool of workers, along with the transaction ID.

   In each worker: 4-1. StartBatchTransactionAction with the given transaction ID 4-2. ExecutePartitionAction for each partition it got, process read results 4-3. Close (not cleanup) the transaction (CloseBatchTransactionAction).

   When all workers are done:

8. Cleanup the transaction (CloseBatchTransactionAction). This can be done either by the last worker to finish the job, or by the main Executor that initialized this transaction in the first place. It is also possible to clean it up with a brand new Executor -- just execute StartBatchTransactionAction with the ID, then clean it up right away.

   Cleaning up is optional, but recommended.

Protobuf type google.spanner.executor.v1.StartBatchTransactionAction

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > StartBatchTransactionAction.Builder

Implements

StartBatchTransactionActionOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public StartBatchTransactionAction.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
StartBatchTransactionAction.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public StartBatchTransactionAction build()

Returns
Type	Description
StartBatchTransactionAction

buildPartial()

public StartBatchTransactionAction buildPartial()

Returns
Type	Description
StartBatchTransactionAction

clear()

public StartBatchTransactionAction.Builder clear()

Returns
Type	Description
StartBatchTransactionAction.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearBatchTxnTime()

public StartBatchTransactionAction.Builder clearBatchTxnTime()

The exact timestamp to start the batch transaction.

.google.protobuf.Timestamp batch_txn_time = 1;

Returns
Type	Description
StartBatchTransactionAction.Builder

clearCloudDatabaseRole()

public StartBatchTransactionAction.Builder clearCloudDatabaseRole()

Database role to assume while performing this action. Setting the database_role will enforce additional role-based access checks on this action.

string cloud_database_role = 3;

Returns
Type	Description
StartBatchTransactionAction.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public StartBatchTransactionAction.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
StartBatchTransactionAction.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public StartBatchTransactionAction.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
StartBatchTransactionAction.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearParam()

public StartBatchTransactionAction.Builder clearParam()

Returns
Type	Description
StartBatchTransactionAction.Builder

clearTid()

public StartBatchTransactionAction.Builder clearTid()

ID of a batch read-only transaction. It can be used to start the same batch transaction on multiple executors and parallelize partition processing.

bytes tid = 2;

Returns
Type	Description
StartBatchTransactionAction.Builder	This builder for chaining.

clone()

public StartBatchTransactionAction.Builder clone()

Returns
Type	Description
StartBatchTransactionAction.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getBatchTxnTime()

public Timestamp getBatchTxnTime()

The exact timestamp to start the batch transaction.

.google.protobuf.Timestamp batch_txn_time = 1;

Returns
Type	Description
Timestamp	The batchTxnTime.

getBatchTxnTimeBuilder()

public Timestamp.Builder getBatchTxnTimeBuilder()

The exact timestamp to start the batch transaction.

.google.protobuf.Timestamp batch_txn_time = 1;

Returns
Type	Description
Builder

getBatchTxnTimeOrBuilder()

public TimestampOrBuilder getBatchTxnTimeOrBuilder()

The exact timestamp to start the batch transaction.

.google.protobuf.Timestamp batch_txn_time = 1;

Returns
Type	Description
TimestampOrBuilder

getCloudDatabaseRole()

public String getCloudDatabaseRole()

Database role to assume while performing this action. Setting the database_role will enforce additional role-based access checks on this action.

string cloud_database_role = 3;

Returns
Type	Description
String	The cloudDatabaseRole.

getCloudDatabaseRoleBytes()

public ByteString getCloudDatabaseRoleBytes()

Database role to assume while performing this action. Setting the database_role will enforce additional role-based access checks on this action.

string cloud_database_role = 3;

Returns
Type	Description
ByteString	The bytes for cloudDatabaseRole.

getDefaultInstanceForType()

public StartBatchTransactionAction getDefaultInstanceForType()

Returns
Type	Description
StartBatchTransactionAction

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getParamCase()

public StartBatchTransactionAction.ParamCase getParamCase()

Returns
Type	Description
StartBatchTransactionAction.ParamCase

getTid()

public ByteString getTid()

ID of a batch read-only transaction. It can be used to start the same batch transaction on multiple executors and parallelize partition processing.

bytes tid = 2;

Returns
Type	Description
ByteString	The tid.

hasBatchTxnTime()

public boolean hasBatchTxnTime()

The exact timestamp to start the batch transaction.

.google.protobuf.Timestamp batch_txn_time = 1;

Returns
Type	Description
boolean	Whether the batchTxnTime field is set.

hasTid()

public boolean hasTid()

ID of a batch read-only transaction. It can be used to start the same batch transaction on multiple executors and parallelize partition processing.

bytes tid = 2;

Returns
Type	Description
boolean	Whether the tid field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeBatchTxnTime(Timestamp value)

public StartBatchTransactionAction.Builder mergeBatchTxnTime(Timestamp value)

The exact timestamp to start the batch transaction.

.google.protobuf.Timestamp batch_txn_time = 1;

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
StartBatchTransactionAction.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StartBatchTransactionAction.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
StartBatchTransactionAction.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public StartBatchTransactionAction.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
StartBatchTransactionAction.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeFrom(StartBatchTransactionAction other)

public StartBatchTransactionAction.Builder mergeFrom(StartBatchTransactionAction other)

Parameter
Name	Description
other	StartBatchTransactionAction

Returns
Type	Description
StartBatchTransactionAction.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StartBatchTransactionAction.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
StartBatchTransactionAction.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setBatchTxnTime(Timestamp value)

public StartBatchTransactionAction.Builder setBatchTxnTime(Timestamp value)

The exact timestamp to start the batch transaction.

.google.protobuf.Timestamp batch_txn_time = 1;

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
StartBatchTransactionAction.Builder

setBatchTxnTime(Timestamp.Builder builderForValue)

public StartBatchTransactionAction.Builder setBatchTxnTime(Timestamp.Builder builderForValue)

The exact timestamp to start the batch transaction.

.google.protobuf.Timestamp batch_txn_time = 1;

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
StartBatchTransactionAction.Builder

setCloudDatabaseRole(String value)

public StartBatchTransactionAction.Builder setCloudDatabaseRole(String value)

Database role to assume while performing this action. Setting the database_role will enforce additional role-based access checks on this action.

string cloud_database_role = 3;

Parameter
Name	Description
value	String The cloudDatabaseRole to set.

Returns
Type	Description
StartBatchTransactionAction.Builder	This builder for chaining.

setCloudDatabaseRoleBytes(ByteString value)

public StartBatchTransactionAction.Builder setCloudDatabaseRoleBytes(ByteString value)

Database role to assume while performing this action. Setting the database_role will enforce additional role-based access checks on this action.

string cloud_database_role = 3;

Parameter
Name	Description
value	ByteString The bytes for cloudDatabaseRole to set.

Returns
Type	Description
StartBatchTransactionAction.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public StartBatchTransactionAction.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
StartBatchTransactionAction.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public StartBatchTransactionAction.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
StartBatchTransactionAction.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setTid(ByteString value)

public StartBatchTransactionAction.Builder setTid(ByteString value)

ID of a batch read-only transaction. It can be used to start the same batch transaction on multiple executors and parallelize partition processing.

bytes tid = 2;

Parameter
Name	Description
value	ByteString The tid to set.

Returns
Type	Description
StartBatchTransactionAction.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final StartBatchTransactionAction.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
StartBatchTransactionAction.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)