Package types

API documentation for bigquery_storage_v1.types package.

Classes

AppendRowsRequest

Request message for AppendRows.

Due to the nature of AppendRows being a bidirectional streaming RPC, certain parts of the AppendRowsRequest need only be specified for the first request sent each time the gRPC network connection is opened/reopened.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AppendRowsResponse

Response message for AppendRows.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ArrowRecordBatch

Arrow RecordBatch.

ArrowSchema

Arrow schema as specified in https://arrow.apache.org/docs/python/api/datatypes.html and serialized to bytes using IPC: https://arrow.apache.org/docs/format/Columnar.html#serialization-and-interprocess-communication-ipc See code samples on how this message can be deserialized.

ArrowSerializationOptions

Contains options specific to Arrow Serialization.

AvroRows

Avro rows.

AvroSchema

Avro schema.

BatchCommitWriteStreamsRequest

Request message for BatchCommitWriteStreams.

BatchCommitWriteStreamsResponse

Response message for BatchCommitWriteStreams.

CreateReadSessionRequest

Request message for CreateReadSession.

CreateWriteStreamRequest

Request message for CreateWriteStream.

DataFormat

Data format for input or output data.

FinalizeWriteStreamRequest

Request message for invoking FinalizeWriteStream.

FinalizeWriteStreamResponse

Response message for FinalizeWriteStream.

FlushRowsRequest

Request message for FlushRows.

FlushRowsResponse

Respond message for FlushRows.

GetWriteStreamRequest

Request message for GetWriteStreamRequest.

ProtoRows

ProtoSchema

ProtoSchema describes the schema of the serialized protocol buffer data rows.

ReadRowsRequest

Request message for ReadRows.

ReadRowsResponse

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

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ReadSession

Information about the ReadSession.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ReadStream

Information about a single stream that gets data out of the storage system. Most of the information about ReadStream instances is aggregated, making ReadStream lightweight.

SplitReadStreamRequest

Request message for SplitReadStream.

SplitReadStreamResponse

Response message for SplitReadStream.

StorageError

Structured custom BigQuery Storage error message. The error can be attached as error details in the returned rpc Status. In particular, the use of error codes allows more structured error handling, and reduces the need to evaluate unstructured error text strings.

StreamStats

Estimated stream statistics for a given read Stream.

TableFieldSchema

TableFieldSchema defines a single field/column within a table schema.

TableSchema

Schema of a table.

ThrottleState

Information on if the current connection is being throttled.

WriteStream

Information about a single stream that gets data inside the storage system.