Class ReadRowsResponse (3.9.3) 

public final class ReadRowsResponse extends GeneratedMessageV3 implements ReadRowsResponseOrBuilder

Response from calling ReadRows may include row data, progress and throttling information.

Protobuf type google.cloud.bigquery.storage.v1.ReadRowsResponse

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ReadRowsResponse

Static Fields

ARROW_RECORD_BATCH_FIELD_NUMBER

public static final int ARROW_RECORD_BATCH_FIELD_NUMBER
Field Value
Type Description
int

ARROW_SCHEMA_FIELD_NUMBER

public static final int ARROW_SCHEMA_FIELD_NUMBER
Field Value
Type Description
int

AVRO_ROWS_FIELD_NUMBER

public static final int AVRO_ROWS_FIELD_NUMBER
Field Value
Type Description
int

AVRO_SCHEMA_FIELD_NUMBER

public static final int AVRO_SCHEMA_FIELD_NUMBER
Field Value
Type Description
int

ROW_COUNT_FIELD_NUMBER

public static final int ROW_COUNT_FIELD_NUMBER
Field Value
Type Description
int

STATS_FIELD_NUMBER

public static final int STATS_FIELD_NUMBER
Field Value
Type Description
int

THROTTLE_STATE_FIELD_NUMBER

public static final int THROTTLE_STATE_FIELD_NUMBER
Field Value
Type Description
int

UNCOMPRESSED_BYTE_SIZE_FIELD_NUMBER

public static final int UNCOMPRESSED_BYTE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ReadRowsResponse getDefaultInstance()
Returns
Type Description
ReadRowsResponse

getDescriptor()

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

newBuilder()

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

