public interface ReadRowsResponseOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getArrowRecordBatch()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract AvroRowsOrBuilder getAvroRowsOrBuilder()
Serialized row data in AVRO format.
.google.cloud.bigquery.storage.v1.AvroRows avro_rows = 3;
Returns | |
---|---|
Type | Description |
AvroRowsOrBuilder |
getAvroSchema()
public abstract 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 abstract 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 |
getRowCount()
public abstract long getRowCount()
Number of serialized rows in the rows block.
int64 row_count = 6;
Returns | |
---|---|
Type | Description |
long |
The rowCount. |
getRowsCase()
public abstract ReadRowsResponse.RowsCase getRowsCase()
Returns | |
---|---|
Type | Description |
ReadRowsResponse.RowsCase |
getSchemaCase()
public abstract ReadRowsResponse.SchemaCase getSchemaCase()
Returns | |
---|---|
Type | Description |
ReadRowsResponse.SchemaCase |
getStats()
public abstract StreamStats getStats()
Statistics for the stream.
.google.cloud.bigquery.storage.v1.StreamStats stats = 2;
Returns | |
---|---|
Type | Description |
StreamStats |
The stats. |
getStatsOrBuilder()
public abstract StreamStatsOrBuilder getStatsOrBuilder()
Statistics for the stream.
.google.cloud.bigquery.storage.v1.StreamStats stats = 2;
Returns | |
---|---|
Type | Description |
StreamStatsOrBuilder |
getThrottleState()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |