Class ReadResult.Builder (6.72.0)

public static final class ReadResult.Builder extends GeneratedMessageV3.Builder<ReadResult.Builder> implements ReadResultOrBuilder

ReadResult contains rows read.

Protobuf type google.spanner.executor.v1.ReadResult

Implements

ReadResultOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllRow(Iterable<? extends ValueList> values)

public ReadResult.Builder addAllRow(Iterable<? extends ValueList> values)

Rows read. Each row is a struct with multiple fields, one for each column in read result. All rows have the same type.

repeated .google.spanner.executor.v1.ValueList row = 4;

Parameter
Name Description
values Iterable<? extends com.google.spanner.executor.v1.ValueList>
Returns
Type Description
ReadResult.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addRow(ValueList value)

public ReadResult.Builder addRow(ValueList value)

Rows read. Each row is a struct with multiple fields, one for each column in read result. All rows have the same type.

repeated .google.spanner.executor.v1.ValueList row = 4;

Parameter
Name Description
value ValueList
Returns
Type Description
ReadResult.Builder

addRow(ValueList.Builder builderForValue)

public ReadResult.Builder addRow(ValueList.Builder builderForValue)

Rows read. Each row is a struct with multiple fields, one for each column in read result. All rows have the same type.

repeated .google.spanner.executor.v1.ValueList row = 4;

Parameter
Name Description
builderForValue ValueList.Builder
Returns
Type Description
ReadResult.Builder

addRow(int index, ValueList value)

public ReadResult.Builder addRow(int index, ValueList value)

Rows read. Each row is a struct with multiple fields, one for each column in read result. All rows have the same type.

repeated .google.spanner.executor.v1.ValueList row = 4;

Parameters
Name Description
index int
value ValueList
Returns
Type Description
ReadResult.Builder

addRow(int index, ValueList.Builder builderForValue)

public ReadResult.Builder addRow(int index, ValueList.Builder builderForValue)

Rows read. Each row is a struct with multiple fields, one for each column in read result. All rows have the same type.

repeated .google.spanner.executor.v1.ValueList row = 4;

Parameters
Name Description
index int
builderForValue ValueList.Builder
Returns
Type Description
ReadResult.Builder

addRowBuilder()

public ValueList.Builder addRowBuilder()

Rows read. Each row is a struct with multiple fields, one for each column in read result. All rows have the same type.

repeated .google.spanner.executor.v1.ValueList row = 4;

Returns
Type Description
ValueList.Builder

addRowBuilder(int index)

public ValueList.Builder addRowBuilder(int index)

Rows read. Each row is a struct with multiple fields, one for each column in read result. All rows have the same type.

repeated .google.spanner.executor.v1.ValueList row = 4;

Parameter
Name Description
index int
Returns
Type Description
ValueList.Builder

build()

public ReadResult build()
Returns
Type Description
ReadResult

buildPartial()

public ReadResult buildPartial()
Returns
Type Description
ReadResult

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearIndex()

public ReadResult.Builder clearIndex()

Index name, if read from an index.

optional string index = 2;

Returns
Type Description
ReadResult.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearRequestIndex()

public ReadResult.Builder clearRequestIndex()

Request index (multiread only).

optional int32 request_index = 3;

Returns
Type Description
ReadResult.Builder

This builder for chaining.

clearRow()

public ReadResult.Builder clearRow()

Rows read. Each row is a struct with multiple fields, one for each column in read result. All rows have the same type.

repeated .google.spanner.executor.v1.ValueList row = 4;

Returns
Type Description
ReadResult.Builder

clearRowType()

public ReadResult.Builder clearRowType()

The type of rows read. It must be set if at least one row was read.

optional .google.spanner.v1.StructType row_type = 5;

Returns
Type Description
ReadResult.Builder

clearTable()

public ReadResult.Builder clearTable()

Table name.

string table = 1;

Returns
Type Description
ReadResult.Builder

This builder for chaining.

clone()

public ReadResult.Builder clone()
Returns
Type Description
ReadResult.Builder
Overrides

getDefaultInstanceForType()

public ReadResult getDefaultInstanceForType()
Returns
Type Description
ReadResult

getDescriptorForType()

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

getIndex()

public String getIndex()

Index name, if read from an index.

optional string index = 2;

Returns
Type Description
String

The index.

getIndexBytes()

public ByteString getIndexBytes()

Index name, if read from an index.

optional string index = 2;

Returns
Type Description
ByteString

The bytes for index.

getRequestIndex()

public int getRequestIndex()

Request index (multiread only).

optional int32 request_index = 3;

Returns
Type Description
int

The requestIndex.

getRow(int index)

public ValueList getRow(int index)

Rows read. Each row is a struct with multiple fields, one for each column in read result. All rows have the same type.

repeated .google.spanner.executor.v1.ValueList row = 4;

Parameter
Name Description
index int
Returns
Type Description
ValueList

getRowBuilder(int index)

public ValueList.Builder getRowBuilder(int index)

Rows read. Each row is a struct with multiple fields, one for each column in read result. All rows have the same type.

repeated .google.spanner.executor.v1.ValueList row = 4;

Parameter
Name Description
index int
Returns
Type Description
ValueList.Builder

getRowBuilderList()

public List<ValueList.Builder> getRowBuilderList()

Rows read. Each row is a struct with multiple fields, one for each column in read result. All rows have the same type.

repeated .google.spanner.executor.v1.ValueList row = 4;

Returns
Type Description
List<Builder>

getRowCount()

public int getRowCount()

Rows read. Each row is a struct with multiple fields, one for each column in read result. All rows have the same type.

repeated .google.spanner.executor.v1.ValueList row = 4;

Returns
Type Description
int

getRowList()

public List<ValueList> getRowList()

