Skip to content

Commit 71fac4c

Browse files
docs: remove stale header guidance for AppendRows (#299)
- [ ] Regenerate this pull request now. PiperOrigin-RevId: 485941276 Source-Link: https://togithub.com/googleapis/googleapis/commit/a5f5928e736ea88c03e48c506a19fa632b43de9e Source-Link: https://togithub.com/googleapis/googleapis-gen/commit/61ebfaa325101bc9b29ee34900b45b2f0d23981e Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNjFlYmZhYTMyNTEwMWJjOWIyOWVlMzQ5MDBiNDViMmYwZDIzOTgxZSJ9 BEGIN_NESTED_COMMIT chore: override API mixins when needed PiperOrigin-RevId: 477248447 Source-Link: https://togithub.com/googleapis/googleapis/commit/4689c7380444972caf11fd1b96e7ec1f864b7dfb Source-Link: https://togithub.com/googleapis/googleapis-gen/commit/c4059786a5cd805a0151d95b477fbc486bcbcedc Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYzQwNTk3ODZhNWNkODA1YTAxNTFkOTViNDc3ZmJjNDg2YmNiY2VkYyJ9 END_NESTED_COMMIT
1 parent 48db9d5 commit 71fac4c

File tree

3 files changed

+1
-15
lines changed

3 files changed

+1
-15
lines changed

packages/google-cloud-bigquery-storage/protos/google/cloud/bigquery/storage/v1/storage.proto

-7
Original file line numberDiff line numberDiff line change
@@ -167,13 +167,6 @@ service BigQueryWrite {
167167
// * For PENDING streams, data is not made visible until the stream itself is
168168
// finalized (via the `FinalizeWriteStream` rpc), and the stream is explicitly
169169
// committed via the `BatchCommitWriteStreams` rpc.
170-
//
171-
// Note: For users coding against the gRPC api directly, it may be
172-
// necessary to supply the x-goog-request-params system parameter
173-
// with `write_stream=<full_write_stream_name>`.
174-
//
175-
// More information about system parameters:
176-
// https://cloud.google.com/apis/docs/system-parameters
177170
rpc AppendRows(stream AppendRowsRequest) returns (stream AppendRowsResponse) {
178171
option (google.api.http) = {
179172
post: "/v1/{write_stream=projects/*/datasets/*/tables/*/streams/*}"

packages/google-cloud-bigquery-storage/samples/generated/v1/snippet_metadata.google.cloud.bigquery.storage.v1.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@
199199
"regionTag": "bigquerystorage_v1_generated_BigQueryWrite_AppendRows_async",
200200
"title": "BigQueryRead appendRows Sample",
201201
"origin": "API_DEFINITION",
202-
"description": " Appends data to the given stream. 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 provides an `offset` that has already been written to. User can retry with adjusted offset within the same RPC connection. If `offset` is not specified, append happens at the end of the stream. The response contains an optional offset at which the append happened. No offset information will be returned for appends to a default stream. Responses are received in the same order in which requests are sent. There will be one response for each successful inserted request. Responses may optionally embed error information if the originating AppendRequest was not successfully processed. The specifics of when successfully appended data is made visible to the table are governed by the type of stream: * For COMMITTED streams (which includes the default stream), data is visible immediately upon successful append. * For BUFFERED streams, data is made visible via a subsequent `FlushRows` rpc which advances a cursor to a newer offset in the stream. * For PENDING streams, data is not made visible until the stream itself is finalized (via the `FinalizeWriteStream` rpc), and the stream is explicitly committed via the `BatchCommitWriteStreams` rpc. Note: For users coding against the gRPC api directly, it may be necessary to supply the x-goog-request-params system parameter with `write_stream=<full_write_stream_name>`. More information about system parameters: https://cloud.google.com/apis/docs/system-parameters",
202+
"description": " Appends data to the given stream. 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 provides an `offset` that has already been written to. User can retry with adjusted offset within the same RPC connection. If `offset` is not specified, append happens at the end of the stream. The response contains an optional offset at which the append happened. No offset information will be returned for appends to a default stream. Responses are received in the same order in which requests are sent. There will be one response for each successful inserted request. Responses may optionally embed error information if the originating AppendRequest was not successfully processed. The specifics of when successfully appended data is made visible to the table are governed by the type of stream: * For COMMITTED streams (which includes the default stream), data is visible immediately upon successful append. * For BUFFERED streams, data is made visible via a subsequent `FlushRows` rpc which advances a cursor to a newer offset in the stream. * For PENDING streams, data is not made visible until the stream itself is finalized (via the `FinalizeWriteStream` rpc), and the stream is explicitly committed via the `BatchCommitWriteStreams` rpc.",
203203
"canonical": true,
204204
"file": "big_query_write.append_rows.js",
205205
"language": "JAVASCRIPT",

packages/google-cloud-bigquery-storage/src/v1/big_query_write_client.ts

-7
Original file line numberDiff line numberDiff line change
@@ -908,13 +908,6 @@ export class BigQueryWriteClient {
908908
* finalized (via the `FinalizeWriteStream` rpc), and the stream is explicitly
909909
* committed via the `BatchCommitWriteStreams` rpc.
910910
*
911-
* Note: For users coding against the gRPC api directly, it may be
912-
* necessary to supply the x-goog-request-params system parameter
913-
* with `write_stream=<full_write_stream_name>`.
914-
*
915-
* More information about system parameters:
916-
* https://cloud.google.com/apis/docs/system-parameters
917-
*
918911
* @param {object} [options]
919912
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
920913
* @returns {Stream}

0 commit comments

Comments
 (0)