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: * diff --git a/google-cloud-bigquerystorage/src/main/java/com/google/cloud/bigquery/storage/v1beta2/BigQueryWriteClient.java b/google-cloud-bigquerystorage/src/main/java/com/google/cloud/bigquery/storage/v1beta2/BigQueryWriteClient.java new file mode 100644 index 0000000000..e902043f97 --- /dev/null +++ b/google-cloud-bigquerystorage/src/main/java/com/google/cloud/bigquery/storage/v1beta2/BigQueryWriteClient.java @@ -0,0 +1,709 @@ +/* + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.google.cloud.bigquery.storage.v1beta2; + +import com.google.api.core.BetaApi; +import com.google.api.gax.core.BackgroundResource; +import com.google.api.gax.rpc.BidiStreamingCallable; +import com.google.api.gax.rpc.UnaryCallable; +import com.google.cloud.bigquery.storage.v1beta2.stub.BigQueryWriteStub; +import com.google.cloud.bigquery.storage.v1beta2.stub.BigQueryWriteStubSettings; +import java.io.IOException; +import java.util.concurrent.TimeUnit; +import javax.annotation.Generated; + +// AUTO-GENERATED DOCUMENTATION AND SERVICE +/** + * 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: + * + *
+ *
+ * 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: + * + *
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: + * + *
+ *
+ * BigQueryWriteSettings bigQueryWriteSettings =
+ * BigQueryWriteSettings.newBuilder()
+ * .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
+ * .build();
+ * BigQueryWriteClient bigQueryWriteClient =
+ * BigQueryWriteClient.create(bigQueryWriteSettings);
+ *
+ *
+ *
+ * To customize the endpoint:
+ *
+ *
+ *
+ * BigQueryWriteSettings bigQueryWriteSettings =
+ * BigQueryWriteSettings.newBuilder().setEndpoint(myEndpoint).build();
+ * BigQueryWriteClient bigQueryWriteClient =
+ * BigQueryWriteClient.create(bigQueryWriteSettings);
+ *
+ *
+ */
+@Generated("by gapic-generator")
+@BetaApi
+public class BigQueryWriteClient implements BackgroundResource {
+ private final BigQueryWriteSettings settings;
+ private final BigQueryWriteStub stub;
+
+ /** Constructs an instance of BigQueryWriteClient with default settings. */
+ public static final BigQueryWriteClient create() throws IOException {
+ return create(BigQueryWriteSettings.newBuilder().build());
+ }
+
+ /**
+ * Constructs an instance of BigQueryWriteClient, using the given settings. The channels are
+ * created based on the settings passed in, or defaults for any settings that are not set.
+ */
+ public static final BigQueryWriteClient create(BigQueryWriteSettings settings)
+ throws IOException {
+ return new BigQueryWriteClient(settings);
+ }
+
+ /**
+ * Constructs an instance of BigQueryWriteClient, using the given stub for making calls. This is
+ * for advanced usage - prefer to use BigQueryWriteSettings}.
+ */
+ @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
+ public static final BigQueryWriteClient create(BigQueryWriteStub stub) {
+ return new BigQueryWriteClient(stub);
+ }
+
+ /**
+ * Constructs an instance of BigQueryWriteClient, using the given settings. This is protected so
+ * that it is easy to make a subclass, but otherwise, the static factory methods should be
+ * preferred.
+ */
+ protected BigQueryWriteClient(BigQueryWriteSettings settings) throws IOException {
+ this.settings = settings;
+ this.stub = ((BigQueryWriteStubSettings) settings.getStubSettings()).createStub();
+ }
+
+ @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
+ protected BigQueryWriteClient(BigQueryWriteStub stub) {
+ this.settings = null;
+ this.stub = stub;
+ }
+
+ public final BigQueryWriteSettings getSettings() {
+ return settings;
+ }
+
+ @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
+ public BigQueryWriteStub getStub() {
+ return stub;
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD
+ /**
+ * Creates a write stream to the given table. Additionally, every table has a special COMMITTED
+ * stream named '_default' to which data can be written. This stream doesn't need to be created
+ * using CreateWriteStream. It is a stream that can be used simultaneously by any number of
+ * clients. Data written to this stream is considered committed as soon as an acknowledgement is
+ * received.
+ *
+ * Sample code: + * + *
+ * try (BigQueryWriteClient bigQueryWriteClient = BigQueryWriteClient.create()) {
+ * TableName parent = TableName.of("[PROJECT]", "[DATASET]", "[TABLE]");
+ * WriteStream writeStream = WriteStream.newBuilder().build();
+ * WriteStream response = bigQueryWriteClient.createWriteStream(parent, writeStream);
+ * }
+ * Sample code: + * + *
+ * try (BigQueryWriteClient bigQueryWriteClient = BigQueryWriteClient.create()) {
+ * TableName parent = TableName.of("[PROJECT]", "[DATASET]", "[TABLE]");
+ * WriteStream writeStream = WriteStream.newBuilder().build();
+ * WriteStream response = bigQueryWriteClient.createWriteStream(parent.toString(), writeStream);
+ * }
+ * Sample code: + * + *
+ * try (BigQueryWriteClient bigQueryWriteClient = BigQueryWriteClient.create()) {
+ * TableName parent = TableName.of("[PROJECT]", "[DATASET]", "[TABLE]");
+ * WriteStream writeStream = WriteStream.newBuilder().build();
+ * CreateWriteStreamRequest request = CreateWriteStreamRequest.newBuilder()
+ * .setParent(parent.toString())
+ * .setWriteStream(writeStream)
+ * .build();
+ * WriteStream response = bigQueryWriteClient.createWriteStream(request);
+ * }
+ * Sample code: + * + *
+ * try (BigQueryWriteClient bigQueryWriteClient = BigQueryWriteClient.create()) {
+ * TableName parent = TableName.of("[PROJECT]", "[DATASET]", "[TABLE]");
+ * WriteStream writeStream = WriteStream.newBuilder().build();
+ * CreateWriteStreamRequest request = CreateWriteStreamRequest.newBuilder()
+ * .setParent(parent.toString())
+ * .setWriteStream(writeStream)
+ * .build();
+ * ApiFuture<WriteStream> future = bigQueryWriteClient.createWriteStreamCallable().futureCall(request);
+ * // Do something
+ * WriteStream response = future.get();
+ * }
+ * If `offset` is specified, the `offset` is checked against the end of stream. The server + * returns `OUT_OF_RANGE` in `AppendRowsResponse` if an attempt is made to append to an offset + * beyond the current end of the stream or `ALREADY_EXISTS` if user provids an `offset` that has + * already been written to. User can retry with adjusted offset within the same RPC stream. If + * `offset` is not specified, append happens at the end of the stream. + * + *
The response contains the offset at which the append happened. Responses are received in the + * same order in which requests are sent. There will be one response for each successful request. + * If the `offset` is not set in response, it means append didn't happen due to some errors. If + * one request fails, all the subsequent requests will also fail until a success request is made + * again. + * + *
If the stream is of `PENDING` type, data will only be available for read operations after + * the stream is committed. + * + *
Sample code: + * + *
+ * try (BigQueryWriteClient bigQueryWriteClient = BigQueryWriteClient.create()) {
+ * BidiStream<AppendRowsRequest, AppendRowsResponse> bidiStream =
+ * bigQueryWriteClient.appendRowsCallable().call();
+ *
+ * WriteStreamName writeStream = WriteStreamName.of("[PROJECT]", "[DATASET]", "[TABLE]", "[STREAM]");
+ * AppendRowsRequest request = AppendRowsRequest.newBuilder()
+ * .setWriteStream(writeStream.toString())
+ * .build();
+ * bidiStream.send(request);
+ * for (AppendRowsResponse response : bidiStream) {
+ * // Do something when receive a response
+ * }
+ * }
+ * Sample code: + * + *
+ * try (BigQueryWriteClient bigQueryWriteClient = BigQueryWriteClient.create()) {
+ * WriteStreamName name = WriteStreamName.of("[PROJECT]", "[DATASET]", "[TABLE]", "[STREAM]");
+ * WriteStream response = bigQueryWriteClient.getWriteStream(name);
+ * }
+ * Sample code: + * + *
+ * try (BigQueryWriteClient bigQueryWriteClient = BigQueryWriteClient.create()) {
+ * WriteStreamName name = WriteStreamName.of("[PROJECT]", "[DATASET]", "[TABLE]", "[STREAM]");
+ * WriteStream response = bigQueryWriteClient.getWriteStream(name.toString());
+ * }
+ * Sample code: + * + *
+ * try (BigQueryWriteClient bigQueryWriteClient = BigQueryWriteClient.create()) {
+ * WriteStreamName name = WriteStreamName.of("[PROJECT]", "[DATASET]", "[TABLE]", "[STREAM]");
+ * GetWriteStreamRequest request = GetWriteStreamRequest.newBuilder()
+ * .setName(name.toString())
+ * .build();
+ * WriteStream response = bigQueryWriteClient.getWriteStream(request);
+ * }
+ * Sample code: + * + *
+ * try (BigQueryWriteClient bigQueryWriteClient = BigQueryWriteClient.create()) {
+ * WriteStreamName name = WriteStreamName.of("[PROJECT]", "[DATASET]", "[TABLE]", "[STREAM]");
+ * GetWriteStreamRequest request = GetWriteStreamRequest.newBuilder()
+ * .setName(name.toString())
+ * .build();
+ * ApiFuture<WriteStream> future = bigQueryWriteClient.getWriteStreamCallable().futureCall(request);
+ * // Do something
+ * WriteStream response = future.get();
+ * }
+ * Sample code: + * + *
+ * try (BigQueryWriteClient bigQueryWriteClient = BigQueryWriteClient.create()) {
+ * WriteStreamName name = WriteStreamName.of("[PROJECT]", "[DATASET]", "[TABLE]", "[STREAM]");
+ * FinalizeWriteStreamResponse response = bigQueryWriteClient.finalizeWriteStream(name);
+ * }
+ * Sample code: + * + *
+ * try (BigQueryWriteClient bigQueryWriteClient = BigQueryWriteClient.create()) {
+ * WriteStreamName name = WriteStreamName.of("[PROJECT]", "[DATASET]", "[TABLE]", "[STREAM]");
+ * FinalizeWriteStreamResponse response = bigQueryWriteClient.finalizeWriteStream(name.toString());
+ * }
+ * Sample code: + * + *
+ * try (BigQueryWriteClient bigQueryWriteClient = BigQueryWriteClient.create()) {
+ * WriteStreamName name = WriteStreamName.of("[PROJECT]", "[DATASET]", "[TABLE]", "[STREAM]");
+ * FinalizeWriteStreamRequest request = FinalizeWriteStreamRequest.newBuilder()
+ * .setName(name.toString())
+ * .build();
+ * FinalizeWriteStreamResponse response = bigQueryWriteClient.finalizeWriteStream(request);
+ * }
+ * Sample code: + * + *
+ * try (BigQueryWriteClient bigQueryWriteClient = BigQueryWriteClient.create()) {
+ * WriteStreamName name = WriteStreamName.of("[PROJECT]", "[DATASET]", "[TABLE]", "[STREAM]");
+ * FinalizeWriteStreamRequest request = FinalizeWriteStreamRequest.newBuilder()
+ * .setName(name.toString())
+ * .build();
+ * ApiFuture<FinalizeWriteStreamResponse> future = bigQueryWriteClient.finalizeWriteStreamCallable().futureCall(request);
+ * // Do something
+ * FinalizeWriteStreamResponse response = future.get();
+ * }
+ * Sample code: + * + *
+ * try (BigQueryWriteClient bigQueryWriteClient = BigQueryWriteClient.create()) {
+ * String parent = "";
+ * BatchCommitWriteStreamsResponse response = bigQueryWriteClient.batchCommitWriteStreams(parent);
+ * }
+ * Sample code: + * + *
+ * try (BigQueryWriteClient bigQueryWriteClient = BigQueryWriteClient.create()) {
+ * String parent = "";
+ * List<String> writeStreams = new ArrayList<>();
+ * BatchCommitWriteStreamsRequest request = BatchCommitWriteStreamsRequest.newBuilder()
+ * .setParent(parent)
+ * .addAllWriteStreams(writeStreams)
+ * .build();
+ * BatchCommitWriteStreamsResponse response = bigQueryWriteClient.batchCommitWriteStreams(request);
+ * }
+ * Sample code: + * + *
+ * try (BigQueryWriteClient bigQueryWriteClient = BigQueryWriteClient.create()) {
+ * String parent = "";
+ * List<String> writeStreams = new ArrayList<>();
+ * BatchCommitWriteStreamsRequest request = BatchCommitWriteStreamsRequest.newBuilder()
+ * .setParent(parent)
+ * .addAllWriteStreams(writeStreams)
+ * .build();
+ * ApiFuture<BatchCommitWriteStreamsResponse> future = bigQueryWriteClient.batchCommitWriteStreamsCallable().futureCall(request);
+ * // Do something
+ * BatchCommitWriteStreamsResponse response = future.get();
+ * }
+ * Sample code: + * + *
+ * try (BigQueryWriteClient bigQueryWriteClient = BigQueryWriteClient.create()) {
+ * WriteStreamName writeStream = WriteStreamName.of("[PROJECT]", "[DATASET]", "[TABLE]", "[STREAM]");
+ * FlushRowsResponse response = bigQueryWriteClient.flushRows(writeStream);
+ * }
+ * Sample code: + * + *
+ * try (BigQueryWriteClient bigQueryWriteClient = BigQueryWriteClient.create()) {
+ * WriteStreamName writeStream = WriteStreamName.of("[PROJECT]", "[DATASET]", "[TABLE]", "[STREAM]");
+ * FlushRowsResponse response = bigQueryWriteClient.flushRows(writeStream.toString());
+ * }
+ * Sample code: + * + *
+ * try (BigQueryWriteClient bigQueryWriteClient = BigQueryWriteClient.create()) {
+ * WriteStreamName writeStream = WriteStreamName.of("[PROJECT]", "[DATASET]", "[TABLE]", "[STREAM]");
+ * FlushRowsRequest request = FlushRowsRequest.newBuilder()
+ * .setWriteStream(writeStream.toString())
+ * .build();
+ * FlushRowsResponse response = bigQueryWriteClient.flushRows(request);
+ * }
+ * Sample code: + * + *
+ * try (BigQueryWriteClient bigQueryWriteClient = BigQueryWriteClient.create()) {
+ * WriteStreamName writeStream = WriteStreamName.of("[PROJECT]", "[DATASET]", "[TABLE]", "[STREAM]");
+ * FlushRowsRequest request = FlushRowsRequest.newBuilder()
+ * .setWriteStream(writeStream.toString())
+ * .build();
+ * ApiFuture<FlushRowsResponse> future = bigQueryWriteClient.flushRowsCallable().futureCall(request);
+ * // Do something
+ * FlushRowsResponse response = future.get();
+ * }
+ * The default instance has everything set to sensible defaults: + * + *
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: + * + *
+ *
+ * BigQueryWriteSettings.Builder bigQueryWriteSettingsBuilder =
+ * BigQueryWriteSettings.newBuilder();
+ * bigQueryWriteSettingsBuilder
+ * .createWriteStreamSettings()
+ * .setRetrySettings(
+ * bigQueryWriteSettingsBuilder.createWriteStreamSettings().getRetrySettings().toBuilder()
+ * .setTotalTimeout(Duration.ofSeconds(30))
+ * .build());
+ * BigQueryWriteSettings bigQueryWriteSettings = bigQueryWriteSettingsBuilder.build();
+ *
+ *
+ */
+@Generated("by gapic-generator")
+@BetaApi
+public class BigQueryWriteSettings extends ClientSettingsNote: This method does not support applying settings to streaming methods.
+ */
+ public Builder applyToAllUnaryMethods(
+ ApiFunction 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:
*
* Service Description: BigQuery Write API.
+ *
+ * The Write API can be used to write data to BigQuery.
+ *
+ * Sample for BigQueryWriteClient:
+ *
+ * The default instance has everything set to sensible defaults:
+ *
+ * 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:
+ *
+ * Note: This method does not support applying settings to streaming methods.
+ */
+ public Builder applyToAllUnaryMethods(
+ ApiFunction This class is for advanced usage.
+ */
+@Generated("by gapic-generator")
+@BetaApi("The surface for use by generated code is not stable yet and may change in the future.")
+public class GrpcBigQueryWriteCallableFactory implements GrpcStubCallableFactory {
+ @Override
+ public This class is for advanced usage and reflects the underlying API directly.
+ */
+@Generated("by gapic-generator")
+@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
+public class GrpcBigQueryWriteStub extends BigQueryWriteStub {
+
+ private static final MethodDescriptor
@@ -37,6 +40,24 @@
* }
*
*
+ *
+ * =================== BigQueryWriteClient ===================
+ *
+ *
+ *
*/
@Generated("by gapic-generator")
package com.google.cloud.bigquery.storage.v1beta2;
diff --git a/google-cloud-bigquerystorage/src/main/java/com/google/cloud/bigquery/storage/v1beta2/stub/BigQueryReadStubSettings.java b/google-cloud-bigquerystorage/src/main/java/com/google/cloud/bigquery/storage/v1beta2/stub/BigQueryReadStubSettings.java
index 8befe08c88..1e9f940a35 100644
--- a/google-cloud-bigquerystorage/src/main/java/com/google/cloud/bigquery/storage/v1beta2/stub/BigQueryReadStubSettings.java
+++ b/google-cloud-bigquerystorage/src/main/java/com/google/cloud/bigquery/storage/v1beta2/stub/BigQueryReadStubSettings.java
@@ -85,6 +85,7 @@ public class BigQueryReadStubSettings extends StubSettings
+ * try (BigQueryWriteClient bigQueryWriteClient = BigQueryWriteClient.create()) {
+ * TableName parent = TableName.of("[PROJECT]", "[DATASET]", "[TABLE]");
+ * WriteStream writeStream = WriteStream.newBuilder().build();
+ * WriteStream response = bigQueryWriteClient.createWriteStream(parent, writeStream);
+ * }
+ *
+ *
+ *
+ *
+ *
+ *
+ */
+@Generated("by gapic-generator")
+@BetaApi
+public class BigQueryWriteStubSettings extends StubSettings
+ * BigQueryWriteStubSettings.Builder bigQueryWriteSettingsBuilder =
+ * BigQueryWriteStubSettings.newBuilder();
+ * bigQueryWriteSettingsBuilder
+ * .createWriteStreamSettings()
+ * .setRetrySettings(
+ * bigQueryWriteSettingsBuilder.createWriteStreamSettings().getRetrySettings().toBuilder()
+ * .setTotalTimeout(Duration.ofSeconds(30))
+ * .build());
+ * BigQueryWriteStubSettings bigQueryWriteSettings = bigQueryWriteSettingsBuilder.build();
+ *
+ *