Class ReadAction.Builder (6.56.0)

public static final class ReadAction.Builder extends GeneratedMessageV3.Builder<ReadAction.Builder> implements ReadActionOrBuilder

A single read request.

Protobuf type google.spanner.executor.v1.ReadAction

Implements

ReadActionOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllColumn(Iterable<String> values)

public ReadAction.Builder addAllColumn(Iterable<String> values)

List of columns must begin with the key columns used for the read.

repeated string column = 3;

Parameter
NameDescription
valuesIterable<String>

The column to add.

Returns
TypeDescription
ReadAction.Builder

This builder for chaining.

addColumn(String value)

public ReadAction.Builder addColumn(String value)

List of columns must begin with the key columns used for the read.

repeated string column = 3;

Parameter
NameDescription
valueString

The column to add.

Returns
TypeDescription
ReadAction.Builder

This builder for chaining.

addColumnBytes(ByteString value)

public ReadAction.Builder addColumnBytes(ByteString value)

List of columns must begin with the key columns used for the read.

repeated string column = 3;

Parameter
NameDescription
valueByteString

The bytes of the column to add.

Returns
TypeDescription
ReadAction.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ReadAction.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ReadAction.Builder
Overrides

build()

public ReadAction build()
Returns
TypeDescription
ReadAction

buildPartial()

public ReadAction buildPartial()
Returns
TypeDescription
ReadAction

clear()

public ReadAction.Builder clear()
Returns
TypeDescription
ReadAction.Builder
Overrides

clearColumn()

public ReadAction.Builder clearColumn()

List of columns must begin with the key columns used for the read.

repeated string column = 3;

Returns
TypeDescription
ReadAction.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ReadAction.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ReadAction.Builder
Overrides

clearIndex()

public ReadAction.Builder clearIndex()

The index to read at if it's an index read.

optional string index = 2;

Returns
TypeDescription
ReadAction.Builder

This builder for chaining.

clearKeys()

public ReadAction.Builder clearKeys()

Keys for performing this read.

.google.spanner.executor.v1.KeySet keys = 4;

Returns
TypeDescription
ReadAction.Builder

clearLimit()

public ReadAction.Builder clearLimit()

Limit on number of rows to read. If set, must be positive.

int32 limit = 5;

Returns
TypeDescription
ReadAction.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ReadAction.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ReadAction.Builder
Overrides

clearTable()

public ReadAction.Builder clearTable()

The table to read at.

string table = 1;

Returns
TypeDescription
ReadAction.Builder

This builder for chaining.

clone()

public ReadAction.Builder clone()
Returns
TypeDescription
ReadAction.Builder
Overrides

getColumn(int index)

public String getColumn(int index)

List of columns must begin with the key columns used for the read.

repeated string column = 3;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The column at the given index.

getColumnBytes(int index)

public ByteString getColumnBytes(int index)

List of columns must begin with the key columns used for the read.

repeated string column = 3;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the column at the given index.

getColumnCount()

public int getColumnCount()

List of columns must begin with the key columns used for the read.

repeated string column = 3;

Returns
TypeDescription
int

The count of column.

getColumnList()

public ProtocolStringList getColumnList()

List of columns must begin with the key columns used for the read.

repeated string column = 3;

Returns
TypeDescription
ProtocolStringList

A list containing the column.

getDefaultInstanceForType()

public ReadAction getDefaultInstanceForType()
Returns
TypeDescription
ReadAction

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getIndex()

public String getIndex()

The index to read at if it's an index read.

optional string index = 2;

Returns
TypeDescription
String

The index.

getIndexBytes()

public ByteString getIndexBytes()

The index to read at if it's an index read.

optional string index = 2;

Returns
TypeDescription
ByteString

The bytes for index.

getKeys()

public KeySet getKeys()

Keys for performing this read.

.google.spanner.executor.v1.KeySet keys = 4;

Returns
TypeDescription
KeySet

The keys.

getKeysBuilder()

public KeySet.Builder getKeysBuilder()

Keys for performing this read.

