Google BigQuery Storage v1 API - Class ReadRowsResponse (3.11.0)

public sealed class ReadRowsResponse : IMessage<ReadRowsResponse>, IEquatable<ReadRowsResponse>, IDeepCloneable<ReadRowsResponse>, IBufferMessage, IMessage

Reference 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.

Inheritance

object > ReadRowsResponse

Namespace

Google.Cloud.BigQuery.Storage.V1

Assembly

Google.Cloud.BigQuery.Storage.V1.dll

Constructors

ReadRowsResponse()

public ReadRowsResponse()

ReadRowsResponse(ReadRowsResponse)

public ReadRowsResponse(ReadRowsResponse other)
Parameter
NameDescription
otherReadRowsResponse

Properties

ArrowRecordBatch

public ArrowRecordBatch ArrowRecordBatch { get; set; }

Serialized row data in Arrow RecordBatch format.

Property Value
TypeDescription
ArrowRecordBatch

ArrowSchema

public ArrowSchema ArrowSchema { get; set; }

Output only. Arrow schema.

Property Value
TypeDescription
ArrowSchema

AvroRows

public AvroRows AvroRows { get; set; }

Serialized row data in AVRO format.

Property Value
TypeDescription
AvroRows

AvroSchema

public AvroSchema AvroSchema { get; set; }

Output only. Avro schema.

Property Value
TypeDescription
AvroSchema

HasUncompressedByteSize

public bool HasUncompressedByteSize { get; }

Gets whether the "uncompressed_byte_size" field is set

Property Value
TypeDescription
bool

RowCount

public long RowCount { get; set; }

Number of serialized rows in the rows block.

Property Value
TypeDescription
long

RowsCase

public ReadRowsResponse.RowsOneofCase RowsCase { get; }
Property Value
TypeDescription
ReadRowsResponseRowsOneofCase

SchemaCase

public ReadRowsResponse.SchemaOneofCase SchemaCase { get; }
Property Value
TypeDescription
ReadRowsResponseSchemaOneofCase

Stats

public StreamStats Stats { get; set; }

Statistics for the stream.

Property Value
TypeDescription
StreamStats

ThrottleState

public ThrottleState ThrottleState { get; set; }

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

Property Value
TypeDescription
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
TypeDescription
long