Package com.google.cloud.bigquery.storage.v1beta2 (3.8.0)

GitHub Repository

This package is not the recommended entry point to using this client library!

For this library, we recommend using com.google.cloud.bigquery.storage.v1 for new applications.

Prerelease Implications

This package is a prerelease version! Use with caution.

Prerelease versions are considered unstable as they may be shut down and/or subject to breaking changes when upgrading. Use them only for testing or if you specifically need their experimental features.

Client Classes

Client classes are the main entry point to using a package. They contain several variations of Java methods for each of the API's methods.

Client Description
com.google.cloud.bigquery.storage.v1beta2.BaseBigQueryReadClient Service Description: BigQuery Read API.

The Read API can be used to read data from BigQuery.

com.google.cloud.bigquery.storage.v1beta2.BigQueryReadClient Service Description: BigQuery Read API.

The Read API can be used to read data from BigQuery.

com.google.cloud.bigquery.storage.v1beta2.BigQueryWriteClient

Deprecated. This class is deprecated and will be removed in the next major version update.

Service Description: BigQuery Write API.

Settings Classes

Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.

Settings Description
com.google.cloud.bigquery.storage.v1beta2.BaseBigQueryReadSettings Settings class to configure an instance of BaseBigQueryReadClient.

The default instance has everything set to sensible defaults:

com.google.cloud.bigquery.storage.v1beta2.BigQueryReadSettings Settings class to configure an instance of BigQueryReadClient.

The default instance has everything set to sensible defaults:

com.google.cloud.bigquery.storage.v1beta2.BigQueryWriteSettings

Deprecated. This class is deprecated and will be removed in the next major version update.

Settings class to configure an instance of BigQueryWriteClient.

Classes