Rows read. Each row is a struct with multiple fields, one for each column in read result. All rows have the same type.

repeated .google.spanner.executor.v1.ValueList row = 4;

Returns
Type Description
List<ValueList>

getRowOrBuilder(int index)

public ValueListOrBuilder getRowOrBuilder(int index)

Rows read. Each row is a struct with multiple fields, one for each column in read result. All rows have the same type.

repeated .google.spanner.executor.v1.ValueList row = 4;

Parameter
Name Description
index int
Returns
Type Description
ValueListOrBuilder

getRowOrBuilderList()

public List<? extends ValueListOrBuilder> getRowOrBuilderList()

Rows read. Each row is a struct with multiple fields, one for each column in read result. All rows have the same type.

repeated .google.spanner.executor.v1.ValueList row = 4;

Returns
Type Description
List<? extends com.google.spanner.executor.v1.ValueListOrBuilder>

getRowType()

public StructType getRowType()

The type of rows read. It must be set if at least one row was read.

optional .google.spanner.v1.StructType row_type = 5;

Returns
Type Description
StructType

The rowType.

getRowTypeBuilder()

public StructType.Builder getRowTypeBuilder()

The type of rows read. It must be set if at least one row was read.

optional .google.spanner.v1.StructType row_type = 5;

Returns
Type Description
StructType.Builder

getRowTypeOrBuilder()

public StructTypeOrBuilder getRowTypeOrBuilder()

The type of rows read. It must be set if at least one row was read.

optional .google.spanner.v1.StructType row_type = 5;

Returns
Type Description
StructTypeOrBuilder

getTable()

public String getTable()

Table name.

string table = 1;

Returns
Type Description
String

The table.

getTableBytes()

public ByteString getTableBytes()

Table name.

string table = 1;

Returns
Type Description
ByteString

The bytes for table.

hasIndex()

public boolean hasIndex()

Index name, if read from an index.

optional string index = 2;

Returns
Type Description
boolean

Whether the index field is set.

hasRequestIndex()

public boolean hasRequestIndex()

Request index (multiread only).

optional int32 request_index = 3;

Returns
Type Description
boolean

Whether the requestIndex field is set.

hasRowType()

public boolean hasRowType()

The type of rows read. It must be set if at least one row was read.

optional .google.spanner.v1.StructType row_type = 5;

Returns
Type Description
boolean

Whether the rowType 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 ReadResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReadResult.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

mergeFrom(ReadResult other)

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

mergeRowType(StructType value)

public ReadResult.Builder mergeRowType(StructType value)

The type of rows read. It must be set if at least one row was read.

optional .google.spanner.v1.StructType row_type = 5;

Parameter
Name Description
value StructType
Returns
Type Description
ReadResult.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ReadResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ReadResult.Builder
Overrides

removeRow(int index)

public ReadResult.Builder removeRow(int index)

Rows read. Each row is a struct with multiple fields, one for each column in read result. All rows have the same type.

repeated .google.spanner.executor.v1.ValueList row = 4;

Parameter
Name Description
index int
Returns
Type Description
ReadResult.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setIndex(String value)

public ReadResult.Builder setIndex(String value)

Index name, if read from an index.

optional string index = 2;

Parameter
Name Description
value String

The index to set.

Returns
Type Description
ReadResult.Builder

This builder for chaining.

setIndexBytes(ByteString value)

public ReadResult.Builder setIndexBytes(ByteString value)

Index name, if read from an index.

optional string index = 2;

Parameter
Name Description
value ByteString

The bytes for index to set.

Returns
Type Description
ReadResult.Builder

This builder for chaining.

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

public ReadResult.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ReadResult.Builder
Overrides

setRequestIndex(int value)

public ReadResult.Builder setRequestIndex(int value)

Request index (multiread only).

optional int32 request_index = 3;

Parameter
Name Description
value int

The requestIndex to set.

Returns
Type Description
ReadResult.Builder

This builder for chaining.

setRow(int index, ValueList value)

public ReadResult.Builder setRow(int index, ValueList value)

Rows read. Each row is a struct with multiple fields, one for each column in read result. All rows have the same type.

repeated .google.spanner.executor.v1.ValueList row = 4;

Parameters
Name Description
index int
value ValueList
Returns
Type Description
ReadResult.Builder

setRow(int index, ValueList.Builder builderForValue)

public ReadResult.Builder setRow(int index, ValueList.Builder builderForValue)

Rows read. Each row is a struct with multiple fields, one for each column in read result. All rows have the same type.

repeated .google.spanner.executor.v1.ValueList row = 4;

Parameters
Name Description
index int
builderForValue ValueList.Builder
Returns
Type Description
ReadResult.Builder

setRowType(StructType value)

public ReadResult.Builder setRowType(StructType value)

The type of rows read. It must be set if at least one row was read.

optional .google.spanner.v1.StructType row_type = 5;

Parameter
Name Description
value StructType
Returns
Type Description
ReadResult.Builder

setRowType(StructType.Builder builderForValue)

public ReadResult.Builder setRowType(StructType.Builder builderForValue)

The type of rows read. It must be set if at least one row was read.

optional .google.spanner.v1.StructType row_type = 5;

Parameter
Name Description
builderForValue StructType.Builder
Returns
Type Description
ReadResult.Builder

setTable(String value)

public ReadResult.Builder setTable(String value)

Table name.

string table = 1;

Parameter
Name Description
value String

The table to set.

Returns
Type Description
ReadResult.Builder

This builder for chaining.

setTableBytes(ByteString value)

public ReadResult.Builder setTableBytes(ByteString value)

Table name.

string table = 1;

Parameter
Name Description
value ByteString

The bytes for table to set.

Returns
Type Description
ReadResult.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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