@Generated("by gapic-generator-java")
Package com.google.cloud.bigquery.storage.v1beta2
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.
The [google.cloud.bigquery.storage.v1 API](/bigquery/docs/reference/storage/rpc/google.cloud.bigquery.storage.v1) should be used instead of the v1beta2 API for BigQueryWrite operations.
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);
}
-
Class Summary Class Description AppendRowsRequest Request message for `AppendRows`.AppendRowsRequest.Builder Request message for `AppendRows`.AppendRowsRequest.ProtoData Proto schema and data.AppendRowsRequest.ProtoData.Builder Proto schema and data.AppendRowsResponse Response message for `AppendRows`.AppendRowsResponse.AppendResult AppendResult is returned for successful append requests.AppendRowsResponse.AppendResult.Builder AppendResult is returned for successful append requests.AppendRowsResponse.Builder Response message for `AppendRows`.ArrowProto ArrowRecordBatch Arrow RecordBatch.ArrowRecordBatch.Builder 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.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.ArrowSerializationOptions Contains options specific to Arrow Serialization.ArrowSerializationOptions.Builder Contains options specific to Arrow Serialization.AvroProto AvroRows Avro rows.AvroRows.Builder Avro rows.AvroSchema Avro schema.AvroSchema.Builder Avro schema.BaseBigQueryReadClient Service Description: BigQuery Read API.BaseBigQueryReadSettings Settings class to configure an instance ofBaseBigQueryReadClient
.BaseBigQueryReadSettings.Builder Builder for BaseBigQueryReadSettings.BatchCommitWriteStreamsRequest Request message for `BatchCommitWriteStreams`.BatchCommitWriteStreamsRequest.Builder Request message for `BatchCommitWriteStreams`.BatchCommitWriteStreamsResponse Response message for `BatchCommitWriteStreams`.BatchCommitWriteStreamsResponse.Builder Response message for `BatchCommitWriteStreams`.BigDecimalByteStringEncoder BigQueryReadClient Service Description: BigQuery Read API.BigQueryReadGrpc BigQuery Read API.BigQueryReadGrpc.BigQueryReadBlockingStub A stub to allow clients to do synchronous rpc calls to service BigQueryRead.BigQueryReadGrpc.BigQueryReadFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service BigQueryRead.BigQueryReadGrpc.BigQueryReadImplBase Base class for the server implementation of the service BigQueryRead.BigQueryReadGrpc.BigQueryReadStub A stub to allow clients to do asynchronous rpc calls to service BigQueryRead.BigQueryReadSettings Settings class to configure an instance ofBigQueryReadClient
.BigQueryReadSettings.Builder Builder for BigQueryReadSettings.BigQueryWriteClient Service Description: BigQuery Write API.BigQueryWriteGrpc BigQuery Write API.BigQueryWriteGrpc.BigQueryWriteBlockingStub A stub to allow clients to do synchronous rpc calls to service BigQueryWrite.BigQueryWriteGrpc.BigQueryWriteFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service BigQueryWrite.BigQueryWriteGrpc.BigQueryWriteImplBase Base class for the server implementation of the service BigQueryWrite.BigQueryWriteGrpc.BigQueryWriteStub A stub to allow clients to do asynchronous rpc calls to service BigQueryWrite.BigQueryWriteSettings Settings class to configure an instance ofBigQueryWriteClient
.BigQueryWriteSettings.Builder Builder for BigQueryWriteSettings.BQTableSchemaToProtoDescriptor Converts a BQ table schema to protobuf descriptor.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.CreateReadSessionRequest Request message for `CreateReadSession`.CreateReadSessionRequest.Builder Request message for `CreateReadSession`.CreateWriteStreamRequest Request message for `CreateWriteStream`.CreateWriteStreamRequest.Builder Request message for `CreateWriteStream`.FinalizeWriteStreamRequest Request message for invoking `FinalizeWriteStream`.FinalizeWriteStreamRequest.Builder Request message for invoking `FinalizeWriteStream`.FinalizeWriteStreamResponse Response message for `FinalizeWriteStream`.FinalizeWriteStreamResponse.Builder Response message for `FinalizeWriteStream`.FlushRowsRequest Request message for `FlushRows`.FlushRowsRequest.Builder Request message for `FlushRows`.FlushRowsResponse Respond message for `FlushRows`.FlushRowsResponse.Builder Respond message for `FlushRows`.GetWriteStreamRequest Request message for `GetWriteStreamRequest`.GetWriteStreamRequest.Builder Request message for `GetWriteStreamRequest`.JsonStreamWriter A StreamWriter that can write JSON data (JSONObjects) to BigQuery tables.JsonStreamWriter.Builder JsonToProtoMessage Converts Json data to protocol buffer messages given the protocol buffer descriptor.ProjectName ProjectName.Builder Builder for projects/{project}.ProtoBufProto ProtoRows Protobuf typegoogle.cloud.bigquery.storage.v1beta2.ProtoRows
ProtoRows.Builder Protobuf typegoogle.cloud.bigquery.storage.v1beta2.ProtoRows
ProtoSchema ProtoSchema describes the schema of the serialized protocol buffer data rows.ProtoSchema.Builder ProtoSchema describes the schema of the serialized protocol buffer data rows.ProtoSchemaConverter ReadRowsRequest Request message for `ReadRows`.ReadRowsRequest.Builder Request message for `ReadRows`.ReadRowsResponse Response from calling `ReadRows` may include row data, progress and throttling information.ReadRowsResponse.Builder Response from calling `ReadRows` may include row data, progress and throttling information.ReadSession Information about the ReadSession.ReadSession.Builder Information about the ReadSession.ReadSession.TableModifiers Additional attributes when reading a table.ReadSession.TableModifiers.Builder Additional attributes when reading a table.ReadSession.TableReadOptions Options dictating how we read a table.ReadSession.TableReadOptions.Builder Options dictating how we read a table.ReadStream Information about a single stream that gets data out of the storage system.ReadStream.Builder Information about a single stream that gets data out of the storage system.ReadStreamName ReadStreamName.Builder Builder for projects/{project}/locations/{location}/sessions/{session}/streams/{stream}.SplitReadStreamRequest Request message for `SplitReadStream`.SplitReadStreamRequest.Builder Request message for `SplitReadStream`.SplitReadStreamResponse Protobuf typegoogle.cloud.bigquery.storage.v1beta2.SplitReadStreamResponse
SplitReadStreamResponse.Builder Protobuf typegoogle.cloud.bigquery.storage.v1beta2.SplitReadStreamResponse
StorageError Structured custom BigQuery Storage error message.StorageError.Builder Structured custom BigQuery Storage error message.StorageProto StreamConnection StreamConnection is responsible for writing requests to a GRPC bidirecional connection.StreamProto StreamStats Estimated stream statistics for a given Stream.StreamStats.Builder Estimated stream statistics for a given Stream.StreamStats.Progress Protobuf typegoogle.cloud.bigquery.storage.v1beta2.StreamStats.Progress
StreamStats.Progress.Builder Protobuf typegoogle.cloud.bigquery.storage.v1beta2.StreamStats.Progress
StreamWriterV2 A BigQuery Stream Writer that can be used to write data into BigQuery Table.StreamWriterV2.Builder A builder ofStreamWriterV2
s.TableFieldSchema A field in TableSchemaTableFieldSchema.Builder A field in TableSchemaTableName TableName.Builder Builder for projects/{project}/datasets/{dataset}/tables/{table}.TableProto TableSchema Schema of a tableTableSchema.Builder Schema of a tableThrottleState Information on if the current connection is being throttled.ThrottleState.Builder Information on if the current connection is being throttled.WriteStream Information about a single stream that gets data inside the storage system.WriteStream.Builder Information about a single stream that gets data inside the storage system.WriteStreamName WriteStreamName.Builder Builder for projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}. -
Enum Summary Enum Description AppendRowsRequest.RowsCase AppendRowsResponse.ResponseCase ArrowSerializationOptions.Format The IPC format to use when serializing Arrow streams.DataFormat Data format for input or output data.ReadRowsResponse.RowsCase ReadRowsResponse.SchemaCase ReadSession.SchemaCase StorageError.StorageErrorCode Error code for `StorageError`.TableFieldSchema.Mode Protobuf enumgoogle.cloud.bigquery.storage.v1beta2.TableFieldSchema.Mode
TableFieldSchema.Type Protobuf enumgoogle.cloud.bigquery.storage.v1beta2.TableFieldSchema.Type
WriteStream.Type Type enum of the stream.