/
BaseBigQueryStorageClient.java
620 lines (588 loc) · 26.7 KB
/
BaseBigQueryStorageClient.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
/*
* Copyright 2019 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.v1beta1;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.rpc.ServerStreamingCallable;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.bigquery.storage.v1beta1.Storage.BatchCreateReadSessionStreamsRequest;
import com.google.cloud.bigquery.storage.v1beta1.Storage.BatchCreateReadSessionStreamsResponse;
import com.google.cloud.bigquery.storage.v1beta1.Storage.CreateReadSessionRequest;
import com.google.cloud.bigquery.storage.v1beta1.Storage.FinalizeStreamRequest;
import com.google.cloud.bigquery.storage.v1beta1.Storage.ReadRowsRequest;
import com.google.cloud.bigquery.storage.v1beta1.Storage.ReadRowsResponse;
import com.google.cloud.bigquery.storage.v1beta1.Storage.ReadSession;
import com.google.cloud.bigquery.storage.v1beta1.Storage.SplitReadStreamRequest;
import com.google.cloud.bigquery.storage.v1beta1.Storage.SplitReadStreamResponse;
import com.google.cloud.bigquery.storage.v1beta1.Storage.Stream;
import com.google.cloud.bigquery.storage.v1beta1.TableReferenceProto.TableReference;
import com.google.cloud.bigquery.storage.v1beta1.stub.BigQueryStorageStub;
import com.google.cloud.bigquery.storage.v1beta1.stub.BigQueryStorageStubSettings;
import com.google.protobuf.Empty;
import java.io.IOException;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND SERVICE
/**
* Service Description: BigQuery storage API.
*
* <p>The BigQuery storage API can be used to read data stored in BigQuery.
*
* <p>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:
*
* <pre>
* <code>
* try (BaseBigQueryStorageClient baseBigQueryStorageClient = BaseBigQueryStorageClient.create()) {
* TableReference tableReference = TableReference.newBuilder().build();
* String parent = "";
* int requestedStreams = 0;
* ReadSession response = baseBigQueryStorageClient.createReadSession(tableReference, parent, requestedStreams);
* }
* </code>
* </pre>
*
* <p>Note: close() needs to be called on the baseBigQueryStorageClient object to clean up resources
* such as threads. In the example above, try-with-resources is used, which automatically calls
* close().
*
* <p>The surface of this class includes several types of Java methods for each of the API's
* methods:
*
* <ol>
* <li>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.
* <li>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.
* <li>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.
* </ol>
*
* <p>See the individual methods for example code.
*
* <p>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.
*
* <p>This class can be customized by passing in a custom instance of BaseBigQueryStorageSettings to
* create(). For example:
*
* <p>To customize credentials:
*
* <pre>
* <code>
* BaseBigQueryStorageSettings baseBigQueryStorageSettings =
* BaseBigQueryStorageSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* BaseBigQueryStorageClient baseBigQueryStorageClient =
* BaseBigQueryStorageClient.create(baseBigQueryStorageSettings);
* </code>
* </pre>
*
* To customize the endpoint:
*
* <pre>
* <code>
* BaseBigQueryStorageSettings baseBigQueryStorageSettings =
* BaseBigQueryStorageSettings.newBuilder().setEndpoint(myEndpoint).build();
* BaseBigQueryStorageClient baseBigQueryStorageClient =
* BaseBigQueryStorageClient.create(baseBigQueryStorageSettings);
* </code>
* </pre>
*/
@Generated("by gapic-generator")
@BetaApi
public class BaseBigQueryStorageClient implements BackgroundResource {
private final BaseBigQueryStorageSettings settings;
private final BigQueryStorageStub stub;
/** Constructs an instance of BaseBigQueryStorageClient with default settings. */
public static final BaseBigQueryStorageClient create() throws IOException {
return create(BaseBigQueryStorageSettings.newBuilder().build());
}
/**
* Constructs an instance of BaseBigQueryStorageClient, 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 BaseBigQueryStorageClient create(BaseBigQueryStorageSettings settings)
throws IOException {
return new BaseBigQueryStorageClient(settings);
}
/**
* Constructs an instance of BaseBigQueryStorageClient, using the given stub for making calls.
* This is for advanced usage - prefer to use BaseBigQueryStorageSettings}.
*/
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public static final BaseBigQueryStorageClient create(BigQueryStorageStub stub) {
return new BaseBigQueryStorageClient(stub);
}
/**
* Constructs an instance of BaseBigQueryStorageClient, 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 BaseBigQueryStorageClient(BaseBigQueryStorageSettings settings) throws IOException {
this.settings = settings;
this.stub = ((BigQueryStorageStubSettings) settings.getStubSettings()).createStub();
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
protected BaseBigQueryStorageClient(BigQueryStorageStub stub) {
this.settings = null;
this.stub = stub;
}
public final BaseBigQueryStorageSettings getSettings() {
return settings;
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public BigQueryStorageStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Creates a new read session. A read session divides the contents of a BigQuery table into one or
* more streams, which can then be used to read data from the table. The read session also
* specifies properties of the data to be read, such as a list of columns or a push-down filter
* describing the rows to be returned.
*
* <p>A particular row can be read by at most one stream. When the caller has reached the end of
* each stream in the session, then all the data in the table has been read.
*
* <p>Read sessions automatically expire 24 hours after they are created and do not require manual
* clean-up by the caller.
*
* <p>Sample code:
*
* <pre><code>
* try (BaseBigQueryStorageClient baseBigQueryStorageClient = BaseBigQueryStorageClient.create()) {
* TableReference tableReference = TableReference.newBuilder().build();
* String parent = "";
* int requestedStreams = 0;
* ReadSession response = baseBigQueryStorageClient.createReadSession(tableReference, parent, requestedStreams);
* }
* </code></pre>
*
* @param tableReference Required. Reference to the table to read.
* @param parent Required. String of the form `projects/{project_id}` indicating the project this
* ReadSession is associated with. This is the project that will be billed for usage.
* @param requestedStreams Initial number of streams. If unset or 0, we will provide a value of
* streams so as to produce reasonable throughput. Must be non-negative. The number of streams
* may be lower than the requested number, depending on the amount parallelism that is
* reasonable for the table and the maximum amount of parallelism allowed by the system.
* <p>Streams must be read starting from offset 0.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ReadSession createReadSession(
TableReference tableReference, String parent, int requestedStreams) {
CreateReadSessionRequest request =
CreateReadSessionRequest.newBuilder()
.setTableReference(tableReference)
.setParent(parent)
.setRequestedStreams(requestedStreams)
.build();
return createReadSession(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Creates a new read session. A read session divides the contents of a BigQuery table into one or
* more streams, which can then be used to read data from the table. The read session also
* specifies properties of the data to be read, such as a list of columns or a push-down filter
* describing the rows to be returned.
*
* <p>A particular row can be read by at most one stream. When the caller has reached the end of
* each stream in the session, then all the data in the table has been read.
*
* <p>Read sessions automatically expire 24 hours after they are created and do not require manual
* clean-up by the caller.
*
* <p>Sample code:
*
* <pre><code>
* try (BaseBigQueryStorageClient baseBigQueryStorageClient = BaseBigQueryStorageClient.create()) {
* TableReference tableReference = TableReference.newBuilder().build();
* String parent = "";
* CreateReadSessionRequest request = CreateReadSessionRequest.newBuilder()
* .setTableReference(tableReference)
* .setParent(parent)
* .build();
* ReadSession response = baseBigQueryStorageClient.createReadSession(request);
* }
* </code></pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ReadSession createReadSession(CreateReadSessionRequest request) {
return createReadSessionCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Creates a new read session. A read session divides the contents of a BigQuery table into one or
* more streams, which can then be used to read data from the table. The read session also
* specifies properties of the data to be read, such as a list of columns or a push-down filter
* describing the rows to be returned.
*
* <p>A particular row can be read by at most one stream. When the caller has reached the end of
* each stream in the session, then all the data in the table has been read.
*
* <p>Read sessions automatically expire 24 hours after they are created and do not require manual
* clean-up by the caller.
*
* <p>Sample code:
*
* <pre><code>
* try (BaseBigQueryStorageClient baseBigQueryStorageClient = BaseBigQueryStorageClient.create()) {
* TableReference tableReference = TableReference.newBuilder().build();
* String parent = "";
* CreateReadSessionRequest request = CreateReadSessionRequest.newBuilder()
* .setTableReference(tableReference)
* .setParent(parent)
* .build();
* ApiFuture<ReadSession> future = baseBigQueryStorageClient.createReadSessionCallable().futureCall(request);
* // Do something
* ReadSession response = future.get();
* }
* </code></pre>
*/
public final UnaryCallable<CreateReadSessionRequest, ReadSession> createReadSessionCallable() {
return stub.createReadSessionCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Reads rows from the table in the format prescribed by the read session. Each response contains
* one or more table rows, up to a maximum of 10 MiB per response; read requests which attempt to
* read individual rows larger than this will fail.
*
* <p>Each request also returns a set of stream statistics reflecting the estimated total number
* of rows in the read stream. This number is computed based on the total table size and the
* number of active streams in the read session, and may change as other streams continue to read
* data.
*
* <p>Sample code:
*
* <pre><code>
* try (BaseBigQueryStorageClient baseBigQueryStorageClient = BaseBigQueryStorageClient.create()) {
* StreamPosition readPosition = StreamPosition.newBuilder().build();
* ReadRowsRequest request = ReadRowsRequest.newBuilder()
* .setReadPosition(readPosition)
* .build();
*
* ServerStream<ReadRowsResponse> stream = baseBigQueryStorageClient.readRowsCallable().call(request);
* for (ReadRowsResponse response : stream) {
* // Do something when receive a response
* }
* }
* </code></pre>
*/
public final ServerStreamingCallable<ReadRowsRequest, ReadRowsResponse> readRowsCallable() {
return stub.readRowsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Creates additional streams for a ReadSession. This API can be used to dynamically adjust the
* parallelism of a batch processing task upwards by adding additional workers.
*
* <p>Sample code:
*
* <pre><code>
* try (BaseBigQueryStorageClient baseBigQueryStorageClient = BaseBigQueryStorageClient.create()) {
* ReadSession session = ReadSession.newBuilder().build();
* int requestedStreams = 0;
* BatchCreateReadSessionStreamsResponse response = baseBigQueryStorageClient.batchCreateReadSessionStreams(session, requestedStreams);
* }
* </code></pre>
*
* @param session Required. Must be a non-expired session obtained from a call to
* CreateReadSession. Only the name field needs to be set.
* @param requestedStreams Required. Number of new streams requested. Must be positive. Number of
* added streams may be less than this, see CreateReadSessionRequest for more information.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final BatchCreateReadSessionStreamsResponse batchCreateReadSessionStreams(
ReadSession session, int requestedStreams) {
BatchCreateReadSessionStreamsRequest request =
BatchCreateReadSessionStreamsRequest.newBuilder()
.setSession(session)
.setRequestedStreams(requestedStreams)
.build();
return batchCreateReadSessionStreams(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Creates additional streams for a ReadSession. This API can be used to dynamically adjust the
* parallelism of a batch processing task upwards by adding additional workers.
*
* <p>Sample code:
*
* <pre><code>
* try (BaseBigQueryStorageClient baseBigQueryStorageClient = BaseBigQueryStorageClient.create()) {
* ReadSession session = ReadSession.newBuilder().build();
* int requestedStreams = 0;
* BatchCreateReadSessionStreamsRequest request = BatchCreateReadSessionStreamsRequest.newBuilder()
* .setSession(session)
* .setRequestedStreams(requestedStreams)
* .build();
* BatchCreateReadSessionStreamsResponse response = baseBigQueryStorageClient.batchCreateReadSessionStreams(request);
* }
* </code></pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final BatchCreateReadSessionStreamsResponse batchCreateReadSessionStreams(
BatchCreateReadSessionStreamsRequest request) {
return batchCreateReadSessionStreamsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Creates additional streams for a ReadSession. This API can be used to dynamically adjust the
* parallelism of a batch processing task upwards by adding additional workers.
*
* <p>Sample code:
*
* <pre><code>
* try (BaseBigQueryStorageClient baseBigQueryStorageClient = BaseBigQueryStorageClient.create()) {
* ReadSession session = ReadSession.newBuilder().build();
* int requestedStreams = 0;
* BatchCreateReadSessionStreamsRequest request = BatchCreateReadSessionStreamsRequest.newBuilder()
* .setSession(session)
* .setRequestedStreams(requestedStreams)
* .build();
* ApiFuture<BatchCreateReadSessionStreamsResponse> future = baseBigQueryStorageClient.batchCreateReadSessionStreamsCallable().futureCall(request);
* // Do something
* BatchCreateReadSessionStreamsResponse response = future.get();
* }
* </code></pre>
*/
public final UnaryCallable<
BatchCreateReadSessionStreamsRequest, BatchCreateReadSessionStreamsResponse>
batchCreateReadSessionStreamsCallable() {
return stub.batchCreateReadSessionStreamsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Triggers the graceful termination of a single stream in a ReadSession. This API can be used to
* dynamically adjust the parallelism of a batch processing task downwards without losing data.
*
* <p>This API does not delete the stream -- it remains visible in the ReadSession, and any data
* processed by the stream is not released to other streams. However, no additional data will be
* assigned to the stream once this call completes. Callers must continue reading data on the
* stream until the end of the stream is reached so that data which has already been assigned to
* the stream will be processed.
*
* <p>This method will return an error if there are no other live streams in the Session, or if
* SplitReadStream() has been called on the given Stream.
*
* <p>Sample code:
*
* <pre><code>
* try (BaseBigQueryStorageClient baseBigQueryStorageClient = BaseBigQueryStorageClient.create()) {
* Stream stream = Stream.newBuilder().build();
* baseBigQueryStorageClient.finalizeStream(stream);
* }
* </code></pre>
*
* @param stream Stream to finalize.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void finalizeStream(Stream stream) {
FinalizeStreamRequest request = FinalizeStreamRequest.newBuilder().setStream(stream).build();
finalizeStream(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Triggers the graceful termination of a single stream in a ReadSession. This API can be used to
* dynamically adjust the parallelism of a batch processing task downwards without losing data.
*
* <p>This API does not delete the stream -- it remains visible in the ReadSession, and any data
* processed by the stream is not released to other streams. However, no additional data will be
* assigned to the stream once this call completes. Callers must continue reading data on the
* stream until the end of the stream is reached so that data which has already been assigned to
* the stream will be processed.
*
* <p>This method will return an error if there are no other live streams in the Session, or if
* SplitReadStream() has been called on the given Stream.
*
* <p>Sample code:
*
* <pre><code>
* try (BaseBigQueryStorageClient baseBigQueryStorageClient = BaseBigQueryStorageClient.create()) {
* Stream stream = Stream.newBuilder().build();
* FinalizeStreamRequest request = FinalizeStreamRequest.newBuilder()
* .setStream(stream)
* .build();
* baseBigQueryStorageClient.finalizeStream(request);
* }
* </code></pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void finalizeStream(FinalizeStreamRequest request) {
finalizeStreamCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Triggers the graceful termination of a single stream in a ReadSession. This API can be used to
* dynamically adjust the parallelism of a batch processing task downwards without losing data.
*
* <p>This API does not delete the stream -- it remains visible in the ReadSession, and any data
* processed by the stream is not released to other streams. However, no additional data will be
* assigned to the stream once this call completes. Callers must continue reading data on the
* stream until the end of the stream is reached so that data which has already been assigned to
* the stream will be processed.
*
* <p>This method will return an error if there are no other live streams in the Session, or if
* SplitReadStream() has been called on the given Stream.
*
* <p>Sample code:
*
* <pre><code>
* try (BaseBigQueryStorageClient baseBigQueryStorageClient = BaseBigQueryStorageClient.create()) {
* Stream stream = Stream.newBuilder().build();
* FinalizeStreamRequest request = FinalizeStreamRequest.newBuilder()
* .setStream(stream)
* .build();
* ApiFuture<Void> future = baseBigQueryStorageClient.finalizeStreamCallable().futureCall(request);
* // Do something
* future.get();
* }
* </code></pre>
*/
public final UnaryCallable<FinalizeStreamRequest, Empty> finalizeStreamCallable() {
return stub.finalizeStreamCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Splits a given read stream into two Streams. These streams are referred to as the primary and
* the residual of the split. The original stream can still be read from in the same manner as
* before. Both of the returned streams can also be read from, and the total rows return by both
* child streams will be the same as the rows read from the original stream.
*
* <p>Moreover, the two child streams will be allocated back to back in the original Stream.
* Concretely, it is guaranteed that for streams Original, Primary, and Residual, that
* Original[0-j] = Primary[0-j] and Original[j-n] = Residual[0-m] once the streams have been read
* to completion.
*
* <p>This method is guaranteed to be idempotent.
*
* <p>Sample code:
*
* <pre><code>
* try (BaseBigQueryStorageClient baseBigQueryStorageClient = BaseBigQueryStorageClient.create()) {
* Stream originalStream = Stream.newBuilder().build();
* SplitReadStreamResponse response = baseBigQueryStorageClient.splitReadStream(originalStream);
* }
* </code></pre>
*
* @param originalStream Stream to split.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final SplitReadStreamResponse splitReadStream(Stream originalStream) {
SplitReadStreamRequest request =
SplitReadStreamRequest.newBuilder().setOriginalStream(originalStream).build();
return splitReadStream(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Splits a given read stream into two Streams. These streams are referred to as the primary and
* the residual of the split. The original stream can still be read from in the same manner as
* before. Both of the returned streams can also be read from, and the total rows return by both
* child streams will be the same as the rows read from the original stream.
*
* <p>Moreover, the two child streams will be allocated back to back in the original Stream.
* Concretely, it is guaranteed that for streams Original, Primary, and Residual, that
* Original[0-j] = Primary[0-j] and Original[j-n] = Residual[0-m] once the streams have been read
* to completion.
*
* <p>This method is guaranteed to be idempotent.
*
* <p>Sample code:
*
* <pre><code>
* try (BaseBigQueryStorageClient baseBigQueryStorageClient = BaseBigQueryStorageClient.create()) {
* Stream originalStream = Stream.newBuilder().build();
* SplitReadStreamRequest request = SplitReadStreamRequest.newBuilder()
* .setOriginalStream(originalStream)
* .build();
* SplitReadStreamResponse response = baseBigQueryStorageClient.splitReadStream(request);
* }
* </code></pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final SplitReadStreamResponse splitReadStream(SplitReadStreamRequest request) {
return splitReadStreamCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Splits a given read stream into two Streams. These streams are referred to as the primary and
* the residual of the split. The original stream can still be read from in the same manner as
* before. Both of the returned streams can also be read from, and the total rows return by both
* child streams will be the same as the rows read from the original stream.
*
* <p>Moreover, the two child streams will be allocated back to back in the original Stream.
* Concretely, it is guaranteed that for streams Original, Primary, and Residual, that
* Original[0-j] = Primary[0-j] and Original[j-n] = Residual[0-m] once the streams have been read
* to completion.
*
* <p>This method is guaranteed to be idempotent.
*
* <p>Sample code:
*
* <pre><code>
* try (BaseBigQueryStorageClient baseBigQueryStorageClient = BaseBigQueryStorageClient.create()) {
* Stream originalStream = Stream.newBuilder().build();
* SplitReadStreamRequest request = SplitReadStreamRequest.newBuilder()
* .setOriginalStream(originalStream)
* .build();
* ApiFuture<SplitReadStreamResponse> future = baseBigQueryStorageClient.splitReadStreamCallable().futureCall(request);
* // Do something
* SplitReadStreamResponse response = future.get();
* }
* </code></pre>
*/
public final UnaryCallable<SplitReadStreamRequest, SplitReadStreamResponse>
splitReadStreamCallable() {
return stub.splitReadStreamCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
}