feat: add ResourceExhausted to retryable error for Write API unary calls

Google APIs · copybara-github · commit 2b006afc7a39 · 2023-07-05T18:35:02.000-07:00
docs: add multiplexing documentation

PiperOrigin-RevId: 545839491
diff --git a/google/cloud/bigquery/storage/v1/bigquerystorage_grpc_service_config.json b/google/cloud/bigquery/storage/v1/bigquerystorage_grpc_service_config.json
@@ -96,7 +96,8 @@
         "backoffMultiplier": 1.3,
         "retryableStatusCodes": [
           "DEADLINE_EXCEEDED",
-          "UNAVAILABLE"
+          "UNAVAILABLE",
+          "RESOURCE_EXHAUSTED"
         ]
       }
     }, {
diff --git a/google/cloud/bigquery/storage/v1/storage.proto b/google/cloud/bigquery/storage/v1/storage.proto
@@ -397,19 +397,25 @@ message CreateWriteStreamRequest {
 
 // Request message for `AppendRows`.
 //
-// Due to the nature of AppendRows being a bidirectional streaming RPC, certain
-// parts of the AppendRowsRequest need only be specified for the first request
-// sent each time the gRPC network connection is opened/reopened.
+// Because AppendRows is a bidirectional streaming RPC, certain parts of the
+// AppendRowsRequest need only be specified for the first request before
+// switching table destinations. You can also switch table destinations within
+// the same connection for the default stream.
 //
 // The size of a single AppendRowsRequest must be less than 10 MB in size.
 // Requests larger than this return an error, typically `INVALID_ARGUMENT`.
 message AppendRowsRequest {
   // ProtoData contains the data rows and schema when constructing append
   // requests.
   message ProtoData {
-    // Proto schema used to serialize the data.  This value only needs to be
-    // provided as part of the first request on a gRPC network connection,
-    // and will be ignored for subsequent requests on the connection.
+    // The protocol buffer schema used to serialize the data. Provide this value
+    // whenever:
+    //
+    // * You send the first request of an RPC connection.
+    //
+    // * You change the input schema.
+    //
+    // * You specify a new destination table.
     ProtoSchema writer_schema = 1;
 
     // Serialized row data in protobuf message format.
@@ -419,10 +425,9 @@ message AppendRowsRequest {
     ProtoRows rows = 2;
   }
 
-  // An enum to indicate how to interpret missing values. Missing values are
-  // fields present in user schema but missing in rows. A missing value can
-  // represent a NULL or a column default value defined in BigQuery table
-  // schema.
+  // An enum to indicate how to interpret missing values of fields that are
+  // present in user schema but missing in rows. A missing value can represent a
+  // NULL or a column default value defined in BigQuery table schema.
   enum MissingValueInterpretation {
     // Invalid missing value interpretation. Requests with this value will be
     // rejected.
@@ -436,10 +441,14 @@ message AppendRowsRequest {
     DEFAULT_VALUE = 2;
   }
 
-  // Required. The write_stream identifies the target of the append operation,
-  // and only needs to be specified as part of the first request on the gRPC
-  // connection. If provided for subsequent requests, it must match the value of
-  // the first request.
+  // Required. The write_stream identifies the append operation. It must be
+  // provided in the following scenarios:
+  //
+  // * In the first request to an AppendRows connection.
+  //
+  // * In all subsequent requests to an AppendRows connection, if you use the
+  // same connection to write to multiple tables or change the input schema for
+  // default streams.
   //
   // For explicitly created write streams, the format is:
   //
@@ -448,6 +457,22 @@ message AppendRowsRequest {
   // For the special default stream, the format is:
   //
   // * `projects/{project}/datasets/{dataset}/tables/{table}/streams/_default`.
+  //
+  // An example of a possible sequence of requests with write_stream fields
+  // within a single connection:
+  //
+  // * r1: {write_stream: stream_name_1}
+  //
+  // * r2: {write_stream: /*omit*/}
+  //
+  // * r3: {write_stream: /*omit*/}
+  //
+  // * r4: {write_stream: stream_name_2}
+  //
+  // * r5: {write_stream: stream_name_2}
+  //
+  // The destination changed in request_4, so the write_stream field must be
+  // populated in all subsequent requests in this stream.
   string write_stream = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
diff --git a/google/cloud/bigquery/storage/v1/stream.proto b/google/cloud/bigquery/storage/v1/stream.proto
@@ -194,10 +194,10 @@ message ReadSession {
   int64 estimated_total_bytes_scanned = 12
       [(google.api.field_behavior) = OUTPUT_ONLY];
 
-  // Output only. A pre-projected estimate of the total physical size (in bytes)
-  // of files this session will scan when all streams are completely consumed.
-  // This estimate does not depend on the selected columns and can be based on
-  // metadata from the table which might be incomplete or stale. Only set for
+  // Output only. A pre-projected estimate of the total physical size of files
+  // (in bytes) that this session will scan when all streams are consumed. This
+  // estimate is independent of the selected columns and can be based on
+  // incomplete or stale metadata from the table.  This field is only set for
   // BigLake tables.
   int64 estimated_total_physical_file_size = 15
       [(google.api.field_behavior) = OUTPUT_ONLY];

Original file line number	Diff line number	Diff line change
`@@ -96,7 +96,8 @@`
`96`	`96`	`"backoffMultiplier": 1.3,`
`97`	`97`	`"retryableStatusCodes": [`
`98`	`98`	`"DEADLINE_EXCEEDED",`
`99`		`- "UNAVAILABLE"`
	`99`	`+ "UNAVAILABLE",`
	`100`	`+ "RESOURCE_EXHAUSTED"`
`100`	`101`	`]`
`101`	`102`	`}`
`102`	`103`	`}, {`