From f1c5b96d88678098c6ddc66ac3e536ac9b86dc23 Mon Sep 17 00:00:00 2001
From: Yoshi Automation Bot
<44816363+yoshi-automation@users.noreply.github.com>
Date: Wed, 14 Nov 2018 15:01:29 -0800
Subject: [PATCH] Regenerate bigquerystorage client (#3939)
Adds documentation strings
---
.../bigquery/storage/v1beta1/Storage.java | 172 ++++++++++++++++++
.../bigquery/storage/v1beta1/storage.proto | 19 ++
2 files changed, 191 insertions(+)
diff --git a/google-api-grpc/proto-google-cloud-bigquerystorage-v1beta1/src/main/java/com/google/cloud/bigquery/storage/v1beta1/Storage.java b/google-api-grpc/proto-google-cloud-bigquerystorage-v1beta1/src/main/java/com/google/cloud/bigquery/storage/v1beta1/Storage.java
index b5abc716ecac..fda98e6fad9b 100644
--- a/google-api-grpc/proto-google-cloud-bigquerystorage-v1beta1/src/main/java/com/google/cloud/bigquery/storage/v1beta1/Storage.java
+++ b/google-api-grpc/proto-google-cloud-bigquerystorage-v1beta1/src/main/java/com/google/cloud/bigquery/storage/v1beta1/Storage.java
@@ -24,6 +24,10 @@ public static void registerAllExtensions(
public enum DataFormat
implements com.google.protobuf.ProtocolMessageEnum {
/**
+ *
+ * Data format is unspecified.
+ *
+ *
* DATA_FORMAT_UNSPECIFIED = 0;
*/
DATA_FORMAT_UNSPECIFIED(0),
@@ -40,6 +44,10 @@ public enum DataFormat
;
/**
+ *
+ * Data format is unspecified.
+ *
+ *
* DATA_FORMAT_UNSPECIFIED = 0;
*/
public static final int DATA_FORMAT_UNSPECIFIED_VALUE = 0;
@@ -160,6 +168,10 @@ public interface StreamOrBuilder extends
long getRowCount();
}
/**
+ *
+ * Information about a single data stream within a read session.
+ *
+ *
* Protobuf type {@code google.cloud.bigquery.storage.v1beta1.Stream}
*/
public static final class Stream extends
@@ -468,6 +480,10 @@ protected Builder newBuilderForType(
return builder;
}
/**
+ *
+ * Information about a single data stream within a read session.
+ *
+ *
* Protobuf type {@code google.cloud.bigquery.storage.v1beta1.Stream}
*/
public static final class Builder extends
@@ -810,14 +826,26 @@ public interface StreamPositionOrBuilder extends
com.google.protobuf.MessageOrBuilder {
/**
+ *
+ * Identifier for a given Stream.
+ *
+ *
* .google.cloud.bigquery.storage.v1beta1.Stream stream = 1;
*/
boolean hasStream();
/**
+ *
+ * Identifier for a given Stream.
+ *
+ *
* .google.cloud.bigquery.storage.v1beta1.Stream stream = 1;
*/
com.google.cloud.bigquery.storage.v1beta1.Storage.Stream getStream();
/**
+ *
+ * Identifier for a given Stream.
+ *
+ *
* .google.cloud.bigquery.storage.v1beta1.Stream stream = 1;
*/
com.google.cloud.bigquery.storage.v1beta1.Storage.StreamOrBuilder getStreamOrBuilder();
@@ -832,6 +860,10 @@ public interface StreamPositionOrBuilder extends
long getOffset();
}
/**
+ *
+ * Expresses a point within a given stream using an offset position.
+ *
+ *
* Protobuf type {@code google.cloud.bigquery.storage.v1beta1.StreamPosition}
*/
public static final class StreamPosition extends
@@ -924,18 +956,30 @@ private StreamPosition(
public static final int STREAM_FIELD_NUMBER = 1;
private com.google.cloud.bigquery.storage.v1beta1.Storage.Stream stream_;
/**
+ *
+ * Identifier for a given Stream.
+ *
+ *
* .google.cloud.bigquery.storage.v1beta1.Stream stream = 1;
*/
public boolean hasStream() {
return stream_ != null;
}
/**
+ *
+ * Identifier for a given Stream.
+ *
+ *
* .google.cloud.bigquery.storage.v1beta1.Stream stream = 1;
*/
public com.google.cloud.bigquery.storage.v1beta1.Storage.Stream getStream() {
return stream_ == null ? com.google.cloud.bigquery.storage.v1beta1.Storage.Stream.getDefaultInstance() : stream_;
}
/**
+ *
+ * Identifier for a given Stream.
+ *
+ *
* .google.cloud.bigquery.storage.v1beta1.Stream stream = 1;
*/
public com.google.cloud.bigquery.storage.v1beta1.Storage.StreamOrBuilder getStreamOrBuilder() {
@@ -1129,6 +1173,10 @@ protected Builder newBuilderForType(
return builder;
}
/**
+ *
+ * Expresses a point within a given stream using an offset position.
+ *
+ *
* Protobuf type {@code google.cloud.bigquery.storage.v1beta1.StreamPosition}
*/
public static final class Builder extends
@@ -1293,12 +1341,20 @@ public Builder mergeFrom(
private com.google.protobuf.SingleFieldBuilderV3<
com.google.cloud.bigquery.storage.v1beta1.Storage.Stream, com.google.cloud.bigquery.storage.v1beta1.Storage.Stream.Builder, com.google.cloud.bigquery.storage.v1beta1.Storage.StreamOrBuilder> streamBuilder_;
/**
+ *
+ * Identifier for a given Stream.
+ *
+ *
* .google.cloud.bigquery.storage.v1beta1.Stream stream = 1;
*/
public boolean hasStream() {
return streamBuilder_ != null || stream_ != null;
}
/**
+ *
+ * Identifier for a given Stream.
+ *
+ *
* .google.cloud.bigquery.storage.v1beta1.Stream stream = 1;
*/
public com.google.cloud.bigquery.storage.v1beta1.Storage.Stream getStream() {
@@ -1309,6 +1365,10 @@ public com.google.cloud.bigquery.storage.v1beta1.Storage.Stream getStream() {
}
}
/**
+ *
+ * Identifier for a given Stream.
+ *
+ *
* .google.cloud.bigquery.storage.v1beta1.Stream stream = 1;
*/
public Builder setStream(com.google.cloud.bigquery.storage.v1beta1.Storage.Stream value) {
@@ -1325,6 +1385,10 @@ public Builder setStream(com.google.cloud.bigquery.storage.v1beta1.Storage.Strea
return this;
}
/**
+ *
+ * Identifier for a given Stream.
+ *
+ *
* .google.cloud.bigquery.storage.v1beta1.Stream stream = 1;
*/
public Builder setStream(
@@ -1339,6 +1403,10 @@ public Builder setStream(
return this;
}
/**
+ *
+ * Identifier for a given Stream.
+ *
+ *
* .google.cloud.bigquery.storage.v1beta1.Stream stream = 1;
*/
public Builder mergeStream(com.google.cloud.bigquery.storage.v1beta1.Storage.Stream value) {
@@ -1357,6 +1425,10 @@ public Builder mergeStream(com.google.cloud.bigquery.storage.v1beta1.Storage.Str
return this;
}
/**
+ *
+ * Identifier for a given Stream.
+ *
+ *
* .google.cloud.bigquery.storage.v1beta1.Stream stream = 1;
*/
public Builder clearStream() {
@@ -1371,6 +1443,10 @@ public Builder clearStream() {
return this;
}
/**
+ *
+ * Identifier for a given Stream.
+ *
+ *
* .google.cloud.bigquery.storage.v1beta1.Stream stream = 1;
*/
public com.google.cloud.bigquery.storage.v1beta1.Storage.Stream.Builder getStreamBuilder() {
@@ -1379,6 +1455,10 @@ public com.google.cloud.bigquery.storage.v1beta1.Storage.Stream.Builder getStrea
return getStreamFieldBuilder().getBuilder();
}
/**
+ *
+ * Identifier for a given Stream.
+ *
+ *
* .google.cloud.bigquery.storage.v1beta1.Stream stream = 1;
*/
public com.google.cloud.bigquery.storage.v1beta1.Storage.StreamOrBuilder getStreamOrBuilder() {
@@ -1390,6 +1470,10 @@ public com.google.cloud.bigquery.storage.v1beta1.Storage.StreamOrBuilder getStre
}
}
/**
+ *
+ * Identifier for a given Stream.
+ *
+ *
* .google.cloud.bigquery.storage.v1beta1.Stream stream = 1;
*/
private com.google.protobuf.SingleFieldBuilderV3<
@@ -1670,6 +1754,10 @@ com.google.cloud.bigquery.storage.v1beta1.Storage.StreamOrBuilder getStreamsOrBu
public com.google.cloud.bigquery.storage.v1beta1.Storage.ReadSession.SchemaCase getSchemaCase();
}
/**
+ *
+ * Information returned from a `CreateReadSession` request.
+ *
+ *
* Protobuf type {@code google.cloud.bigquery.storage.v1beta1.ReadSession}
*/
public static final class ReadSession extends
@@ -2332,6 +2420,10 @@ protected Builder newBuilderForType(
return builder;
}
/**
+ *
+ * Information returned from a `CreateReadSession` request.
+ *
+ *
* Protobuf type {@code google.cloud.bigquery.storage.v1beta1.ReadSession}
*/
public static final class Builder extends
@@ -3832,6 +3924,11 @@ public interface CreateReadSessionRequestOrBuilder extends
com.google.cloud.bigquery.storage.v1beta1.Storage.DataFormat getFormat();
}
/**
+ *
+ * Creates a new read session, which may include additional options such as
+ * requested parallelism, projection filters and constraints.
+ *
+ *
* Protobuf type {@code google.cloud.bigquery.storage.v1beta1.CreateReadSessionRequest}
*/
public static final class CreateReadSessionRequest extends
@@ -4374,6 +4471,11 @@ protected Builder newBuilderForType(
return builder;
}
/**
+ *
+ * Creates a new read session, which may include additional options such as
+ * requested parallelism, projection filters and constraints.
+ *
+ *
* Protobuf type {@code google.cloud.bigquery.storage.v1beta1.CreateReadSessionRequest}
*/
public static final class Builder extends
@@ -5339,6 +5441,10 @@ public interface ReadRowsRequestOrBuilder extends
com.google.cloud.bigquery.storage.v1beta1.Storage.StreamPositionOrBuilder getReadPositionOrBuilder();
}
/**
+ *
+ * Requesting row data via `ReadRows` must provide Stream position information.
+ *
+ *
* Protobuf type {@code google.cloud.bigquery.storage.v1beta1.ReadRowsRequest}
*/
public static final class ReadRowsRequest extends
@@ -5623,6 +5729,10 @@ protected Builder newBuilderForType(
return builder;
}
/**
+ *
+ * Requesting row data via `ReadRows` must provide Stream position information.
+ *
+ *
* Protobuf type {@code google.cloud.bigquery.storage.v1beta1.ReadRowsRequest}
*/
public static final class Builder extends
@@ -6016,6 +6126,10 @@ public interface StreamStatusOrBuilder extends
long getEstimatedRowCount();
}
/**
+ *
+ * Progress information for a given Stream.
+ *
+ *
* Protobuf type {@code google.cloud.bigquery.storage.v1beta1.StreamStatus}
*/
public static final class StreamStatus extends
@@ -6265,6 +6379,10 @@ protected Builder newBuilderForType(
return builder;
}
/**
+ *
+ * Progress information for a given Stream.
+ *
+ *
* Protobuf type {@code google.cloud.bigquery.storage.v1beta1.StreamStatus}
*/
public static final class Builder extends
@@ -7101,6 +7219,11 @@ public interface ReadRowsResponseOrBuilder extends
public com.google.cloud.bigquery.storage.v1beta1.Storage.ReadRowsResponse.RowsCase getRowsCase();
}
/**
+ *
+ * Response from calling `ReadRows` may include row data, progress and
+ * throttling information.
+ *
+ *
* Protobuf type {@code google.cloud.bigquery.storage.v1beta1.ReadRowsResponse}
*/
public static final class ReadRowsResponse extends
@@ -7558,6 +7681,11 @@ protected Builder newBuilderForType(
return builder;
}
/**
+ *
+ * Response from calling `ReadRows` may include row data, progress and
+ * throttling information.
+ *
+ *
* Protobuf type {@code google.cloud.bigquery.storage.v1beta1.ReadRowsResponse}
*/
public static final class Builder extends
@@ -8343,6 +8471,11 @@ public interface BatchCreateReadSessionStreamsRequestOrBuilder extends
int getRequestedStreams();
}
/**
+ *
+ * Information needed to request additional streams for an established read
+ * session.
+ *
+ *
* Protobuf type {@code google.cloud.bigquery.storage.v1beta1.BatchCreateReadSessionStreamsRequest}
*/
public static final class BatchCreateReadSessionStreamsRequest extends
@@ -8656,6 +8789,11 @@ protected Builder newBuilderForType(
return builder;
}
/**
+ *
+ * Information needed to request additional streams for an established read
+ * session.
+ *
+ *
* Protobuf type {@code google.cloud.bigquery.storage.v1beta1.BatchCreateReadSessionStreamsRequest}
*/
public static final class Builder extends
@@ -9123,6 +9261,11 @@ com.google.cloud.bigquery.storage.v1beta1.Storage.StreamOrBuilder getStreamsOrBu
int index);
}
/**
+ *
+ * The response from `BatchCreateReadSessionStreams` returns the stream
+ * identifiers for the newly created streams.
+ *
+ *
* Protobuf type {@code google.cloud.bigquery.storage.v1beta1.BatchCreateReadSessionStreamsResponse}
*/
public static final class BatchCreateReadSessionStreamsResponse extends
@@ -9420,6 +9563,11 @@ protected Builder newBuilderForType(
return builder;
}
/**
+ *
+ * The response from `BatchCreateReadSessionStreams` returns the stream
+ * identifiers for the newly created streams.
+ *
+ *
* Protobuf type {@code google.cloud.bigquery.storage.v1beta1.BatchCreateReadSessionStreamsResponse}
*/
public static final class Builder extends
@@ -9998,6 +10146,10 @@ public interface FinalizeStreamRequestOrBuilder extends
com.google.cloud.bigquery.storage.v1beta1.Storage.StreamOrBuilder getStreamOrBuilder();
}
/**
+ *
+ * Request information for invoking `FinalizeStream`.
+ *
+ *
* Protobuf type {@code google.cloud.bigquery.storage.v1beta1.FinalizeStreamRequest}
*/
public static final class FinalizeStreamRequest extends
@@ -10276,6 +10428,10 @@ protected Builder newBuilderForType(
return builder;
}
/**
+ *
+ * Request information for invoking `FinalizeStream`.
+ *
+ *
* Protobuf type {@code google.cloud.bigquery.storage.v1beta1.FinalizeStreamRequest}
*/
public static final class Builder extends
@@ -10665,6 +10821,10 @@ public interface SplitReadStreamRequestOrBuilder extends
com.google.cloud.bigquery.storage.v1beta1.Storage.StreamOrBuilder getOriginalStreamOrBuilder();
}
/**
+ *
+ * Request information for `SplitReadStream`.
+ *
+ *
* Protobuf type {@code google.cloud.bigquery.storage.v1beta1.SplitReadStreamRequest}
*/
public static final class SplitReadStreamRequest extends
@@ -10943,6 +11103,10 @@ protected Builder newBuilderForType(
return builder;
}
/**
+ *
+ * Request information for `SplitReadStream`.
+ *
+ *
* Protobuf type {@code google.cloud.bigquery.storage.v1beta1.SplitReadStreamRequest}
*/
public static final class Builder extends
@@ -11360,6 +11524,10 @@ public interface SplitReadStreamResponseOrBuilder extends
com.google.cloud.bigquery.storage.v1beta1.Storage.StreamOrBuilder getRemainderStreamOrBuilder();
}
/**
+ *
+ * Response from `SplitReadStream`.
+ *
+ *
* Protobuf type {@code google.cloud.bigquery.storage.v1beta1.SplitReadStreamResponse}
*/
public static final class SplitReadStreamResponse extends
@@ -11703,6 +11871,10 @@ protected Builder newBuilderForType(
return builder;
}
/**
+ *
+ * Response from `SplitReadStream`.
+ *
+ *
* Protobuf type {@code google.cloud.bigquery.storage.v1beta1.SplitReadStreamResponse}
*/
public static final class Builder extends
diff --git a/google-api-grpc/proto-google-cloud-bigquerystorage-v1beta1/src/main/proto/google/cloud/bigquery/storage/v1beta1/storage.proto b/google-api-grpc/proto-google-cloud-bigquerystorage-v1beta1/src/main/proto/google/cloud/bigquery/storage/v1beta1/storage.proto
index a81e8344d21f..7396355f0ed5 100644
--- a/google-api-grpc/proto-google-cloud-bigquerystorage-v1beta1/src/main/proto/google/cloud/bigquery/storage/v1beta1/storage.proto
+++ b/google-api-grpc/proto-google-cloud-bigquerystorage-v1beta1/src/main/proto/google/cloud/bigquery/storage/v1beta1/storage.proto
@@ -98,6 +98,7 @@ service BigQueryStorage {
}
}
+// Information about a single data stream within a read session.
message Stream {
// Name of the stream. In the form
// `/projects/{project_id}/stream/{stream_id}`
@@ -107,13 +108,16 @@ message Stream {
int64 row_count = 2;
}
+// Expresses a point within a given stream using an offset position.
message StreamPosition {
+ // Identifier for a given Stream.
Stream stream = 1;
// Position in the stream.
int64 offset = 2;
}
+// Information returned from a `CreateReadSession` request.
message ReadSession {
// Unique identifier for the session. In the form
// `projects/{project_id}/sessions/{session_id}`
@@ -141,6 +145,8 @@ message ReadSession {
TableModifiers table_modifiers = 8;
}
+// Creates a new read session, which may include additional options such as
+// requested parallelism, projection filters and constraints.
message CreateReadSessionRequest {
// Required. Reference to the table to read.
TableReference table_reference = 1;
@@ -169,6 +175,7 @@ message CreateReadSessionRequest {
DataFormat format = 5;
}
+// Requesting row data via `ReadRows` must provide Stream position information.
message ReadRowsRequest {
// Required. Identifier of the position in the stream to start reading from.
// The offset requested must be less than the last row read from ReadRows.
@@ -176,6 +183,7 @@ message ReadRowsRequest {
StreamPosition read_position = 1;
}
+// Progress information for a given Stream.
message StreamStatus {
// Number of estimated rows in the current stream. May change over time as
// different readers in the stream progress at rates which are relatively fast
@@ -190,7 +198,10 @@ message ThrottleStatus {
int32 throttle_percent = 1;
}
+// Response from calling `ReadRows` may include row data, progress and
+// throttling information.
message ReadRowsResponse {
+ // Row data is returned in format specified during session creation.
oneof rows {
// Serialized row data in AVRO format.
AvroRows avro_rows = 3;
@@ -204,6 +215,8 @@ message ReadRowsResponse {
ThrottleStatus throttle_status = 5;
}
+// Information needed to request additional streams for an established read
+// session.
message BatchCreateReadSessionStreamsRequest {
// Required. Must be a non-expired session obtained from a call to
// CreateReadSession. Only the name field needs to be set.
@@ -215,21 +228,26 @@ message BatchCreateReadSessionStreamsRequest {
int32 requested_streams = 2;
}
+// The response from `BatchCreateReadSessionStreams` returns the stream
+// identifiers for the newly created streams.
message BatchCreateReadSessionStreamsResponse {
// Newly added streams.
repeated Stream streams = 1;
}
+// Request information for invoking `FinalizeStream`.
message FinalizeStreamRequest {
// Stream to finalize.
Stream stream = 2;
}
+// Request information for `SplitReadStream`.
message SplitReadStreamRequest {
// Stream to split.
Stream original_stream = 1;
}
+// Response from `SplitReadStream`.
message SplitReadStreamResponse {
// Primary stream. Will contain the beginning portion of
// |original_stream|.
@@ -241,6 +259,7 @@ message SplitReadStreamResponse {
// Data format for input or output data.
enum DataFormat {
+ // Data format is unspecified.
DATA_FORMAT_UNSPECIFIED = 0;
// Avro is a standard open source row based file format.