API documentation for bigquery_storage_v1beta2.types module.
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.
AvroSchema
Avro schema.
CreateReadSessionRequest
Request message for CreateReadSession.
Required. Session to be created.
ReadRowsRequest
Request message for ReadRows.
The offset requested must be less than the last row read from Read. Requesting a larger offset is undefined. If not specified, start reading from offset zero.
ReadRowsResponse
Response from calling ReadRows may include row data, progress and
throttling information.
Serialized row data in AVRO format.
Number of serialized rows in the rows block.
Throttling state. If unset, the latest response still describes the current throttling status.
ReadSession
Information about the ReadSession.
Output only. Time at which the session becomes invalid. After this time, subsequent requests to read this Session will return errors. The expire_time is automatically assigned and currently cannot be specified or updated.
The schema for the read. If read_options.selected_fields is set, the schema may be different from the table schema as it will only contain the selected fields.
Output only. Arrow schema.
Optional. Any modifiers which are applied when reading from the specified table.
Output only. A list of streams created with the session. At least one stream is created with the session. In the future, larger request_stream_count values may result in this list being unpopulated, in that case, the user will need to use a List method to get the streams instead, which is not yet available.
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.
A value in the range (0.0, 1.0) that specifies the fractional point at which the original stream should be split. The actual split point is evaluated on pre-filtered rows, so if a filter is provided, then there is no guarantee that the division of the rows between the new child streams will be proportional to this fractional value. Additionally, because the server-side unit for assigning data is collections of rows, this fraction will always map to a data storage boundary on the server side.
SplitReadStreamResponse
Response message for SplitReadStream.
Remainder stream, which contains the tail of |original_stream|. An empty value indicates that the original stream can no longer be split.
StreamStats
Estimated stream statistics for a given Stream.
ThrottleState
Information on if the current connection is being throttled.
Timestamp
API documentation for bigquery_storage_v1beta2.types.Timestamp class.