The interfaces provided are listed below, along with usage samples.
BaseBigQueryReadClient
Service Description: BigQuery Read API.
The Read API can be used to read data from BigQuery.
New code should use the v1 Read API going forward, if they don't use Write API at the same time.
Sample for BaseBigQueryReadClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigQueryReadClient baseBigQueryReadClient = BaseBigQueryReadClient.create()) {
ProjectName parent = ProjectName.of("[PROJECT]");
ReadSession readSession = ReadSession.newBuilder().build();
int maxStreamCount = 940837515;
ReadSession response =
baseBigQueryReadClient.createReadSession(parent, readSession, maxStreamCount);
}
BigQueryWriteClient
Service Description: BigQuery Write API.
The Write API can be used to write data to BigQuery.
Sample for BigQueryWriteClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BigQueryWriteClient bigQueryWriteClient = BigQueryWriteClient.create()) {
TableName parent = TableName.of("[PROJECT]", "[DATASET]", "[TABLE]");
WriteStream writeStream = WriteStream.newBuilder().build();
WriteStream response = bigQueryWriteClient.createWriteStream(parent, writeStream);
}
Classes
AppendRowsRequest
Request message for AppendRows.
Protobuf type google.cloud.bigquery.storage.v1beta2.AppendRowsRequest
AppendRowsRequest.Builder
Request message for AppendRows.
Protobuf type google.cloud.bigquery.storage.v1beta2.AppendRowsRequest
AppendRowsRequest.ProtoData
Proto schema and data.
Protobuf type google.cloud.bigquery.storage.v1beta2.AppendRowsRequest.ProtoData
AppendRowsRequest.ProtoData.Builder
Proto schema and data.
Protobuf type google.cloud.bigquery.storage.v1beta2.AppendRowsRequest.ProtoData
AppendRowsResponse
Response message for AppendRows.
Protobuf type google.cloud.bigquery.storage.v1beta2.AppendRowsResponse
AppendRowsResponse.AppendResult
AppendResult is returned for successful append requests.
Protobuf type google.cloud.bigquery.storage.v1beta2.AppendRowsResponse.AppendResult
AppendRowsResponse.AppendResult.Builder
AppendResult is returned for successful append requests.
Protobuf type google.cloud.bigquery.storage.v1beta2.AppendRowsResponse.AppendResult
AppendRowsResponse.Builder
Response message for AppendRows.
Protobuf type google.cloud.bigquery.storage.v1beta2.AppendRowsResponse
ArrowProto
ArrowRecordBatch
Arrow RecordBatch.
Protobuf type google.cloud.bigquery.storage.v1beta2.ArrowRecordBatch
ArrowRecordBatch.Builder
Arrow RecordBatch.
Protobuf type google.cloud.bigquery.storage.v1beta2.ArrowRecordBatch
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.
Protobuf type google.cloud.bigquery.storage.v1beta2.ArrowSchema
ArrowSchema.Builder
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.
Protobuf type google.cloud.bigquery.storage.v1beta2.ArrowSchema
ArrowSerializationOptions
Contains options specific to Arrow Serialization.
Protobuf type google.cloud.bigquery.storage.v1beta2.ArrowSerializationOptions
ArrowSerializationOptions.Builder
Contains options specific to Arrow Serialization.
Protobuf type google.cloud.bigquery.storage.v1beta2.ArrowSerializationOptions
AvroProto
AvroRows
Avro rows.
Protobuf type google.cloud.bigquery.storage.v1beta2.AvroRows
AvroRows.Builder
Avro rows.
Protobuf type google.cloud.bigquery.storage.v1beta2.AvroRows
AvroSchema
Avro schema.
Protobuf type google.cloud.bigquery.storage.v1beta2.AvroSchema
AvroSchema.Builder
Avro schema.
Protobuf type google.cloud.bigquery.storage.v1beta2.AvroSchema
BQTableSchemaToProtoDescriptor
Converts a BQ table schema to protobuf descriptor. All field names will be converted to lowercase when constructing the protobuf descriptor. The mapping between field types and field modes are shown in the ImmutableMaps below.
BaseBigQueryReadClient
Service Description: BigQuery Read API.
The Read API can be used to read data from BigQuery.
New code should use the v1 Read API going forward, if they don't use Write API at the same time.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BaseBigQueryReadClient baseBigQueryReadClient = BaseBigQueryReadClient.create()) {
ProjectName parent = ProjectName.of("[PROJECT]");
ReadSession readSession = ReadSession.newBuilder().build();
int maxStreamCount = 940837515;
ReadSession response =
baseBigQueryReadClient.createReadSession(parent, readSession, maxStreamCount);
}
Note: close() needs to be called on the BaseBigQueryReadClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of BaseBigQueryReadSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
BaseBigQueryReadSettings baseBigQueryReadSettings =
BaseBigQueryReadSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
BaseBigQueryReadClient baseBigQueryReadClient =
BaseBigQueryReadClient.create(baseBigQueryReadSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
BaseBigQueryReadSettings baseBigQueryReadSettings =
BaseBigQueryReadSettings.newBuilder().setEndpoint(myEndpoint).build();
BaseBigQueryReadClient baseBigQueryReadClient =
BaseBigQueryReadClient.create(baseBigQueryReadSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
BaseBigQueryReadSettings
Settings class to configure an instance of BaseBigQueryReadClient.
The default instance has everything set to sensible defaults:
- The default service address (bigquerystorage.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of createReadSession to 30 seconds:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
BaseBigQueryReadSettings.Builder baseBigQueryReadSettingsBuilder =
BaseBigQueryReadSettings.newBuilder();
baseBigQueryReadSettingsBuilder
.createReadSessionSettings()
.setRetrySettings(
baseBigQueryReadSettingsBuilder
.createReadSessionSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
BaseBigQueryReadSettings baseBigQueryReadSettings = baseBigQueryReadSettingsBuilder.build();
BaseBigQueryReadSettings.Builder
Builder for BaseBigQueryReadSettings.
BatchCommitWriteStreamsRequest
Request message for BatchCommitWriteStreams.
Protobuf type google.cloud.bigquery.storage.v1beta2.BatchCommitWriteStreamsRequest
BatchCommitWriteStreamsRequest.Builder
Request message for BatchCommitWriteStreams.
Protobuf type google.cloud.bigquery.storage.v1beta2.BatchCommitWriteStreamsRequest
BatchCommitWriteStreamsResponse
Response message for BatchCommitWriteStreams.
Protobuf type google.cloud.bigquery.storage.v1beta2.BatchCommitWriteStreamsResponse
BatchCommitWriteStreamsResponse.Builder
Response message for BatchCommitWriteStreams.
Protobuf type google.cloud.bigquery.storage.v1beta2.BatchCommitWriteStreamsResponse
BigDecimalByteStringEncoder
BigQueryReadClient
Service Description: BigQuery Read API.
The Read API can be used to read data from BigQuery.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
try (BigQueryReadClient BigQueryReadClient = BigQueryReadClient.create()) {
String parent = "";
ReadSession readSession = ReadSession.newBuilder().build();
int maxStreamCount = 0;
ReadSession response = BigQueryReadClient.createReadSession(parent, readSession, maxStreamCount);
}
Note: close() needs to be called on the BigQueryReadClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of BigQueryReadSettings to create(). For example:
To customize credentials:
BigQueryReadSettings BigQueryReadSettings =
BigQueryReadSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
BigQueryReadClient BigQueryReadClient =
BigQueryReadClient.create(BigQueryReadSettings);
To customize the endpoint:
BigQueryReadSettings BigQueryReadSettings =
BigQueryReadSettings.newBuilder().setEndpoint(myEndpoint).build();
BigQueryReadClient BigQueryReadClient =
BigQueryReadClient.create(BigQueryReadSettings);
BigQueryReadGrpc
BigQuery Read API. The Read API can be used to read data from BigQuery. New code should use the v1 Read API going forward, if they don't use Write API at the same time.
BigQueryReadGrpc.BigQueryReadBlockingStub
BigQuery Read API. The Read API can be used to read data from BigQuery. New code should use the v1 Read API going forward, if they don't use Write API at the same time.
BigQueryReadGrpc.BigQueryReadFutureStub
BigQuery Read API. The Read API can be used to read data from BigQuery. New code should use the v1 Read API going forward, if they don't use Write API at the same time.
BigQueryReadGrpc.BigQueryReadImplBase
BigQuery Read API. The Read API can be used to read data from BigQuery. New code should use the v1 Read API going forward, if they don't use Write API at the same time.
BigQueryReadGrpc.BigQueryReadStub
BigQuery Read API. The Read API can be used to read data from BigQuery. New code should use the v1 Read API going forward, if they don't use Write API at the same time.
BigQueryReadSettings
Settings class to configure an instance of BigQueryReadClient.
The default instance has everything set to sensible defaults:
- The default service address (bigquerystorage.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of createReadSession to 30 seconds:
BigQueryReadSettings.Builder BigQueryReadSettingsBuilder =
BigQueryReadSettings.newBuilder();
BigQueryReadSettingsBuilder.createReadSessionSettings().getRetrySettings().toBuilder()
.setTotalTimeout(Duration.ofSeconds(30));
BigQueryReadSettings BigQueryReadSettings = BigQueryReadSettingsBuilder.build();
BigQueryReadSettings.Builder
Builder for BigQueryReadSettings.
BigQueryWriteClient
Service Description: BigQuery Write API.
The Write API can be used to write data to BigQuery.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BigQueryWriteClient bigQueryWriteClient = BigQueryWriteClient.create()) {
TableName parent = TableName.of("[PROJECT]", "[DATASET]", "[TABLE]");
WriteStream writeStream = WriteStream.newBuilder().build();
WriteStream response = bigQueryWriteClient.createWriteStream(parent, writeStream);
}
Note: close() needs to be called on the BigQueryWriteClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of BigQueryWriteSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
BigQueryWriteSettings bigQueryWriteSettings =
BigQueryWriteSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
BigQueryWriteClient bigQueryWriteClient = BigQueryWriteClient.create(bigQueryWriteSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
BigQueryWriteSettings bigQueryWriteSettings =
BigQueryWriteSettings.newBuilder().setEndpoint(myEndpoint).build();
BigQueryWriteClient bigQueryWriteClient = BigQueryWriteClient.create(bigQueryWriteSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
BigQueryWriteGrpc
BigQuery Write API. The Write API can be used to write data to BigQuery.
BigQueryWriteGrpc.BigQueryWriteBlockingStub
BigQuery Write API. The Write API can be used to write data to BigQuery.
BigQueryWriteGrpc.BigQueryWriteFutureStub
BigQuery Write API. The Write API can be used to write data to BigQuery.
BigQueryWriteGrpc.BigQueryWriteImplBase
BigQuery Write API. The Write API can be used to write data to BigQuery.
BigQueryWriteGrpc.BigQueryWriteStub
BigQuery Write API. The Write API can be used to write data to BigQuery.
BigQueryWriteSettings
Settings class to configure an instance of BigQueryWriteClient.
The default instance has everything set to sensible defaults:
- The default service address (bigquerystorage.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of createWriteStream to 30 seconds:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
BigQueryWriteSettings.Builder bigQueryWriteSettingsBuilder = BigQueryWriteSettings.newBuilder();
bigQueryWriteSettingsBuilder
.createWriteStreamSettings()
.setRetrySettings(
bigQueryWriteSettingsBuilder
.createWriteStreamSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
BigQueryWriteSettings bigQueryWriteSettings = bigQueryWriteSettingsBuilder.build();
BigQueryWriteSettings.Builder
Builder for BigQueryWriteSettings.
CivilTimeEncoder
Ported from ZetaSQL CivilTimeEncoder Original code can be found at: https://github.com/google/zetasql/blob/master/java/com/google/zetasql/CivilTimeEncoder.java Encoder for TIME and DATETIME values, according to civil_time encoding.
The valid range and number of bits required by each date/time field is as the following:
| Field | Range | #Bits |
|---|---|---|
| Year | [1, 9999] | 14 |
| Month | [1, 12] | 4 |
| Day | [1, 31] | 5 |
| Hour | [0, 23] | 5 |
| Minute | [0, 59] | 6 |
| Second | [0, 59]* | 6 |
| Micros | [0, 999999] | 20 |
| Nanos | [0, 999999999] | 30 |
* Leap second is not supported.
When encoding the TIME or DATETIME into a bit field, larger date/time field is on the more significant side.
CreateReadSessionRequest
Request message for CreateReadSession.
Protobuf type google.cloud.bigquery.storage.v1beta2.CreateReadSessionRequest
CreateReadSessionRequest.Builder
Request message for CreateReadSession.
Protobuf type google.cloud.bigquery.storage.v1beta2.CreateReadSessionRequest
CreateWriteStreamRequest
Request message for CreateWriteStream.
Protobuf type google.cloud.bigquery.storage.v1beta2.CreateWriteStreamRequest
CreateWriteStreamRequest.Builder
Request message for CreateWriteStream.
Protobuf type google.cloud.bigquery.storage.v1beta2.CreateWriteStreamRequest
FinalizeWriteStreamRequest
Request message for invoking FinalizeWriteStream.
Protobuf type google.cloud.bigquery.storage.v1beta2.FinalizeWriteStreamRequest
FinalizeWriteStreamRequest.Builder
Request message for invoking FinalizeWriteStream.
Protobuf type google.cloud.bigquery.storage.v1beta2.FinalizeWriteStreamRequest
FinalizeWriteStreamResponse
Response message for FinalizeWriteStream.
Protobuf type google.cloud.bigquery.storage.v1beta2.FinalizeWriteStreamResponse
FinalizeWriteStreamResponse.Builder
Response message for FinalizeWriteStream.
Protobuf type google.cloud.bigquery.storage.v1beta2.FinalizeWriteStreamResponse
FlushRowsRequest
Request message for FlushRows.
Protobuf type google.cloud.bigquery.storage.v1beta2.FlushRowsRequest
FlushRowsRequest.Builder
Request message for FlushRows.
Protobuf type google.cloud.bigquery.storage.v1beta2.FlushRowsRequest
FlushRowsResponse
Respond message for FlushRows.
Protobuf type google.cloud.bigquery.storage.v1beta2.FlushRowsResponse
FlushRowsResponse.Builder
Respond message for FlushRows.
Protobuf type google.cloud.bigquery.storage.v1beta2.FlushRowsResponse
GetWriteStreamRequest
Request message for GetWriteStreamRequest.
Protobuf type google.cloud.bigquery.storage.v1beta2.GetWriteStreamRequest
GetWriteStreamRequest.Builder
Request message for GetWriteStreamRequest.
Protobuf type google.cloud.bigquery.storage.v1beta2.GetWriteStreamRequest
JsonStreamWriter
A StreamWriter that can write JSON data (JSONObjects) to BigQuery tables. The JsonStreamWriter is built on top of a StreamWriter, and it simply converts all JSON data to protobuf messages then calls StreamWriter's append() method to write to BigQuery tables.
JsonStreamWriter.Builder
JsonToProtoMessage
Converts Json data to protocol buffer messages given the protocol buffer descriptor. The protobuf descriptor must have all fields lowercased.
ProjectName
ProjectName.Builder
Builder for projects/{project}.
ProtoBufProto
ProtoRows
Protobuf type google.cloud.bigquery.storage.v1beta2.ProtoRows
ProtoRows.Builder
Protobuf type google.cloud.bigquery.storage.v1beta2.ProtoRows
ProtoSchema
ProtoSchema describes the schema of the serialized protocol buffer data rows.
Protobuf type google.cloud.bigquery.storage.v1beta2.ProtoSchema
ProtoSchema.Builder
ProtoSchema describes the schema of the serialized protocol buffer data rows.
Protobuf type google.cloud.bigquery.storage.v1beta2.ProtoSchema
ProtoSchemaConverter
ReadRowsRequest
Request message for ReadRows.
Protobuf type google.cloud.bigquery.storage.v1beta2.ReadRowsRequest
ReadRowsRequest.Builder
Request message for ReadRows.
Protobuf type google.cloud.bigquery.storage.v1beta2.ReadRowsRequest
ReadRowsResponse
Response from calling ReadRows may include row data, progress and
throttling information.
Protobuf type google.cloud.bigquery.storage.v1beta2.ReadRowsResponse
ReadRowsResponse.Builder
Response from calling ReadRows may include row data, progress and
throttling information.
Protobuf type google.cloud.bigquery.storage.v1beta2.ReadRowsResponse
ReadSession
Information about the ReadSession.
Protobuf type google.cloud.bigquery.storage.v1beta2.ReadSession
ReadSession.Builder
Information about the ReadSession.
Protobuf type google.cloud.bigquery.storage.v1beta2.ReadSession
ReadSession.TableModifiers
Additional attributes when reading a table.
Protobuf type google.cloud.bigquery.storage.v1beta2.ReadSession.TableModifiers
ReadSession.TableModifiers.Builder
Additional attributes when reading a table.
Protobuf type google.cloud.bigquery.storage.v1beta2.ReadSession.TableModifiers
ReadSession.TableReadOptions
Options dictating how we read a table.
Protobuf type google.cloud.bigquery.storage.v1beta2.ReadSession.TableReadOptions
ReadSession.TableReadOptions.Builder
Options dictating how we read a table.
Protobuf type google.cloud.bigquery.storage.v1beta2.ReadSession.TableReadOptions
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.
Protobuf type google.cloud.bigquery.storage.v1beta2.ReadStream
ReadStream.Builder
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.
Protobuf type google.cloud.bigquery.storage.v1beta2.ReadStream
ReadStreamName
ReadStreamName.Builder
Builder for projects/{project}/locations/{location}/sessions/{session}/streams/{stream}.
SplitReadStreamRequest
Request message for SplitReadStream.
Protobuf type google.cloud.bigquery.storage.v1beta2.SplitReadStreamRequest
SplitReadStreamRequest.Builder
Request message for SplitReadStream.
Protobuf type google.cloud.bigquery.storage.v1beta2.SplitReadStreamRequest
SplitReadStreamResponse
Protobuf type google.cloud.bigquery.storage.v1beta2.SplitReadStreamResponse
SplitReadStreamResponse.Builder
Protobuf type google.cloud.bigquery.storage.v1beta2.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.
Protobuf type google.cloud.bigquery.storage.v1beta2.StorageError
StorageError.Builder
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.
Protobuf type google.cloud.bigquery.storage.v1beta2.StorageError
StorageProto
StreamConnection
StreamConnection is responsible for writing requests to a GRPC bidirecional connection.
StreamWriter creates a connection. Two callback functions are necessary: request_callback and done_callback. Request callback is used for every request, and done callback is used to notify the user that the connection is closed and no more callbacks will be received from this connection.
The stream writer will accept all the requests without flow control, and makes the callbacks in receiving order.
It's user's responsibility to do the flow control and maintain the lifetime of the requests.
StreamProto
StreamStats
Estimated stream statistics for a given Stream.
Protobuf type google.cloud.bigquery.storage.v1beta2.StreamStats
StreamStats.Builder
Estimated stream statistics for a given Stream.
Protobuf type google.cloud.bigquery.storage.v1beta2.StreamStats
StreamStats.Progress
Protobuf type google.cloud.bigquery.storage.v1beta2.StreamStats.Progress
StreamStats.Progress.Builder
Protobuf type google.cloud.bigquery.storage.v1beta2.StreamStats.Progress
StreamWriterV2
A BigQuery Stream Writer that can be used to write data into BigQuery Table.
TODO: Support batching.
TODO: Support schema change.
StreamWriterV2.Builder
A builder of StreamWriterV2s.
TableFieldSchema
A field in TableSchema
Protobuf type google.cloud.bigquery.storage.v1beta2.TableFieldSchema
TableFieldSchema.Builder
A field in TableSchema
Protobuf type google.cloud.bigquery.storage.v1beta2.TableFieldSchema
TableName
TableName.Builder
Builder for projects/{project}/datasets/{dataset}/tables/{table}.
TableProto
TableSchema
Schema of a table
Protobuf type google.cloud.bigquery.storage.v1beta2.TableSchema
TableSchema.Builder
Schema of a table
Protobuf type google.cloud.bigquery.storage.v1beta2.TableSchema
ThrottleState
Information on if the current connection is being throttled.
Protobuf type google.cloud.bigquery.storage.v1beta2.ThrottleState
ThrottleState.Builder
Information on if the current connection is being throttled.
Protobuf type google.cloud.bigquery.storage.v1beta2.ThrottleState
WriteStream
Information about a single stream that gets data inside the storage system.
Protobuf type google.cloud.bigquery.storage.v1beta2.WriteStream
WriteStream.Builder
Information about a single stream that gets data inside the storage system.
Protobuf type google.cloud.bigquery.storage.v1beta2.WriteStream
WriteStreamName
WriteStreamName.Builder
Builder for projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}.
Interfaces
AppendRowsRequest.ProtoDataOrBuilder
AppendRowsRequestOrBuilder
AppendRowsResponse.AppendResultOrBuilder
AppendRowsResponseOrBuilder
ArrowRecordBatchOrBuilder
ArrowSchemaOrBuilder
ArrowSerializationOptionsOrBuilder
AvroRowsOrBuilder
AvroSchemaOrBuilder
BatchCommitWriteStreamsRequestOrBuilder
BatchCommitWriteStreamsResponseOrBuilder
BigQueryReadSettings.RetryAttemptListener
CreateReadSessionRequestOrBuilder
CreateWriteStreamRequestOrBuilder
FinalizeWriteStreamRequestOrBuilder
FinalizeWriteStreamResponseOrBuilder
FlushRowsRequestOrBuilder
FlushRowsResponseOrBuilder
GetWriteStreamRequestOrBuilder
ProtoRowsOrBuilder
ProtoSchemaOrBuilder
ReadRowsRequestOrBuilder
ReadRowsResponseOrBuilder
ReadSession.TableModifiersOrBuilder
ReadSession.TableReadOptionsOrBuilder
ReadSessionOrBuilder
ReadStreamOrBuilder
SplitReadStreamRequestOrBuilder
SplitReadStreamResponseOrBuilder
StorageErrorOrBuilder
StreamConnection.DoneCallback
Invoked when server closes the connection.
StreamConnection.RequestCallback
Invoked when a response is received from the server.
StreamStats.ProgressOrBuilder
StreamStatsOrBuilder
TableFieldSchemaOrBuilder
TableSchemaOrBuilder
ThrottleStateOrBuilder
WriteStreamOrBuilder
Enums
AppendRowsRequest.RowsCase
AppendRowsResponse.ResponseCase
ArrowSerializationOptions.Format
The IPC format to use when serializing Arrow streams.
Protobuf enum google.cloud.bigquery.storage.v1beta2.ArrowSerializationOptions.Format
DataFormat
Data format for input or output data.
Protobuf enum google.cloud.bigquery.storage.v1beta2.DataFormat
ReadRowsResponse.RowsCase
ReadRowsResponse.SchemaCase
ReadSession.SchemaCase
StorageError.StorageErrorCode
Error code for StorageError.
Protobuf enum google.cloud.bigquery.storage.v1beta2.StorageError.StorageErrorCode
TableFieldSchema.Mode
Protobuf enum google.cloud.bigquery.storage.v1beta2.TableFieldSchema.Mode
TableFieldSchema.Type
Protobuf enum google.cloud.bigquery.storage.v1beta2.TableFieldSchema.Type
WriteStream.Type
Type enum of the stream.
Protobuf enum google.cloud.bigquery.storage.v1beta2.WriteStream.Type