Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BigQuery Storage: update proto / docstrings (via synth). #7461

Merged
merged 1 commit into from
Mar 1, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -220,9 +220,9 @@ def create_read_session(

If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.bigquery_storage_v1beta1.types.TableReference`
parent (str): Required. String of the form "projects/your-project-id" indicating the
project this ReadSession is associated with. This is the project that will
be billed for usage.
parent (str): 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.
table_modifiers (Union[dict, ~google.cloud.bigquery_storage_v1beta1.types.TableModifiers]): Optional. Any modifiers to the Table (e.g. snapshot timestamp).

If a dict is provided, it must be of the same form as the protobuf
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2018 Google LLC.
// 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.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2018 Google LLC.
// 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.
Expand Down Expand Up @@ -30,10 +30,13 @@ message TableReadOptions {
repeated string selected_fields = 1;

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

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2018 Google LLC.
// 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.
Expand Down Expand Up @@ -100,8 +100,8 @@ 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}`
// Name of the stream, in the form
// `projects/{project_id}/locations/{location}/streams/{stream_id}`.
string name = 1;

// Rows in the stream.
Expand All @@ -119,8 +119,8 @@ message StreamPosition {

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

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

// Required. String of the form "projects/your-project-id" indicating the
// 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.
string parent = 6;
Expand All @@ -175,6 +175,16 @@ message CreateReadSessionRequest {
DataFormat format = 5;
}

// 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.
// See https://avro.apache.org/ for more details.
AVRO = 1;
}

// Requesting row data via `ReadRows` must provide Stream position information.
message ReadRowsRequest {
// Required. Identifier of the position in the stream to start reading from.
Expand Down Expand Up @@ -256,13 +266,3 @@ message SplitReadStreamResponse {
// Remainder stream. Will contain the tail of |original_stream|.
Stream remainder_stream = 2;
}

// 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.
// See https://avro.apache.org/ for more details.
AVRO = 1;
}

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2018 Google LLC.
// 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.
Expand Down
10 changes: 5 additions & 5 deletions bigquery_storage/synth.metadata
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
{
"updateTime": "2019-01-31T13:17:09.982059Z",
"updateTime": "2019-02-28T13:10:39.155085Z",
"sources": [
{
"generator": {
"name": "artman",
"version": "0.16.7",
"dockerImage": "googleapis/artman@sha256:d6c8ced606eb49973ca95d2af7c55a681acc042db0f87d135968349e7bf6dd80"
"version": "0.16.14",
"dockerImage": "googleapis/artman@sha256:f3d61ae45abaeefb6be5f228cda22732c2f1b00fb687c79c4bd4f2c42bb1e1a7"
}
},
{
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
"sha": "9607c39973de36d319ec8861ac39a826163e21de",
"internalRef": "231680111"
"sha": "9c769d3a0e67e4df9b9e8eee480124c2700a7e6c",
"internalRef": "235997788"
}
}
],
Expand Down