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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ReadRowsResponse.Builder newBuilder()
newBuilder(ReadRowsResponse prototype)
public static ReadRowsResponse.Builder newBuilder(ReadRowsResponse prototype)
public static ReadRowsResponse parseDelimitedFrom(InputStream input)
public static ReadRowsResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ReadRowsResponse parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ReadRowsResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ReadRowsResponse parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ReadRowsResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ReadRowsResponse parseFrom(CodedInputStream input)
public static ReadRowsResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ReadRowsResponse parseFrom(InputStream input)
public static ReadRowsResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ReadRowsResponse parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ReadRowsResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ReadRowsResponse> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getArrowRecordBatch()
public ArrowRecordBatch getArrowRecordBatch()
Serialized row data in Arrow RecordBatch format.
.google.cloud.bigquery.storage.v1.ArrowRecordBatch arrow_record_batch = 4;
getArrowRecordBatchOrBuilder()
public ArrowRecordBatchOrBuilder getArrowRecordBatchOrBuilder()
Serialized row data in Arrow RecordBatch format.
.google.cloud.bigquery.storage.v1.ArrowRecordBatch arrow_record_batch = 4;
getArrowSchema()
public ArrowSchema getArrowSchema()
Output only. Arrow schema.
.google.cloud.bigquery.storage.v1.ArrowSchema arrow_schema = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getArrowSchemaOrBuilder()
public ArrowSchemaOrBuilder getArrowSchemaOrBuilder()
Output only. Arrow schema.
.google.cloud.bigquery.storage.v1.ArrowSchema arrow_schema = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
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;
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];
getDefaultInstanceForType()
public ReadRowsResponse getDefaultInstanceForType()
getParserForType()
public Parser<ReadRowsResponse> getParserForType()
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()
getSchemaCase()
public ReadRowsResponse.SchemaCase getSchemaCase()
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;
getStatsOrBuilder()
public StreamStatsOrBuilder getStatsOrBuilder()
Statistics for the stream.
.google.cloud.bigquery.storage.v1.StreamStats stats = 2;
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;
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;
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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ReadRowsResponse.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ReadRowsResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ReadRowsResponse.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
