API documentation for bigquery_storage_v1beta2.types package.
Classes
AppendRowsRequest
Request message for AppendRows.
.. attribute:: write_stream
Required. The stream that is the target of the append
operation. This value must be specified for the initial
request. If subsequent requests specify the stream name, it
must equal to the value provided in the first request. To
write to the _default stream, populate this field with a
string in the format
projects/{project}/datasets/{dataset}/tables/{table}/_default.
:type: str
AppendRowsResponse
Response message for AppendRows.
.. attribute:: append_result
Result if the append is successful.
:type: google.cloud.bigquery_storage_v1beta2.types.AppendRowsResponse.AppendResult
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
BatchCommitWriteStreamsRequest
Request message for BatchCommitWriteStreams.
.. attribute:: parent
Required. Parent table that all the streams should belong
to, in the form of
projects/{project}/datasets/{dataset}/tables/{table}.
:type: str
BatchCommitWriteStreamsResponse
Response message for BatchCommitWriteStreams.
.. attribute:: commit_time
The time at which streams were committed in microseconds granularity. This field will only exist when there are no stream errors. Note if this field is not set, it means the commit was not successful.
:type: google.protobuf.timestamp_pb2.Timestamp
CreateReadSessionRequest
Request message for CreateReadSession.
.. attribute:: parent
Required. The request project that owns the session, in the
form of projects/{project_id}.
:type: str
CreateWriteStreamRequest
Request message for CreateWriteStream.
.. attribute:: parent
Required. Reference to the table to which the stream
belongs, in the format of
projects/{project}/datasets/{dataset}/tables/{table}.
:type: str
DataFormat
Data format for input or output data.
FinalizeWriteStreamRequest
Request message for invoking FinalizeWriteStream.
.. attribute:: name
Required. Name of the stream to finalize, in the form of
projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}.
:type: str
FinalizeWriteStreamResponse
Response message for FinalizeWriteStream.
.. attribute:: row_count
Number of rows in the finalized stream.
:type: int
FlushRowsRequest
Request message for FlushRows.
.. attribute:: write_stream
Required. The stream that is the target of the flush operation.
:type: str
FlushRowsResponse
Respond message for FlushRows.
.. attribute:: offset
The rows before this offset (including this offset) are flushed.
:type: int
GetWriteStreamRequest
Request message for GetWriteStreamRequest.
.. attribute:: name
Required. Name of the stream to get, in the form of
projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}.
:type: str
ProtoRows
ProtoSchema
ProtoSchema describes the schema of the serialized protocol buffer data rows.
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
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 Stream. .. attribute:: progress
Represents the progress of the current stream.
:type: google.cloud.bigquery_storage_v1beta2.types.StreamStats.Progress
TableFieldSchema
A field in TableSchema .. attribute:: name
Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
:type: str
TableSchema
Schema of a table .. attribute:: fields
Describes the fields in a table.
:type: Sequence[google.cloud.bigquery_storage_v1beta2.types.TableFieldSchema]
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
WriteStream
Information about a single stream that gets data inside the storage system.