Class Description
com.google.cloud.bigquery.storage.v1beta2.AppendRowsRequest Request message for AppendRows.
com.google.cloud.bigquery.storage.v1beta2.AppendRowsRequest.Builder Request message for AppendRows.
com.google.cloud.bigquery.storage.v1beta2.AppendRowsRequest.ProtoData Proto schema and data.
com.google.cloud.bigquery.storage.v1beta2.AppendRowsRequest.ProtoData.Builder Proto schema and data.
com.google.cloud.bigquery.storage.v1beta2.AppendRowsResponse Response message for AppendRows.
com.google.cloud.bigquery.storage.v1beta2.AppendRowsResponse.AppendResult AppendResult is returned for successful append requests.
com.google.cloud.bigquery.storage.v1beta2.AppendRowsResponse.AppendResult.Builder AppendResult is returned for successful append requests.
com.google.cloud.bigquery.storage.v1beta2.AppendRowsResponse.Builder Response message for AppendRows.
com.google.cloud.bigquery.storage.v1beta2.ArrowProto
com.google.cloud.bigquery.storage.v1beta2.ArrowRecordBatch Arrow RecordBatch.
com.google.cloud.bigquery.storage.v1beta2.ArrowRecordBatch.Builder Arrow RecordBatch.
com.google.cloud.bigquery.storage.v1beta2.ArrowSchema Arrow schema as specified in https://arrow.apache.org/docs/python/api/datatypes.html and serialized to bytes using IPC:
com.google.cloud.bigquery.storage.v1beta2.ArrowSchema.Builder Arrow schema as specified in https://arrow.apache.org/docs/python/api/datatypes.html and serialized to bytes using IPC:
com.google.cloud.bigquery.storage.v1beta2.ArrowSerializationOptions Contains options specific to Arrow Serialization.
com.google.cloud.bigquery.storage.v1beta2.ArrowSerializationOptions.Builder Contains options specific to Arrow Serialization.
com.google.cloud.bigquery.storage.v1beta2.AvroProto
com.google.cloud.bigquery.storage.v1beta2.AvroRows Avro rows.
com.google.cloud.bigquery.storage.v1beta2.AvroRows.Builder Avro rows.
com.google.cloud.bigquery.storage.v1beta2.AvroSchema Avro schema.
com.google.cloud.bigquery.storage.v1beta2.AvroSchema.Builder Avro schema.
com.google.cloud.bigquery.storage.v1beta2.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.
com.google.cloud.bigquery.storage.v1beta2.BaseBigQueryReadSettings.Builder Builder for BaseBigQueryReadSettings.
com.google.cloud.bigquery.storage.v1beta2.BatchCommitWriteStreamsRequest Request message for BatchCommitWriteStreams.
com.google.cloud.bigquery.storage.v1beta2.BatchCommitWriteStreamsRequest.Builder Request message for BatchCommitWriteStreams.
com.google.cloud.bigquery.storage.v1beta2.BatchCommitWriteStreamsResponse Response message for BatchCommitWriteStreams.
com.google.cloud.bigquery.storage.v1beta2.BatchCommitWriteStreamsResponse.Builder Response message for BatchCommitWriteStreams.
com.google.cloud.bigquery.storage.v1beta2.BigDecimalByteStringEncoder
com.google.cloud.bigquery.storage.v1beta2.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
com.google.cloud.bigquery.storage.v1beta2.BigQueryReadGrpc.BigQueryReadImplBase Base class for the server implementation of the service BigQueryRead. BigQuery Read API.
com.google.cloud.bigquery.storage.v1beta2.BigQueryReadSettings.Builder Builder for BigQueryReadSettings.
com.google.cloud.bigquery.storage.v1beta2.BigQueryWriteGrpc BigQuery Write API. The Write API can be used to write data to BigQuery. The google.cloud.bigquery.storage.v1
com.google.cloud.bigquery.storage.v1beta2.BigQueryWriteGrpc.BigQueryWriteImplBase Base class for the server implementation of the service BigQueryWrite. BigQuery Write API.
com.google.cloud.bigquery.storage.v1beta2.BigQueryWriteSettings.Builder Builder for BigQueryWriteSettings.
com.google.cloud.bigquery.storage.v1beta2.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.
com.google.cloud.bigquery.storage.v1beta2.CreateReadSessionRequest Request message for CreateReadSession.
com.google.cloud.bigquery.storage.v1beta2.CreateReadSessionRequest.Builder Request message for CreateReadSession.
com.google.cloud.bigquery.storage.v1beta2.CreateWriteStreamRequest Request message for CreateWriteStream.
com.google.cloud.bigquery.storage.v1beta2.CreateWriteStreamRequest.Builder Request message for CreateWriteStream.
com.google.cloud.bigquery.storage.v1beta2.FinalizeWriteStreamRequest Request message for invoking FinalizeWriteStream.
com.google.cloud.bigquery.storage.v1beta2.FinalizeWriteStreamRequest.Builder Request message for invoking FinalizeWriteStream.
com.google.cloud.bigquery.storage.v1beta2.FinalizeWriteStreamResponse Response message for FinalizeWriteStream.
com.google.cloud.bigquery.storage.v1beta2.FinalizeWriteStreamResponse.Builder Response message for FinalizeWriteStream.
com.google.cloud.bigquery.storage.v1beta2.FlushRowsRequest Request message for FlushRows.
com.google.cloud.bigquery.storage.v1beta2.FlushRowsRequest.Builder Request message for FlushRows.
com.google.cloud.bigquery.storage.v1beta2.FlushRowsResponse Respond message for FlushRows.
com.google.cloud.bigquery.storage.v1beta2.FlushRowsResponse.Builder Respond message for FlushRows.
com.google.cloud.bigquery.storage.v1beta2.GetWriteStreamRequest Request message for GetWriteStreamRequest.
com.google.cloud.bigquery.storage.v1beta2.GetWriteStreamRequest.Builder Request message for GetWriteStreamRequest.
com.google.cloud.bigquery.storage.v1beta2.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.
com.google.cloud.bigquery.storage.v1beta2.JsonStreamWriter.Builder
com.google.cloud.bigquery.storage.v1beta2.JsonToProtoMessage Converts Json data to protocol buffer messages given the protocol buffer descriptor. The protobuf descriptor must have all fields lowercased.

This client lib is deprecated, please use v1 instead.

