Classes
AnnotationsExtensions
Holder for extension identifiers generated from the top level of google/cloud/bigquery/storage/v1/annotations.proto
AppendRowsRequest
Request message for AppendRows
.
Because AppendRows is a bidirectional streaming RPC, certain parts of the AppendRowsRequest need only be specified for the first request before switching table destinations. You can also switch table destinations within the same connection for the default stream.
The size of a single AppendRowsRequest must be less than 10 MB in size.
Requests larger than this return an error, typically INVALID_ARGUMENT
.
AppendRowsRequest.Types
Container for nested types declared in the AppendRowsRequest message type.
AppendRowsRequest.Types.ProtoData
ProtoData contains the data rows and schema when constructing append requests.
AppendRowsResponse
Response message for AppendRows
.
AppendRowsResponse.Types
Container for nested types declared in the AppendRowsResponse message type.
AppendRowsResponse.Types.AppendResult
AppendResult is returned for successful append requests.
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.
ArrowSerializationOptions.Types
Container for nested types declared in the ArrowSerializationOptions message type.
AvroRows
Avro rows.
AvroSchema
Avro schema.
AvroSerializationOptions
Contains options specific to Avro Serialization.
BatchCommitWriteStreamsRequest
Request message for BatchCommitWriteStreams
.
BatchCommitWriteStreamsResponse
Response message for BatchCommitWriteStreams
.
BigQueryRead
BigQuery Read API.
The Read API can be used to read data from BigQuery.
BigQueryRead.BigQueryReadBase
Base class for server-side implementations of BigQueryRead
BigQueryRead.BigQueryReadClient
Client for BigQueryRead
BigQueryReadClient
BigQueryRead client wrapper, for convenient use.
BigQueryReadClient.ReadRowsStream
Server streaming methods for ReadRows(ReadRowsRequest, CallSettings).
BigQueryReadClientBuilder
Builder class for BigQueryReadClient to provide simple configuration of credentials, endpoint etc.
BigQueryReadClientImpl
BigQueryRead client wrapper implementation, for convenient use.
BigQueryReadSettings
Settings for BigQueryReadClient instances.
BigQueryWrite
BigQuery Write API.
The Write API can be used to write data to BigQuery.
For supplementary information about the Write API, see: https://cloud.google.com/bigquery/docs/write-api
BigQueryWrite.BigQueryWriteBase
Base class for server-side implementations of BigQueryWrite
BigQueryWrite.BigQueryWriteClient
Client for BigQueryWrite
BigQueryWriteClient
BigQueryWrite client wrapper, for convenient use.
BigQueryWriteClient.AppendRowsStream
Bidirectional streaming methods for AppendRows(CallSettings, BidirectionalStreamingSettings).
BigQueryWriteClientBuilder
Builder class for BigQueryWriteClient to provide simple configuration of credentials, endpoint etc.
BigQueryWriteClientImpl
BigQueryWrite client wrapper implementation, for convenient use.
BigQueryWriteSettings
Settings for BigQueryWriteClient instances.
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.
ReadSession.Types
Container for nested types declared in the ReadSession message type.
ReadSession.Types.TableModifiers
Additional attributes when reading a table.
ReadSession.Types.TableReadOptions
Options dictating how we read a table.
ReadSession.Types.TableReadOptions.Types
Container for nested types declared in the TableReadOptions message type.
ReadSessionName
Resource name for the ReadSession
resource.
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.
ReadStreamName
Resource name for the ReadStream
resource.
RowError
The message that presents row level error info in a request.
RowError.Types
Container for nested types declared in the RowError message type.
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.
StorageError.Types
Container for nested types declared in the StorageError message type.
StreamStats
Estimated stream statistics for a given read Stream.
StreamStats.Types
Container for nested types declared in the StreamStats message type.
StreamStats.Types.Progress
TableFieldSchema
TableFieldSchema defines a single field/column within a table schema.
TableFieldSchema.Types
Container for nested types declared in the TableFieldSchema message type.
TableFieldSchema.Types.FieldElementType
Represents the type of a field element.
TableName
Resource name for the Table
resource.
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.
WriteStream.Types
Container for nested types declared in the WriteStream message type.
WriteStreamName
Resource name for the WriteStream
resource.
Enums
AppendRowsRequest.RowsOneofCase
Enum of possible cases for the "rows" oneof.
AppendRowsRequest.Types.MissingValueInterpretation
An enum to indicate how to interpret missing values of fields that are present in user schema but missing in rows. A missing value can represent a NULL or a column default value defined in BigQuery table schema.
AppendRowsResponse.ResponseOneofCase
Enum of possible cases for the "response" oneof.
ArrowSerializationOptions.Types.CompressionCodec
Compression codec's supported by Arrow.
DataFormat
Data format for input or output data.
ReadRowsResponse.RowsOneofCase
Enum of possible cases for the "rows" oneof.
ReadRowsResponse.SchemaOneofCase
Enum of possible cases for the "schema" oneof.
ReadSession.SchemaOneofCase
Enum of possible cases for the "schema" oneof.
ReadSession.Types.TableReadOptions.OutputFormatSerializationOptionsOneofCase
Enum of possible cases for the "output_format_serialization_options" oneof.
ReadSession.Types.TableReadOptions.Types.ResponseCompressionCodec
Specifies which compression codec to attempt on the entire serialized response payload (either Arrow record batch or Avro rows). This is not to be confused with the Apache Arrow native compression codecs specified in ArrowSerializationOptions. For performance reasons, when creating a read session requesting Arrow responses, setting both native Arrow compression and application-level response compression will not be allowed - choose, at most, one kind of compression.
ReadSessionName.ResourceNameType
The possible contents of ReadSessionName.
ReadStreamName.ResourceNameType
The possible contents of ReadStreamName.
RowError.Types.RowErrorCode
Error code for RowError
.
StorageError.Types.StorageErrorCode
Error code for StorageError
.
TableFieldSchema.Types.Mode
TableFieldSchema.Types.Type
TableName.ResourceNameType
The possible contents of TableName.
WriteStream.Types.Type
Type enum of the stream.
WriteStream.Types.WriteMode
Mode enum of the stream.
WriteStreamName.ResourceNameType
The possible contents of WriteStreamName.
WriteStreamView
WriteStreamView is a view enum that controls what details about a write stream should be returned.