.google.spanner.executor.v1.KeySet keys = 4;

Returns
TypeDescription
KeySet.Builder

getKeysOrBuilder()

public KeySetOrBuilder getKeysOrBuilder()

Keys for performing this read.

.google.spanner.executor.v1.KeySet keys = 4;

Returns
TypeDescription
KeySetOrBuilder

getLimit()

public int getLimit()

Limit on number of rows to read. If set, must be positive.

int32 limit = 5;

Returns
TypeDescription
int

The limit.

getTable()

public String getTable()

The table to read at.

string table = 1;

Returns
TypeDescription
String

The table.

getTableBytes()

public ByteString getTableBytes()

The table to read at.

string table = 1;

Returns
TypeDescription
ByteString

The bytes for table.

hasIndex()

public boolean hasIndex()

The index to read at if it's an index read.

optional string index = 2;

Returns
TypeDescription
boolean

Whether the index field is set.

hasKeys()

public boolean hasKeys()

Keys for performing this read.

.google.spanner.executor.v1.KeySet keys = 4;

Returns
TypeDescription
boolean

Whether the keys field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ReadAction.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadAction.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ReadAction.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ReadAction.Builder
Overrides

mergeFrom(ReadAction other)

public ReadAction.Builder mergeFrom(ReadAction other)
Parameter
NameDescription
otherReadAction
Returns
TypeDescription
ReadAction.Builder

mergeKeys(KeySet value)

public ReadAction.Builder mergeKeys(KeySet value)

Keys for performing this read.

.google.spanner.executor.v1.KeySet keys = 4;

Parameter
NameDescription
valueKeySet
Returns
TypeDescription
ReadAction.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ReadAction.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ReadAction.Builder
Overrides

setColumn(int index, String value)

public ReadAction.Builder setColumn(int index, String value)

List of columns must begin with the key columns used for the read.

repeated string column = 3;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The column to set.

Returns
TypeDescription
ReadAction.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ReadAction.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ReadAction.Builder
Overrides

setIndex(String value)

public ReadAction.Builder setIndex(String value)

The index to read at if it's an index read.

optional string index = 2;

Parameter
NameDescription
valueString

The index to set.

Returns
TypeDescription
ReadAction.Builder

This builder for chaining.

setIndexBytes(ByteString value)

public ReadAction.Builder setIndexBytes(ByteString value)

The index to read at if it's an index read.

optional string index = 2;

Parameter
NameDescription
valueByteString

The bytes for index to set.

Returns
TypeDescription
ReadAction.Builder

This builder for chaining.

setKeys(KeySet value)

public ReadAction.Builder setKeys(KeySet value)

Keys for performing this read.

.google.spanner.executor.v1.KeySet keys = 4;

Parameter
NameDescription
valueKeySet
Returns
TypeDescription
ReadAction.Builder

setKeys(KeySet.Builder builderForValue)

public ReadAction.Builder setKeys(KeySet.Builder builderForValue)

Keys for performing this read.

.google.spanner.executor.v1.KeySet keys = 4;

Parameter
NameDescription
builderForValueKeySet.Builder
Returns
TypeDescription
ReadAction.Builder

setLimit(int value)

public ReadAction.Builder setLimit(int value)

Limit on number of rows to read. If set, must be positive.

int32 limit = 5;

Parameter
NameDescription
valueint

The limit to set.

Returns
TypeDescription
ReadAction.Builder

This builder for chaining.

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

public ReadAction.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ReadAction.Builder
Overrides

setTable(String value)

public ReadAction.Builder setTable(String value)

The table to read at.

string table = 1;

Parameter
NameDescription
valueString

The table to set.

Returns
TypeDescription
ReadAction.Builder

This builder for chaining.

setTableBytes(ByteString value)

public ReadAction.Builder setTableBytes(ByteString value)

The table to read at.

string table = 1;

Parameter
NameDescription
valueByteString

The bytes for table to set.

Returns
TypeDescription
ReadAction.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ReadAction.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ReadAction.Builder
Overrides