com.google.cloud.bigquery.storage.v1beta2.ProjectName
com.google.cloud.bigquery.storage.v1beta2.ProjectName.Builder Builder for projects/{project}.
com.google.cloud.bigquery.storage.v1beta2.ProtoBufProto
com.google.cloud.bigquery.storage.v1beta2.ProtoRows Protobuf type google.cloud.bigquery.storage.v1beta2.ProtoRows
com.google.cloud.bigquery.storage.v1beta2.ProtoRows.Builder Protobuf type google.cloud.bigquery.storage.v1beta2.ProtoRows
com.google.cloud.bigquery.storage.v1beta2.ProtoSchema ProtoSchema describes the schema of the serialized protocol buffer data rows.
com.google.cloud.bigquery.storage.v1beta2.ProtoSchema.Builder ProtoSchema describes the schema of the serialized protocol buffer data rows.
com.google.cloud.bigquery.storage.v1beta2.ProtoSchemaConverter
com.google.cloud.bigquery.storage.v1beta2.ReadRowsRequest Request message for ReadRows.
com.google.cloud.bigquery.storage.v1beta2.ReadRowsRequest.Builder Request message for ReadRows.
com.google.cloud.bigquery.storage.v1beta2.ReadRowsResponse Response from calling ReadRows may include row data, progress and throttling information.
com.google.cloud.bigquery.storage.v1beta2.ReadRowsResponse.Builder Response from calling ReadRows may include row data, progress and throttling information.
com.google.cloud.bigquery.storage.v1beta2.ReadSession Information about the ReadSession.
com.google.cloud.bigquery.storage.v1beta2.ReadSession.Builder Information about the ReadSession.
com.google.cloud.bigquery.storage.v1beta2.ReadSession.TableModifiers Additional attributes when reading a table.
com.google.cloud.bigquery.storage.v1beta2.ReadSession.TableModifiers.Builder Additional attributes when reading a table.
com.google.cloud.bigquery.storage.v1beta2.ReadSession.TableReadOptions Options dictating how we read a table.
com.google.cloud.bigquery.storage.v1beta2.ReadSession.TableReadOptions.Builder Options dictating how we read a table.
com.google.cloud.bigquery.storage.v1beta2.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.
com.google.cloud.bigquery.storage.v1beta2.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.
com.google.cloud.bigquery.storage.v1beta2.ReadStreamName
com.google.cloud.bigquery.storage.v1beta2.ReadStreamName.Builder Builder for projects/{project}/locations/{location}/sessions/{session}/streams/{stream}.
com.google.cloud.bigquery.storage.v1beta2.SplitReadStreamRequest Request message for SplitReadStream.
com.google.cloud.bigquery.storage.v1beta2.SplitReadStreamRequest.Builder Request message for SplitReadStream.
com.google.cloud.bigquery.storage.v1beta2.SplitReadStreamResponse Protobuf type google.cloud.bigquery.storage.v1beta2.SplitReadStreamResponse
com.google.cloud.bigquery.storage.v1beta2.SplitReadStreamResponse.Builder Protobuf type google.cloud.bigquery.storage.v1beta2.SplitReadStreamResponse
com.google.cloud.bigquery.storage.v1beta2.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
com.google.cloud.bigquery.storage.v1beta2.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
com.google.cloud.bigquery.storage.v1beta2.StorageProto
com.google.cloud.bigquery.storage.v1beta2.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

com.google.cloud.bigquery.storage.v1beta2.StreamProto
com.google.cloud.bigquery.storage.v1beta2.StreamStats Estimated stream statistics for a given Stream.
com.google.cloud.bigquery.storage.v1beta2.StreamStats.Builder Estimated stream statistics for a given Stream.
com.google.cloud.bigquery.storage.v1beta2.StreamStats.Progress Protobuf type google.cloud.bigquery.storage.v1beta2.StreamStats.Progress
com.google.cloud.bigquery.storage.v1beta2.StreamStats.Progress.Builder Protobuf type google.cloud.bigquery.storage.v1beta2.StreamStats.Progress
com.google.cloud.bigquery.storage.v1beta2.StreamWriterV2 A BigQuery Stream Writer that can be used to write data into BigQuery Table.

TODO: Support batching.

com.google.cloud.bigquery.storage.v1beta2.StreamWriterV2.Builder A builder of StreamWriterV2s.
com.google.cloud.bigquery.storage.v1beta2.TableFieldSchema A field in TableSchema
com.google.cloud.bigquery.storage.v1beta2.TableFieldSchema.Builder A field in TableSchema
com.google.cloud.bigquery.storage.v1beta2.TableName
com.google.cloud.bigquery.storage.v1beta2.TableName.Builder Builder for projects/{project}/datasets/{dataset}/tables/{table}.
com.google.cloud.bigquery.storage.v1beta2.TableProto
com.google.cloud.bigquery.storage.v1beta2.TableSchema Schema of a table
com.google.cloud.bigquery.storage.v1beta2.TableSchema.Builder Schema of a table
com.google.cloud.bigquery.storage.v1beta2.ThrottleState Information on if the current connection is being throttled.
com.google.cloud.bigquery.storage.v1beta2.ThrottleState.Builder Information on if the current connection is being throttled.
com.google.cloud.bigquery.storage.v1beta2.WriteStream Information about a single stream that gets data inside the storage system.
com.google.cloud.bigquery.storage.v1beta2.WriteStream.Builder Information about a single stream that gets data inside the storage system.
com.google.cloud.bigquery.storage.v1beta2.WriteStreamName
com.google.cloud.bigquery.storage.v1beta2.WriteStreamName.Builder Builder for projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}.

Interfaces

