Package com.google.cloud.bigquery.storage.v1beta1 (3.5.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.v1beta1.BaseBigQueryStorageClient Service Description: BigQuery storage API.

The BigQuery storage API can be used to read data stored in BigQuery.

com.google.cloud.bigquery.storage.v1beta1.BigQueryStorageClient Service Description: BigQuery storage API.

The BigQuery storage API can be used to read data stored in BigQuery.

Settings Classes

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

Settings Description
com.google.cloud.bigquery.storage.v1beta1.BaseBigQueryStorageSettings Settings class to configure an instance of BaseBigQueryStorageClient.

The default instance has everything set to sensible defaults:

com.google.cloud.bigquery.storage.v1beta1.BigQueryStorageSettings Settings class to configure an instance of BigQueryStorageClient.

The default instance has everything set to sensible defaults:

Classes

Class Description
com.google.cloud.bigquery.storage.v1beta1.ArrowProto
com.google.cloud.bigquery.storage.v1beta1.ArrowProto.ArrowRecordBatch Arrow RecordBatch.
com.google.cloud.bigquery.storage.v1beta1.ArrowProto.ArrowRecordBatch.Builder Arrow RecordBatch.
com.google.cloud.bigquery.storage.v1beta1.ArrowProto.ArrowSchema Arrow schema.
com.google.cloud.bigquery.storage.v1beta1.ArrowProto.ArrowSchema.Builder Arrow schema.
com.google.cloud.bigquery.storage.v1beta1.AvroProto
com.google.cloud.bigquery.storage.v1beta1.AvroProto.AvroRows Avro rows.
com.google.cloud.bigquery.storage.v1beta1.AvroProto.AvroRows.Builder Avro rows.
com.google.cloud.bigquery.storage.v1beta1.AvroProto.AvroSchema Avro schema.
com.google.cloud.bigquery.storage.v1beta1.AvroProto.AvroSchema.Builder Avro schema.
com.google.cloud.bigquery.storage.v1beta1.BaseBigQueryStorageSettings.Builder Builder for BaseBigQueryStorageSettings.
com.google.cloud.bigquery.storage.v1beta1.BigQueryStorageGrpc BigQuery storage API. The BigQuery storage API can be used to read data stored in BigQuery. The v1beta1 API is not yet officially deprecated, and will go through a full
com.google.cloud.bigquery.storage.v1beta1.BigQueryStorageGrpc.BigQueryStorageImplBase Base class for the server implementation of the service BigQueryStorage. BigQuery storage API.
com.google.cloud.bigquery.storage.v1beta1.BigQueryStorageSettings.Builder Builder for BigQueryStorageSettings.
com.google.cloud.bigquery.storage.v1beta1.ProjectName
com.google.cloud.bigquery.storage.v1beta1.ProjectName.Builder Builder for projects/{project}.
com.google.cloud.bigquery.storage.v1beta1.ReadOptions
com.google.cloud.bigquery.storage.v1beta1.ReadOptions.TableReadOptions Options dictating how we read a table.
com.google.cloud.bigquery.storage.v1beta1.ReadOptions.TableReadOptions.Builder Options dictating how we read a table.
com.google.cloud.bigquery.storage.v1beta1.Storage
com.google.cloud.bigquery.storage.v1beta1.Storage.BatchCreateReadSessionStreamsRequest Information needed to request additional streams for an established read session.
com.google.cloud.bigquery.storage.v1beta1.Storage.BatchCreateReadSessionStreamsRequest.Builder Information needed to request additional streams for an established read session.
com.google.cloud.bigquery.storage.v1beta1.Storage.BatchCreateReadSessionStreamsResponse The response from BatchCreateReadSessionStreams returns the stream identifiers for the newly created streams.
com.google.cloud.bigquery.storage.v1beta1.Storage.BatchCreateReadSessionStreamsResponse.Builder The response from BatchCreateReadSessionStreams returns the stream identifiers for the newly created streams.
com.google.cloud.bigquery.storage.v1beta1.Storage.CreateReadSessionRequest Creates a new read session, which may include additional options such as requested parallelism, projection filters and constraints.
com.google.cloud.bigquery.storage.v1beta1.Storage.CreateReadSessionRequest.Builder Creates a new read session, which may include additional options such as requested parallelism, projection filters and constraints.
com.google.cloud.bigquery.storage.v1beta1.Storage.FinalizeStreamRequest Request information for invoking FinalizeStream.
com.google.cloud.bigquery.storage.v1beta1.Storage.FinalizeStreamRequest.Builder Request information for invoking FinalizeStream.
com.google.cloud.bigquery.storage.v1beta1.Storage.Progress Protobuf type google.cloud.bigquery.storage.v1beta1.Progress
com.google.cloud.bigquery.storage.v1beta1.Storage.Progress.Builder Protobuf type google.cloud.bigquery.storage.v1beta1.Progress
com.google.cloud.bigquery.storage.v1beta1.Storage.ReadRowsRequest Requesting row data via ReadRows must provide Stream position information.
com.google.cloud.bigquery.storage.v1beta1.Storage.ReadRowsRequest.Builder Requesting row data via ReadRows must provide Stream position information.
com.google.cloud.bigquery.storage.v1beta1.Storage.ReadRowsResponse Response from calling ReadRows may include row data, progress and throttling information.
com.google.cloud.bigquery.storage.v1beta1.Storage.ReadRowsResponse.Builder Response from calling ReadRows may include row data, progress and throttling information.
com.google.cloud.bigquery.storage.v1beta1.Storage.ReadSession Information returned from a CreateReadSession request.
com.google.cloud.bigquery.storage.v1beta1.Storage.ReadSession.Builder Information returned from a CreateReadSession request.
com.google.cloud.bigquery.storage.v1beta1.Storage.SplitReadStreamRequest Request information for SplitReadStream.
com.google.cloud.bigquery.storage.v1beta1.Storage.SplitReadStreamRequest.Builder Request information for SplitReadStream.
com.google.cloud.bigquery.storage.v1beta1.Storage.SplitReadStreamResponse Response from SplitReadStream.
com.google.cloud.bigquery.storage.v1beta1.Storage.SplitReadStreamResponse.Builder Response from SplitReadStream.
com.google.cloud.bigquery.storage.v1beta1.Storage.Stream Information about a single data stream within a read session.
com.google.cloud.bigquery.storage.v1beta1.Storage.Stream.Builder Information about a single data stream within a read session.
com.google.cloud.bigquery.storage.v1beta1.Storage.StreamPosition Expresses a point within a given stream using an offset position.
com.google.cloud.bigquery.storage.v1beta1.Storage.StreamPosition.Builder Expresses a point within a given stream using an offset position.
com.google.cloud.bigquery.storage.v1beta1.Storage.StreamStatus Progress information for a given Stream.
com.google.cloud.bigquery.storage.v1beta1.Storage.StreamStatus.Builder Progress information for a given Stream.
com.google.cloud.bigquery.storage.v1beta1.Storage.ThrottleStatus Information on if the current connection is being throttled.
com.google.cloud.bigquery.storage.v1beta1.Storage.ThrottleStatus.Builder Information on if the current connection is being throttled.
com.google.cloud.bigquery.storage.v1beta1.TableReferenceProto
com.google.cloud.bigquery.storage.v1beta1.TableReferenceProto.TableModifiers All fields in this message optional.
com.google.cloud.bigquery.storage.v1beta1.TableReferenceProto.TableModifiers.Builder All fields in this message optional.
com.google.cloud.bigquery.storage.v1beta1.TableReferenceProto.TableReference Table reference that includes just the 3 strings needed to identify a table.
com.google.cloud.bigquery.storage.v1beta1.TableReferenceProto.TableReference.Builder Table reference that includes just the 3 strings needed to identify a table.

Interfaces

Interface Description
com.google.cloud.bigquery.storage.v1beta1.ArrowProto.ArrowRecordBatchOrBuilder
com.google.cloud.bigquery.storage.v1beta1.ArrowProto.ArrowSchemaOrBuilder
com.google.cloud.bigquery.storage.v1beta1.AvroProto.AvroRowsOrBuilder
com.google.cloud.bigquery.storage.v1beta1.AvroProto.AvroSchemaOrBuilder
com.google.cloud.bigquery.storage.v1beta1.BigQueryStorageGrpc.AsyncService BigQuery storage API. The BigQuery storage API can be used to read data stored in BigQuery. The v1beta1 API is not yet officially deprecated, and will go through a full
com.google.cloud.bigquery.storage.v1beta1.BigQueryStorageSettings.RetryAttemptListener
com.google.cloud.bigquery.storage.v1beta1.ReadOptions.TableReadOptionsOrBuilder
com.google.cloud.bigquery.storage.v1beta1.Storage.BatchCreateReadSessionStreamsRequestOrBuilder
com.google.cloud.bigquery.storage.v1beta1.Storage.BatchCreateReadSessionStreamsResponseOrBuilder
com.google.cloud.bigquery.storage.v1beta1.Storage.CreateReadSessionRequestOrBuilder
com.google.cloud.bigquery.storage.v1beta1.Storage.FinalizeStreamRequestOrBuilder
com.google.cloud.bigquery.storage.v1beta1.Storage.ProgressOrBuilder
com.google.cloud.bigquery.storage.v1beta1.Storage.ReadRowsRequestOrBuilder
com.google.cloud.bigquery.storage.v1beta1.Storage.ReadRowsResponseOrBuilder
com.google.cloud.bigquery.storage.v1beta1.Storage.ReadSessionOrBuilder
com.google.cloud.bigquery.storage.v1beta1.Storage.SplitReadStreamRequestOrBuilder
com.google.cloud.bigquery.storage.v1beta1.Storage.SplitReadStreamResponseOrBuilder
com.google.cloud.bigquery.storage.v1beta1.Storage.StreamOrBuilder
com.google.cloud.bigquery.storage.v1beta1.Storage.StreamPositionOrBuilder
com.google.cloud.bigquery.storage.v1beta1.Storage.StreamStatusOrBuilder
com.google.cloud.bigquery.storage.v1beta1.Storage.ThrottleStatusOrBuilder
com.google.cloud.bigquery.storage.v1beta1.TableReferenceProto.TableModifiersOrBuilder
com.google.cloud.bigquery.storage.v1beta1.TableReferenceProto.TableReferenceOrBuilder

Enums

Enum Description
com.google.cloud.bigquery.storage.v1beta1.Storage.DataFormat Data format for input or output data.
com.google.cloud.bigquery.storage.v1beta1.Storage.ReadRowsResponse.RowsCase
com.google.cloud.bigquery.storage.v1beta1.Storage.ReadRowsResponse.SchemaCase
com.google.cloud.bigquery.storage.v1beta1.Storage.ReadSession.SchemaCase
com.google.cloud.bigquery.storage.v1beta1.Storage.ShardingStrategy Strategy for distributing data among multiple streams in a read session.