Class SpannerActionOutcome.Builder (6.66.0)

public static final class SpannerActionOutcome.Builder extends GeneratedMessageV3.Builder<SpannerActionOutcome.Builder> implements SpannerActionOutcomeOrBuilder

SpannerActionOutcome defines a result of execution of a single SpannerAction.

Protobuf type google.spanner.executor.v1.SpannerActionOutcome

Inheritance

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

Implements

SpannerActionOutcomeOrBuilder

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

addAllChangeStreamRecords(Iterable<? extends ChangeStreamRecord> values)

public SpannerActionOutcome.Builder addAllChangeStreamRecords(Iterable<? extends ChangeStreamRecord> values)

Change stream records returned by a change stream query.

repeated .google.spanner.executor.v1.ChangeStreamRecord change_stream_records = 10;

Parameter
Name	Description
`values`	`Iterable<? extends com.google.spanner.executor.v1.ChangeStreamRecord>`

Returns
Type	Description
`SpannerActionOutcome.Builder`

addAllDbPartition(Iterable<? extends BatchPartition> values)

public SpannerActionOutcome.Builder addAllDbPartition(Iterable<? extends BatchPartition> values)

Generated database partitions (result of a GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).

repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;

Parameter
Name	Description
`values`	`Iterable<? extends com.google.spanner.executor.v1.BatchPartition>`

Returns
Type	Description
`SpannerActionOutcome.Builder`

addAllDmlRowsModified(Iterable<? extends Long> values)

public SpannerActionOutcome.Builder addAllDmlRowsModified(Iterable<? extends Long> values)

Stores rows modified by query in single DML or batch DML action. In case of batch DML action, stores 0 as row count of errored DML query.

repeated int64 dml_rows_modified = 9;

Parameter
Name	Description
`values`	`Iterable<? extends java.lang.Long>` The dmlRowsModified to add.

Returns
Type	Description
`SpannerActionOutcome.Builder`	This builder for chaining.

addChangeStreamRecords(ChangeStreamRecord value)

public SpannerActionOutcome.Builder addChangeStreamRecords(ChangeStreamRecord value)

Change stream records returned by a change stream query.

repeated .google.spanner.executor.v1.ChangeStreamRecord change_stream_records = 10;

Parameter
Name	Description
`value`	`ChangeStreamRecord`

Returns
Type	Description
`SpannerActionOutcome.Builder`

addChangeStreamRecords(ChangeStreamRecord.Builder builderForValue)

public SpannerActionOutcome.Builder addChangeStreamRecords(ChangeStreamRecord.Builder builderForValue)

Change stream records returned by a change stream query.

repeated .google.spanner.executor.v1.ChangeStreamRecord change_stream_records = 10;

Parameter
Name	Description
`builderForValue`	`ChangeStreamRecord.Builder`

Returns
Type	Description
`SpannerActionOutcome.Builder`

addChangeStreamRecords(int index, ChangeStreamRecord value)

public SpannerActionOutcome.Builder addChangeStreamRecords(int index, ChangeStreamRecord value)

Change stream records returned by a change stream query.

repeated .google.spanner.executor.v1.ChangeStreamRecord change_stream_records = 10;

Parameters
Name	Description
`index`	`int`
`value`	`ChangeStreamRecord`

Returns
Type	Description
`SpannerActionOutcome.Builder`

addChangeStreamRecords(int index, ChangeStreamRecord.Builder builderForValue)

public SpannerActionOutcome.Builder addChangeStreamRecords(int index, ChangeStreamRecord.Builder builderForValue)

Change stream records returned by a change stream query.

repeated .google.spanner.executor.v1.ChangeStreamRecord change_stream_records = 10;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`ChangeStreamRecord.Builder`

Returns
Type	Description
`SpannerActionOutcome.Builder`

addChangeStreamRecordsBuilder()

public ChangeStreamRecord.Builder addChangeStreamRecordsBuilder()

Change stream records returned by a change stream query.

repeated .google.spanner.executor.v1.ChangeStreamRecord change_stream_records = 10;

Returns
Type	Description
`ChangeStreamRecord.Builder`

addChangeStreamRecordsBuilder(int index)

public ChangeStreamRecord.Builder addChangeStreamRecordsBuilder(int index)

Change stream records returned by a change stream query.

