Skip to content

Commit 915e116

Browse files
yoshi-automationtseaver
authored andcommitted
Update proto / docstrings (via synth). (#7461)
1 parent 35e0349 commit 915e116

File tree

8 files changed

+46
-40
lines changed

8 files changed

+46
-40
lines changed

bigquery_storage/google/cloud/bigquery_storage_v1beta1/gapic/big_query_storage_client.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -220,9 +220,9 @@ def create_read_session(
220220
221221
If a dict is provided, it must be of the same form as the protobuf
222222
message :class:`~google.cloud.bigquery_storage_v1beta1.types.TableReference`
223-
parent (str): Required. String of the form "projects/your-project-id" indicating the
224-
project this ReadSession is associated with. This is the project that will
225-
be billed for usage.
223+
parent (str): Required. String of the form ``projects/{project_id}`` indicating the
224+
project this ReadSession is associated with. This is the project that
225+
will be billed for usage.
226226
table_modifiers (Union[dict, ~google.cloud.bigquery_storage_v1beta1.types.TableModifiers]): Optional. Any modifiers to the Table (e.g. snapshot timestamp).
227227
228228
If a dict is provided, it must be of the same form as the protobuf

bigquery_storage/google/cloud/bigquery_storage_v1beta1/proto/avro.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2018 Google LLC.
1+
// Copyright 2019 Google LLC.
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.

bigquery_storage/google/cloud/bigquery_storage_v1beta1/proto/read_options.proto

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2018 Google LLC.
1+
// Copyright 2019 Google LLC.
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -30,10 +30,13 @@ message TableReadOptions {
3030
repeated string selected_fields = 1;
3131

3232
// Optional. SQL text filtering statement, similar to a WHERE clause in
33-
// a query. Currently, we support combinations of predicates that are
34-
// a comparison between a column and a constant value in SQL statement.
35-
// Aggregates are not supported.
33+
// a query. Currently, only a single predicate that is a comparison between
34+
// a column and a constant value is supported. Aggregates are not supported.
3635
//
37-
// Example: "a > DATE '2014-9-27' AND (b > 5 and C LIKE 'date')"
36+
// Examples: "int_field > 5"
37+
// "date_field = CAST('2014-9-27' as DATE)"
38+
// "nullable_field is not NULL"
39+
// "st_equals(geo_field, st_geofromtext("POINT(2, 2)"))"
40+
// "numeric_field BETWEEN 1.0 AND 5.0"
3841
string row_restriction = 2;
3942
}

bigquery_storage/google/cloud/bigquery_storage_v1beta1/proto/read_options_pb2.py

Lines changed: 7 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

bigquery_storage/google/cloud/bigquery_storage_v1beta1/proto/storage.proto

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2018 Google LLC.
1+
// Copyright 2019 Google LLC.
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -100,8 +100,8 @@ service BigQueryStorage {
100100

101101
// Information about a single data stream within a read session.
102102
message Stream {
103-
// Name of the stream. In the form
104-
// `/projects/{project_id}/stream/{stream_id}`
103+
// Name of the stream, in the form
104+
// `projects/{project_id}/locations/{location}/streams/{stream_id}`.
105105
string name = 1;
106106

107107
// Rows in the stream.
@@ -119,8 +119,8 @@ message StreamPosition {
119119

120120
// Information returned from a `CreateReadSession` request.
121121
message ReadSession {
122-
// Unique identifier for the session. In the form
123-
// `projects/{project_id}/sessions/{session_id}`
122+
// Unique identifier for the session, in the form
123+
// `projects/{project_id}/locations/{location}/sessions/{session_id}`.
124124
string name = 1;
125125

126126
// Time at which the session becomes invalid. After this time, subsequent
@@ -151,7 +151,7 @@ message CreateReadSessionRequest {
151151
// Required. Reference to the table to read.
152152
TableReference table_reference = 1;
153153

154-
// Required. String of the form "projects/your-project-id" indicating the
154+
// Required. String of the form `projects/{project_id}` indicating the
155155
// project this ReadSession is associated with. This is the project that will
156156
// be billed for usage.
157157
string parent = 6;
@@ -175,6 +175,16 @@ message CreateReadSessionRequest {
175175
DataFormat format = 5;
176176
}
177177

178+
// Data format for input or output data.
179+
enum DataFormat {
180+
// Data format is unspecified.
181+
DATA_FORMAT_UNSPECIFIED = 0;
182+
183+
// Avro is a standard open source row based file format.
184+
// See https://avro.apache.org/ for more details.
185+
AVRO = 1;
186+
}
187+
178188
// Requesting row data via `ReadRows` must provide Stream position information.
179189
message ReadRowsRequest {
180190
// Required. Identifier of the position in the stream to start reading from.
@@ -256,13 +266,3 @@ message SplitReadStreamResponse {
256266
// Remainder stream. Will contain the tail of |original_stream|.
257267
Stream remainder_stream = 2;
258268
}
259-
260-
// Data format for input or output data.
261-
enum DataFormat {
262-
// Data format is unspecified.
263-
DATA_FORMAT_UNSPECIFIED = 0;
264-
265-
// Avro is a standard open source row based file format.
266-
// See https://avro.apache.org/ for more details.
267-
AVRO = 1;
268-
}

bigquery_storage/google/cloud/bigquery_storage_v1beta1/proto/storage_pb2.py

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

bigquery_storage/google/cloud/bigquery_storage_v1beta1/proto/table_reference.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2018 Google LLC.
1+
// Copyright 2019 Google LLC.
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.

bigquery_storage/synth.metadata

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
{
2-
"updateTime": "2019-01-31T13:17:09.982059Z",
2+
"updateTime": "2019-02-28T13:10:39.155085Z",
33
"sources": [
44
{
55
"generator": {
66
"name": "artman",
7-
"version": "0.16.7",
8-
"dockerImage": "googleapis/artman@sha256:d6c8ced606eb49973ca95d2af7c55a681acc042db0f87d135968349e7bf6dd80"
7+
"version": "0.16.14",
8+
"dockerImage": "googleapis/artman@sha256:f3d61ae45abaeefb6be5f228cda22732c2f1b00fb687c79c4bd4f2c42bb1e1a7"
99
}
1010
},
1111
{
1212
"git": {
1313
"name": "googleapis",
1414
"remote": "https://github.com/googleapis/googleapis.git",
15-
"sha": "9607c39973de36d319ec8861ac39a826163e21de",
16-
"internalRef": "231680111"
15+
"sha": "9c769d3a0e67e4df9b9e8eee480124c2700a7e6c",
16+
"internalRef": "235997788"
1717
}
1818
}
1919
],

0 commit comments

Comments
 (0)