Interface Description
com.google.cloud.bigquery.storage.v1beta2.AppendRowsRequest.ProtoDataOrBuilder
com.google.cloud.bigquery.storage.v1beta2.AppendRowsRequestOrBuilder
com.google.cloud.bigquery.storage.v1beta2.AppendRowsResponse.AppendResultOrBuilder
com.google.cloud.bigquery.storage.v1beta2.AppendRowsResponseOrBuilder
com.google.cloud.bigquery.storage.v1beta2.ArrowRecordBatchOrBuilder
com.google.cloud.bigquery.storage.v1beta2.ArrowSchemaOrBuilder
com.google.cloud.bigquery.storage.v1beta2.ArrowSerializationOptionsOrBuilder
com.google.cloud.bigquery.storage.v1beta2.AvroRowsOrBuilder
com.google.cloud.bigquery.storage.v1beta2.AvroSchemaOrBuilder
com.google.cloud.bigquery.storage.v1beta2.BatchCommitWriteStreamsRequestOrBuilder
com.google.cloud.bigquery.storage.v1beta2.BatchCommitWriteStreamsResponseOrBuilder
com.google.cloud.bigquery.storage.v1beta2.BigQueryReadGrpc.AsyncService 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
com.google.cloud.bigquery.storage.v1beta2.BigQueryReadSettings.RetryAttemptListener
com.google.cloud.bigquery.storage.v1beta2.BigQueryWriteGrpc.AsyncService BigQuery Write API. The Write API can be used to write data to BigQuery. The google.cloud.bigquery.storage.v1
com.google.cloud.bigquery.storage.v1beta2.CreateReadSessionRequestOrBuilder
com.google.cloud.bigquery.storage.v1beta2.CreateWriteStreamRequestOrBuilder
com.google.cloud.bigquery.storage.v1beta2.FinalizeWriteStreamRequestOrBuilder
com.google.cloud.bigquery.storage.v1beta2.FinalizeWriteStreamResponseOrBuilder
com.google.cloud.bigquery.storage.v1beta2.FlushRowsRequestOrBuilder
com.google.cloud.bigquery.storage.v1beta2.FlushRowsResponseOrBuilder
com.google.cloud.bigquery.storage.v1beta2.GetWriteStreamRequestOrBuilder
com.google.cloud.bigquery.storage.v1beta2.ProtoRowsOrBuilder
com.google.cloud.bigquery.storage.v1beta2.ProtoSchemaOrBuilder
com.google.cloud.bigquery.storage.v1beta2.ReadRowsRequestOrBuilder
com.google.cloud.bigquery.storage.v1beta2.ReadRowsResponseOrBuilder
com.google.cloud.bigquery.storage.v1beta2.ReadSession.TableModifiersOrBuilder
com.google.cloud.bigquery.storage.v1beta2.ReadSession.TableReadOptionsOrBuilder
com.google.cloud.bigquery.storage.v1beta2.ReadSessionOrBuilder
com.google.cloud.bigquery.storage.v1beta2.ReadStreamOrBuilder
com.google.cloud.bigquery.storage.v1beta2.SplitReadStreamRequestOrBuilder
com.google.cloud.bigquery.storage.v1beta2.SplitReadStreamResponseOrBuilder
com.google.cloud.bigquery.storage.v1beta2.StorageErrorOrBuilder
com.google.cloud.bigquery.storage.v1beta2.StreamConnection.DoneCallback Invoked when server closes the connection.
com.google.cloud.bigquery.storage.v1beta2.StreamConnection.RequestCallback Invoked when a response is received from the server.
com.google.cloud.bigquery.storage.v1beta2.StreamStats.ProgressOrBuilder
com.google.cloud.bigquery.storage.v1beta2.StreamStatsOrBuilder
com.google.cloud.bigquery.storage.v1beta2.TableFieldSchemaOrBuilder
com.google.cloud.bigquery.storage.v1beta2.TableSchemaOrBuilder
com.google.cloud.bigquery.storage.v1beta2.ThrottleStateOrBuilder
com.google.cloud.bigquery.storage.v1beta2.WriteStreamOrBuilder

Enums

Enum Description
com.google.cloud.bigquery.storage.v1beta2.AppendRowsRequest.RowsCase
com.google.cloud.bigquery.storage.v1beta2.AppendRowsResponse.ResponseCase
com.google.cloud.bigquery.storage.v1beta2.ArrowSerializationOptions.Format The IPC format to use when serializing Arrow streams.
com.google.cloud.bigquery.storage.v1beta2.DataFormat Data format for input or output data.
com.google.cloud.bigquery.storage.v1beta2.ReadRowsResponse.RowsCase
com.google.cloud.bigquery.storage.v1beta2.ReadRowsResponse.SchemaCase
com.google.cloud.bigquery.storage.v1beta2.ReadSession.SchemaCase
com.google.cloud.bigquery.storage.v1beta2.StorageError.StorageErrorCode Error code for StorageError.
com.google.cloud.bigquery.storage.v1beta2.TableFieldSchema.Mode Protobuf enum google.cloud.bigquery.storage.v1beta2.TableFieldSchema.Mode
com.google.cloud.bigquery.storage.v1beta2.TableFieldSchema.Type Protobuf enum google.cloud.bigquery.storage.v1beta2.TableFieldSchema.Type
com.google.cloud.bigquery.storage.v1beta2.WriteStream.Type Type enum of the stream.