repeated .google.spanner.executor.v1.ChangeStreamRecord change_stream_records = 10;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ChangeStreamRecord.Builder`

addDbPartition(BatchPartition value)

public SpannerActionOutcome.Builder addDbPartition(BatchPartition value)

Generated database partitions (result of a GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).

repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;

Parameter
Name	Description
`value`	`BatchPartition`

Returns
Type	Description
`SpannerActionOutcome.Builder`

addDbPartition(BatchPartition.Builder builderForValue)

public SpannerActionOutcome.Builder addDbPartition(BatchPartition.Builder builderForValue)

Generated database partitions (result of a GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).

repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;

Parameter
Name	Description
`builderForValue`	`BatchPartition.Builder`

Returns
Type	Description
`SpannerActionOutcome.Builder`

addDbPartition(int index, BatchPartition value)

public SpannerActionOutcome.Builder addDbPartition(int index, BatchPartition value)

Generated database partitions (result of a GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).

repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;

Parameters
Name	Description
`index`	`int`
`value`	`BatchPartition`

Returns
Type	Description
`SpannerActionOutcome.Builder`

addDbPartition(int index, BatchPartition.Builder builderForValue)

public SpannerActionOutcome.Builder addDbPartition(int index, BatchPartition.Builder builderForValue)

Generated database partitions (result of a GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).

repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`BatchPartition.Builder`

Returns
Type	Description
`SpannerActionOutcome.Builder`

addDbPartitionBuilder()

public BatchPartition.Builder addDbPartitionBuilder()

Generated database partitions (result of a GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).

repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;

Returns
Type	Description
`BatchPartition.Builder`

addDbPartitionBuilder(int index)

public BatchPartition.Builder addDbPartitionBuilder(int index)

Generated database partitions (result of a GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).

repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`BatchPartition.Builder`

addDmlRowsModified(long value)

public SpannerActionOutcome.Builder addDmlRowsModified(long value)

Stores rows modified by query in single DML or batch DML action. In case of batch DML action, stores 0 as row count of errored DML query.

repeated int64 dml_rows_modified = 9;

Parameter
Name	Description
`value`	`long` The dmlRowsModified to add.

Returns
Type	Description
`SpannerActionOutcome.Builder`	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`SpannerActionOutcome.Builder`

Overrides

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

build()

public SpannerActionOutcome build()

Returns
Type	Description
`SpannerActionOutcome`

buildPartial()

public SpannerActionOutcome buildPartial()

Returns
Type	Description
`SpannerActionOutcome`

clear()

public SpannerActionOutcome.Builder clear()

Returns
Type	Description
`SpannerActionOutcome.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAdminResult()

public SpannerActionOutcome.Builder clearAdminResult()

Result of admin related actions.

optional .google.spanner.executor.v1.AdminResult admin_result = 8;

Returns
Type	Description
`SpannerActionOutcome.Builder`

clearBatchTxnId()

public SpannerActionOutcome.Builder clearBatchTxnId()

In successful StartBatchTransactionAction outcomes, this contains the ID of the transaction.

optional bytes batch_txn_id = 6;

Returns
Type	Description
`SpannerActionOutcome.Builder`	This builder for chaining.

clearChangeStreamRecords()

public SpannerActionOutcome.Builder clearChangeStreamRecords()

Change stream records returned by a change stream query.

repeated .google.spanner.executor.v1.ChangeStreamRecord change_stream_records = 10;

Returns
Type	Description
`SpannerActionOutcome.Builder`

clearCommitTime()

public SpannerActionOutcome.Builder clearCommitTime()

Transaction timestamp. It must be set for successful committed actions.

optional .google.protobuf.Timestamp commit_time = 2;

Returns
Type	Description
`SpannerActionOutcome.Builder`

clearDbPartition()

public SpannerActionOutcome.Builder clearDbPartition()

Generated database partitions (result of a GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).

repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;

Returns
Type	Description
`SpannerActionOutcome.Builder`

clearDmlRowsModified()

public SpannerActionOutcome.Builder clearDmlRowsModified()

Stores rows modified by query in single DML or batch DML action. In case of batch DML action, stores 0 as row count of errored DML query.

repeated int64 dml_rows_modified = 9;

Returns
Type	Description
`SpannerActionOutcome.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SpannerActionOutcome.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`SpannerActionOutcome.Builder`

Overrides

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

clearOneof(Descriptors.OneofDescriptor oneof)

public SpannerActionOutcome.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`SpannerActionOutcome.Builder`

Overrides

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

clearQueryResult()

public SpannerActionOutcome.Builder clearQueryResult()

Result of a Query. This field must be set for Queries even if no rows were read.

optional .google.spanner.executor.v1.QueryResult query_result = 4;

Returns
Type	Description
`SpannerActionOutcome.Builder`

clearReadResult()

public SpannerActionOutcome.Builder clearReadResult()

Result of a ReadAction. This field must be set for ReadActions even if no rows were read.

optional .google.spanner.executor.v1.ReadResult read_result = 3;

Returns
Type	Description
`SpannerActionOutcome.Builder`

clearStatus()

public SpannerActionOutcome.Builder clearStatus()

If an outcome is split into multiple parts, status will be set only in the last part.

optional .google.rpc.Status status = 1;

Returns
Type	Description
`SpannerActionOutcome.Builder`

clearTransactionRestarted()

public SpannerActionOutcome.Builder clearTransactionRestarted()

This bit indicates that Spanner has restarted the current transaction. It means that the client should replay all the reads and writes. Setting it to true is only valid in the context of a read-write transaction, as an outcome of a committing FinishTransactionAction.

optional bool transaction_restarted = 5;

Returns
Type	Description
`SpannerActionOutcome.Builder`	This builder for chaining.

clone()

public SpannerActionOutcome.Builder clone()

Returns
Type	Description
`SpannerActionOutcome.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAdminResult()

public AdminResult getAdminResult()

Result of admin related actions.

optional .google.spanner.executor.v1.AdminResult admin_result = 8;

Returns
Type	Description