Class ReadResult (6.65.1)

public final class ReadResult extends GeneratedMessageV3 implements ReadResultOrBuilder

ReadResult contains rows read.

Protobuf type google.spanner.executor.v1.ReadResult

Implements

ReadResultOrBuilder

Static Fields

INDEX_FIELD_NUMBER

public static final int INDEX_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_INDEX_FIELD_NUMBER

public static final int REQUEST_INDEX_FIELD_NUMBER
Field Value
Type Description
int

ROW_FIELD_NUMBER

public static final int ROW_FIELD_NUMBER
Field Value
Type Description
int

ROW_TYPE_FIELD_NUMBER

public static final int ROW_TYPE_FIELD_NUMBER
Field Value
Type Description
int

TABLE_FIELD_NUMBER

public static final int TABLE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ReadResult getDefaultInstance()
Returns
Type Description
ReadResult

getDescriptor()

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

newBuilder()

public static ReadResult.Builder newBuilder()
Returns
Type Description
ReadResult.Builder

newBuilder(ReadResult prototype)

public static ReadResult.Builder newBuilder(ReadResult prototype)
Parameter
Name Description
prototype ReadResult
Returns
Type Description
ReadResult.Builder

parseDelimitedFrom(InputStream input)

public static ReadResult parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ReadResult
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReadResult
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ReadResult parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ReadResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ReadResult parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReadResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ReadResult parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ReadResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ReadResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReadResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ReadResult parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ReadResult
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReadResult
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ReadResult parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ReadResult
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReadResult
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ReadResult parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ReadResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ReadResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReadResult
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ReadResult> parser()
Returns
Type Description
Parser<ReadResult>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ReadResult getDefaultInstanceForType()
Returns
Type Description
ReadResult

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.

getParserForType()

public Parser<ReadResult> getParserForType()
Returns
Type Description
Parser<ReadResult>
Overrides

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

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ReadResult.Builder newBuilderForType()
Returns
Type Description
ReadResult.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ReadResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ReadResult.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ReadResult.Builder toBuilder()
Returns
Type Description
ReadResult.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException