API documentation for bigquery_storage_v1.types package.
Classes
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. .. attribute:: serialized_binary_rows
Binary serialized rows in a block.
:type: bytes
AvroSchema
Avro schema. .. attribute:: schema
Json serialized schema, as described at https://avro.apache.org/docs/1.8.1/spec.html.
:type: str
CreateReadSessionRequest
Request message for CreateReadSession.
.. attribute:: parent
Required. The request project that owns the session, in the
form of projects/{project_id}.
:type: str
DataFormat
Data format for input or output data.
ReadRowsRequest
Request message for ReadRows.
.. attribute:: read_stream
Required. Stream to read rows from.
:type: str
ReadRowsResponse
Response from calling ReadRows may include row data, progress
and throttling information.
ReadSession
Information about the ReadSession. .. attribute:: name
Output only. Unique identifier for the session, in the form
projects/{project_id}/locations/{location}/sessions/{session_id}.
:type: str
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.
.. attribute:: name
Required. Name of the stream to split.
:type: str
SplitReadStreamResponse
Response message for SplitReadStream.
.. attribute:: primary_stream
Primary stream, which contains the beginning portion of |original_stream|. An empty value indicates that the original stream can no longer be split.
StreamStats
Estimated stream statistics for a given Stream. .. attribute:: progress
Represents the progress of the current stream.
:type: google.cloud.bigquery_storage_v1.types.StreamStats.Progress
ThrottleState
Information on if the current connection is being throttled. .. attribute:: throttle_percent
How much this connection is being throttled. Zero means no throttling, 100 means fully throttled.
:type: int