GlcoinCore/googleapis
1
0
Fork 0
mirror of https://github.com/googleapis/googleapis.git synced 2026-08-16 13:00:34 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Sync generated comments from the API Protos

Browse source 
PiperOrigin-RevId: 785555034
This commit is contained in:
Google APIs 2025-07-21 13:29:44 -07:00 • committed by Copybara-Service
parent 80f547be98
commit 5feffd9408
4 changed files with 32 additions and 47 deletions
Download patch file Download diff file Expand all files Collapse all files

72
google/bigtable/v2/bigtable.proto
View file

@ -251,10 +251,10 @@ service Bigtable {
"table_name,row_key,rules,app_profile_id";
}
// NOTE: This API is intended to be used by Apache Beam BigtableIO.
// Returns the current list of partitions that make up the table's
// change stream. The union of partitions will cover the entire keyspace.
// Partitions can be read with `ReadChangeStream`.
// NOTE: This API is only intended to be used by Apache Beam BigtableIO.
rpc GenerateInitialChangeStreamPartitions(
GenerateInitialChangeStreamPartitionsRequest)
returns (stream GenerateInitialChangeStreamPartitionsResponse) {
@ -266,10 +266,10 @@ service Bigtable {
option (google.api.method_signature) = "table_name,app_profile_id";
}
// NOTE: This API is intended to be used by Apache Beam BigtableIO.
// Reads changes from a table's change stream. Changes will
// reflect both user-initiated mutations and mutations that are caused by
// garbage collection.
// NOTE: This API is only intended to be used by Apache Beam BigtableIO.
rpc ReadChangeStream(ReadChangeStreamRequest)
returns (stream ReadChangeStreamResponse) {
option (google.api.http) = {
@ -478,26 +478,11 @@ message ReadRowsResponse {
// key, allowing the client to skip that work on a retry.
bytes last_scanned_row_key = 2;
//
// If requested, provide enhanced query performance statistics. The semantics
// dictate:
// * request_stats is empty on every (streamed) response, except
// * request_stats has non-empty information after all chunks have been
// streamed, where the ReadRowsResponse message only contains
// request_stats.
// * For example, if a read request would have returned an empty
// response instead a single ReadRowsResponse is streamed with empty
// chunks and request_stats filled.
//
// Visually, response messages will stream as follows:
// ... -> {chunks: [...]} -> {chunks: [], request_stats: {...}}
// \______________________/ \________________________________/
// Primary response Trailer of RequestStats info
//
// Or if the read did not return any values:
// {chunks: [], request_stats: {...}}
// \________________________________/
// Trailer of RequestStats info
// If requested, return enhanced query performance statistics. The field
// request_stats is empty in a streamed response unless the ReadRowsResponse
// message contains request_stats in the last message of the stream. Always
// returned when requested, even when the read request returns an empty
// response.
RequestStats request_stats = 3;
}
@ -695,7 +680,7 @@ message RateLimitInfo {
// target load should be 80. After adjusting, the client should ignore
// `factor` until another `period` has passed.
//
// The client can measure its load using any unit that's comparable over time
// The client can measure its load using any unit that's comparable over time.
// For example, QPS can be used as long as each request involves a similar
// amount of work.
double factor = 2;
@ -819,7 +804,8 @@ message ReadModifyWriteRowRequest {
// Required. Rules specifying how the specified row's contents are to be
// transformed into writes. Entries are applied in order, meaning that earlier
// rules will affect the results of later ones.
// rules will affect the results of later ones. At least one entry must be
// specified, and there can be at most 100000 rules.
repeated ReadModifyWriteRule rules = 3
[(google.api.field_behavior) = REQUIRED];
}
@ -892,10 +878,10 @@ message ReadChangeStreamRequest {
// the position. Tokens are delivered on the stream as part of `Heartbeat`
// and `CloseStream` messages.
//
// If a single token is provided, the token’s partition must exactly match
// the request’s partition. If multiple tokens are provided, as in the case
// If a single token is provided, the token's partition must exactly match
// the request's partition. If multiple tokens are provided, as in the case
// of a partition merge, the union of the token partitions must exactly
// cover the request’s partition. Otherwise, INVALID_ARGUMENT will be
// cover the request's partition. Otherwise, INVALID_ARGUMENT will be
// returned.
StreamContinuationTokens continuation_tokens = 6;
}
@ -1003,8 +989,8 @@ message ReadChangeStreamResponse {
// An estimate of the commit timestamp that is usually lower than or equal
// to any timestamp for a record that will be delivered in the future on the
// stream. It is possible that, under particular circumstances that a future
// record has a timestamp is is lower than a previously seen timestamp. For
// an example usage see
// record has a timestamp that is lower than a previously seen timestamp.
// For an example usage see
// https://beam.apache.org/documentation/basics/#watermarks
google.protobuf.Timestamp estimated_low_watermark = 10;
}
@ -1019,8 +1005,8 @@ message ReadChangeStreamResponse {
// An estimate of the commit timestamp that is usually lower than or equal
// to any timestamp for a record that will be delivered in the future on the
// stream. It is possible that, under particular circumstances that a future
// record has a timestamp is is lower than a previously seen timestamp. For
// an example usage see
// record has a timestamp that is lower than a previously seen timestamp.
// For an example usage see
// https://beam.apache.org/documentation/basics/#watermarks
google.protobuf.Timestamp estimated_low_watermark = 2;
}
@ -1031,17 +1017,19 @@ message ReadChangeStreamResponse {
// If `continuation_tokens` & `new_partitions` are present, then a change in
// partitioning requires the client to open a new stream for each token to
// resume reading. Example:
// [B, D) ends
// |
// v
// new_partitions: [A, C) [C, E)
// continuation_tokens.partitions: [B,C) [C,D)
// ^---^ ^---^
// ^ ^
// | |
// | StreamContinuationToken 2
// |
// StreamContinuationToken 1
//
// [B, D) ends
// |
// v
// new_partitions: [A, C) [C, E)
// continuation_tokens.partitions: [B,C) [C,D)
// ^---^ ^---^
// ^ ^
// | |
// | StreamContinuationToken 2
// |
// StreamContinuationToken 1
//
// To read the new partition [A,C), supply the continuation tokens whose
// ranges cover the new partition, for example ContinuationToken[A,B) &
// ContinuationToken[B,C).

1
google/bigtable/v2/data.proto
View file

@ -138,6 +138,7 @@ message Value {
bool bool_value = 10;
// Represents a typed value transported as a floating point number.
// Does not support NaN or infinities.
double float_value = 11;
// Represents a typed value transported as a timestamp.

3
google/bigtable/v2/request_stats.proto
View file

@ -98,8 +98,7 @@ message FullReadStatsView {
// RequestStats is the container for additional information pertaining to a
// single request, helpful for evaluating the performance of the sent request.
// Currently, there are the following supported methods:
// * google.bigtable.v2.ReadRows
// Currently, the following method is supported: google.bigtable.v2.ReadRows
message RequestStats {
// Information pertaining to each request type received. The type is chosen
// based on the requested view.

3
google/bigtable/v2/response_params.proto
View file

@ -25,9 +25,6 @@ option php_namespace = "Google\\Cloud\\Bigtable\\V2";
option ruby_package = "Google::Cloud::Bigtable::V2";
// Response metadata proto
// This is an experimental feature that will be used to get zone_id and
// cluster_id from response trailers to tag the metrics. This should not be
// used by customers directly
message ResponseParams {
// The cloud bigtable zone associated with the cluster.
optional string zone_id = 1;