Class ReadAction.Builder (6.68.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
Type Description
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
Name Description
values Iterable<String>

The column to add.

Returns
Type Description
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
Name Description
value String

The column to add.

Returns
Type Description
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
Name Description
value ByteString

The bytes of the column to add.

Returns
Type Description
ReadAction.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ReadAction build()
Returns
Type Description
ReadAction

buildPartial()

public ReadAction buildPartial()
Returns
Type Description
ReadAction

clear()

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearIndex()

public ReadAction.Builder clearIndex()

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

optional string index = 2;

Returns
Type Description
ReadAction.Builder

This builder for chaining.

clearKeys()

public ReadAction.Builder clearKeys()

Keys for performing this read.

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

Returns
Type Description
ReadAction.Builder

clearLimit()

public ReadAction.Builder clearLimit()

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

int32 limit = 5;

Returns
Type Description
ReadAction.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearTable()

public ReadAction.Builder clearTable()

The table to read at.

string table = 1;

Returns
Type Description
ReadAction.Builder

This builder for chaining.

clone()

public ReadAction.Builder clone()
Returns
Type Description
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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Name Description
index int

The index of the value to return.

Returns
Type Description
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
Type Description
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
Type Description
ProtocolStringList

A list containing the column.

getDefaultInstanceForType()

public ReadAction getDefaultInstanceForType()
Returns
Type Description
ReadAction

getDescriptorForType()

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

getIndex()

public String getIndex()

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

optional string index = 2;

Returns
Type Description
String

The index.

getIndexBytes()

public ByteString getIndexBytes()

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

optional string index = 2;

Returns
Type Description
ByteString

The bytes for index.

getKeys()

public KeySet getKeys()

Keys for performing this read.

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

Returns
Type Description
KeySet

The keys.

getKeysBuilder()

public KeySet.Builder getKeysBuilder()

Keys for performing this read.

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

Returns
Type Description
KeySet.Builder

getKeysOrBuilder()

public KeySetOrBuilder getKeysOrBuilder()

Keys for performing this read.

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

Returns
Type Description
KeySetOrBuilder

getLimit()

public int getLimit()

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

int32 limit = 5;

Returns
Type Description
int

The limit.

getTable()

public String getTable()

The table to read at.

string table = 1;

Returns
Type Description
String

The table.

getTableBytes()

public ByteString getTableBytes()

The table to read at.

string table = 1;

Returns
Type Description
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
Type Description
boolean

Whether the index field is set.

hasKeys()

public boolean hasKeys()

Keys for performing this read.

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

Returns
Type Description
boolean

Whether the keys field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ReadAction.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReadAction.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ReadAction.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ReadAction.Builder
Overrides

mergeFrom(ReadAction other)

public ReadAction.Builder mergeFrom(ReadAction other)
Parameter
Name Description
other ReadAction
Returns
Type Description
ReadAction.Builder

mergeKeys(KeySet value)

public ReadAction.Builder mergeKeys(KeySet value)

Keys for performing this read.

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

Parameter
Name Description
value KeySet
Returns
Type Description
ReadAction.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ReadAction.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
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
Name Description
index int

The index to set the value at.

value String

The column to set.

Returns
Type Description
ReadAction.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ReadAction.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
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
Name Description
value String

The index to set.

Returns
Type Description
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
Name Description
value ByteString

The bytes for index to set.

Returns
Type Description
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
Name Description
value KeySet
Returns
Type Description
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
Name Description
builderForValue KeySet.Builder
Returns
Type Description
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
Name Description
value int

The limit to set.

Returns
Type Description
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
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ReadAction.Builder
Overrides

setTable(String value)

public ReadAction.Builder setTable(String value)

The table to read at.

string table = 1;

Parameter
Name Description
value String

The table to set.

Returns
Type Description
ReadAction.Builder

This builder for chaining.

setTableBytes(ByteString value)

public ReadAction.Builder setTableBytes(ByteString value)

The table to read at.

string table = 1;

Parameter
Name Description
value ByteString

The bytes for table to set.

Returns
Type Description
ReadAction.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ReadAction.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ReadAction.Builder
Overrides