newBuilder(ReadRowsResponse prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getArrowRecordBatch()

public ArrowRecordBatch getArrowRecordBatch()

Serialized row data in Arrow RecordBatch format.

.google.cloud.bigquery.storage.v1.ArrowRecordBatch arrow_record_batch = 4;

Returns
Type Description
ArrowRecordBatch

The arrowRecordBatch.

getArrowRecordBatchOrBuilder()

public ArrowRecordBatchOrBuilder getArrowRecordBatchOrBuilder()

Serialized row data in Arrow RecordBatch format.

.google.cloud.bigquery.storage.v1.ArrowRecordBatch arrow_record_batch = 4;

Returns
Type Description
ArrowRecordBatchOrBuilder

getArrowSchema()

public ArrowSchema getArrowSchema()

Output only. Arrow schema.

.google.cloud.bigquery.storage.v1.ArrowSchema arrow_schema = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ArrowSchema

The arrowSchema.

getArrowSchemaOrBuilder()

public ArrowSchemaOrBuilder getArrowSchemaOrBuilder()

Output only. Arrow schema.

.google.cloud.bigquery.storage.v1.ArrowSchema arrow_schema = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ArrowSchemaOrBuilder

getAvroRows()

public AvroRows getAvroRows()

Serialized row data in AVRO format.

.google.cloud.bigquery.storage.v1.AvroRows avro_rows = 3;

Returns
Type Description
AvroRows

The avroRows.

getAvroRowsOrBuilder()

public AvroRowsOrBuilder getAvroRowsOrBuilder()

Serialized row data in AVRO format.

.google.cloud.bigquery.storage.v1.AvroRows avro_rows = 3;

Returns
Type Description
AvroRowsOrBuilder

getAvroSchema()

public AvroSchema getAvroSchema()

Output only. Avro schema.

.google.cloud.bigquery.storage.v1.AvroSchema avro_schema = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AvroSchema

The avroSchema.

getAvroSchemaOrBuilder()

public AvroSchemaOrBuilder getAvroSchemaOrBuilder()

Output only. Avro schema.

.google.cloud.bigquery.storage.v1.AvroSchema avro_schema = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AvroSchemaOrBuilder

getDefaultInstanceForType()

public ReadRowsResponse getDefaultInstanceForType()
Returns
Type Description
ReadRowsResponse

getParserForType()

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

getRowCount()

public long getRowCount()

Number of serialized rows in the rows block.

int64 row_count = 6;

Returns
Type Description
long

The rowCount.

getRowsCase()

public ReadRowsResponse.RowsCase getRowsCase()
Returns
Type Description
ReadRowsResponse.RowsCase

getSchemaCase()

public ReadRowsResponse.SchemaCase getSchemaCase()
Returns
Type Description
ReadRowsResponse.SchemaCase

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStats()

public StreamStats getStats()

Statistics for the stream.

.google.cloud.bigquery.storage.v1.StreamStats stats = 2;

Returns
Type Description
StreamStats

The stats.

getStatsOrBuilder()

public StreamStatsOrBuilder getStatsOrBuilder()

Statistics for the stream.

.google.cloud.bigquery.storage.v1.StreamStats stats = 2;

Returns
Type Description
StreamStatsOrBuilder

getThrottleState()

public ThrottleState getThrottleState()

Throttling state. If unset, the latest response still describes the current throttling status.

.google.cloud.bigquery.storage.v1.ThrottleState throttle_state = 5;

Returns
Type Description
ThrottleState

The throttleState.

getThrottleStateOrBuilder()

public ThrottleStateOrBuilder getThrottleStateOrBuilder()

Throttling state. If unset, the latest response still describes the current throttling status.

.google.cloud.bigquery.storage.v1.ThrottleState throttle_state = 5;

Returns
Type Description
ThrottleStateOrBuilder

getUncompressedByteSize()

public long getUncompressedByteSize()

Optional. If the row data in this ReadRowsResponse is compressed, then uncompressed byte size is the original size of the uncompressed row data. If it is set to a value greater than 0, then decompress into a buffer of size uncompressed_byte_size using the compression codec that was requested during session creation time and which is specified in TableReadOptions.response_compression_codec in ReadSession. This value is not set if no response_compression_codec was not requested and it is -1 if the requested compression would not have reduced the size of this ReadRowsResponse's row data. This attempts to match Apache Arrow's behavior described here https://github.com/apache/arrow/issues/15102 where the uncompressed length may be set to -1 to indicate that the data that follows is not compressed, which can be useful for cases where compression does not yield appreciable savings. When uncompressed_byte_size is not greater than 0, the client should skip decompression.

optional int64 uncompressed_byte_size = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The uncompressedByteSize.

hasArrowRecordBatch()

public boolean hasArrowRecordBatch()

Serialized row data in Arrow RecordBatch format.

.google.cloud.bigquery.storage.v1.ArrowRecordBatch arrow_record_batch = 4;

Returns
Type Description
boolean

Whether the arrowRecordBatch field is set.

hasArrowSchema()

public boolean hasArrowSchema()

Output only. Arrow schema.

.google.cloud.bigquery.storage.v1.ArrowSchema arrow_schema = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the arrowSchema field is set.

hasAvroRows()

public boolean hasAvroRows()

Serialized row data in AVRO format.

.google.cloud.bigquery.storage.v1.AvroRows avro_rows = 3;

Returns
Type Description
boolean

Whether the avroRows field is set.

hasAvroSchema()

public boolean hasAvroSchema()

Output only. Avro schema.

.google.cloud.bigquery.storage.v1.AvroSchema avro_schema = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the avroSchema field is set.

hasStats()

public boolean hasStats()

Statistics for the stream.

.google.cloud.bigquery.storage.v1.StreamStats stats = 2;

Returns
Type Description
boolean

Whether the stats field is set.

hasThrottleState()

public boolean hasThrottleState()

Throttling state. If unset, the latest response still describes the current throttling status.

.google.cloud.bigquery.storage.v1.ThrottleState throttle_state = 5;

Returns
Type Description
boolean

Whether the throttleState field is set.

hasUncompressedByteSize()

public boolean hasUncompressedByteSize()

Optional. If the row data in this ReadRowsResponse is compressed, then uncompressed byte size is the original size of the uncompressed row data. If it is set to a value greater than 0, then decompress into a buffer of size uncompressed_byte_size using the compression codec that was requested during session creation time and which is specified in TableReadOptions.response_compression_codec in ReadSession. This value is not set if no response_compression_codec was not requested and it is -1 if the requested compression would not have reduced the size of this ReadRowsResponse's row data. This attempts to match Apache Arrow's behavior described here https://github.com/apache/arrow/issues/15102 where the uncompressed length may be set to -1 to indicate that the data that follows is not compressed, which can be useful for cases where compression does not yield appreciable savings. When uncompressed_byte_size is not greater than 0, the client should skip decompression.

optional int64 uncompressed_byte_size = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the uncompressedByteSize 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 ReadRowsResponse.Builder newBuilderForType()
Returns
Type Description
ReadRowsResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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