Skip to main content

Module model

Module model 

Source
Expand description

The messages and enums that are part of this client library.

Modules§

append_rows_request
Defines additional types related to AppendRowsRequest.
append_rows_response
Defines additional types related to AppendRowsResponse.
arrow_serialization_options
Defines additional types related to ArrowSerializationOptions.
avro_serialization_options
Defines additional types related to AvroSerializationOptions.
client_stats
Defines additional types related to ClientStats.
read_rows_request
Defines additional types related to ReadRowsRequest.
read_rows_response
Defines additional types related to ReadRowsResponse.
read_session
Defines additional types related to ReadSession.
row_error
Defines additional types related to RowError.
storage_error
Defines additional types related to StorageError.
stream_stats
Defines additional types related to StreamStats.
table_field_schema
Defines additional types related to TableFieldSchema.
write_stream
Defines additional types related to WriteStream.

Structs§

AppendRowsRequest
Request message for AppendRows.
AppendRowsResponse
Response message for AppendRows.
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
ArrowSerializationOptions
Contains options specific to Arrow Serialization.
AvroRows
Avro rows.
AvroSchema
Avro schema.
AvroSerializationOptions
Contains options specific to Avro Serialization.
BatchCommitWriteStreamsRequest
Request message for BatchCommitWriteStreams.
BatchCommitWriteStreamsResponse
Response message for BatchCommitWriteStreams.
ClientStats
Stats and telemetry data gathered on the client side about requests being sent to the BigQuery Storage service, for internal use only.
CreateReadSessionRequest
Request message for CreateReadSession.
CreateWriteStreamRequest
Request message for CreateWriteStream.
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.
ReadSession
Information about the ReadSession.
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.
RowError
The message that presents row level error info in a request.
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. This schema is a subset of google.cloud.bigquery.v2.TableSchema containing information necessary to generate valid message to write to BigQuery.
ThrottleState
Information on if the current connection is being throttled.
WriteStream
Information about a single stream that gets data inside the storage system.

Enums§

DataFormat
Data format for input or output data.
WriteStreamView
WriteStreamView is a view enum that controls what details about a write stream should be returned.