public sealed class ReadRowsResponse : IMessage<ReadRowsResponse>, IEquatable<ReadRowsResponse>, IDeepCloneable<ReadRowsResponse>, IBufferMessage, IMessageReference documentation and code samples for the Google BigQuery Storage v1 API class ReadRowsResponse.
Response from calling ReadRows may include row data, progress and
throttling information.
Implements
IMessageReadRowsResponse, IEquatableReadRowsResponse, IDeepCloneableReadRowsResponse, IBufferMessage, IMessageNamespace
Google.Cloud.BigQuery.Storage.V1Assembly
Google.Cloud.BigQuery.Storage.V1.dll
Constructors
ReadRowsResponse()
public ReadRowsResponse()ReadRowsResponse(ReadRowsResponse)
public ReadRowsResponse(ReadRowsResponse other)| Parameter | |
|---|---|
| Name | Description |
other |
ReadRowsResponse |
Properties
ArrowRecordBatch
public ArrowRecordBatch ArrowRecordBatch { get; set; }Serialized row data in Arrow RecordBatch format.
| Property Value | |
|---|---|
| Type | Description |
ArrowRecordBatch |
|
ArrowSchema
public ArrowSchema ArrowSchema { get; set; }Output only. Arrow schema.
| Property Value | |
|---|---|
| Type | Description |
ArrowSchema |
|
AvroRows
public AvroRows AvroRows { get; set; }Serialized row data in AVRO format.
| Property Value | |
|---|---|
| Type | Description |
AvroRows |
|
AvroSchema
public AvroSchema AvroSchema { get; set; }Output only. Avro schema.
| Property Value | |
|---|---|
| Type | Description |
AvroSchema |
|
HasUncompressedByteSize
public bool HasUncompressedByteSize { get; }Gets whether the "uncompressed_byte_size" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
RowCount
public long RowCount { get; set; }Number of serialized rows in the rows block.
| Property Value | |
|---|---|
| Type | Description |
long |
|
RowsCase
public ReadRowsResponse.RowsOneofCase RowsCase { get; }| Property Value | |
|---|---|
| Type | Description |
ReadRowsResponseRowsOneofCase |
|
SchemaCase
public ReadRowsResponse.SchemaOneofCase SchemaCase { get; }| Property Value | |
|---|---|
| Type | Description |
ReadRowsResponseSchemaOneofCase |
|
Stats
public StreamStats Stats { get; set; }Statistics for the stream.
| Property Value | |
|---|---|
| Type | Description |
StreamStats |
|
ThrottleState
public ThrottleState ThrottleState { get; set; }Throttling state. If unset, the latest response still describes the current throttling status.
| Property Value | |
|---|---|
| Type | Description |
ThrottleState |
|
UncompressedByteSize
public long UncompressedByteSize { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
long |
|