feat: Support for a custom error message for BatchSizeTooLargeError

Google APIs · copybara-github · commit 869c2e1fff95 · 2024-08-20T15:44:44.000-07:00
PiperOrigin-RevId: 665560115
diff --git a/google/cloud/bigquery/storage/v1alpha/BUILD.bazel b/google/cloud/bigquery/storage/v1alpha/BUILD.bazel
@@ -283,9 +283,7 @@ ruby_grpc_library(
 ruby_cloud_gapic_library(
     name = "storage_ruby_gapic",
     srcs = [":storage_proto_with_info"],
-    extra_protoc_parameters = [
-        "ruby-cloud-gem-name=google-cloud-bigquery-storage-v1alpha",
-    ],
+    extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-bigquery-storage-v1alpha"],
     grpc_service_config = "bigquerystorage_v1alpha_grpc_service_config.json",
     rest_numeric_enums = True,
     service_yaml = "bigquerystorage_v1alpha.yaml",
@@ -320,7 +318,6 @@ load(
 
 csharp_proto_library(
     name = "storage_csharp_proto",
-    extra_opts = [],
     deps = [":storage_proto"],
 )
 
diff --git a/google/cloud/bigquery/storage/v1alpha/bigquerystorage_v1alpha.yaml b/google/cloud/bigquery/storage/v1alpha/bigquerystorage_v1alpha.yaml
@@ -13,3 +13,30 @@ authentication:
       canonical_scopes: |-
         https://www.googleapis.com/auth/bigquery,
         https://www.googleapis.com/auth/cloud-platform
+
+publishing:
+  new_issue_uri: https://issuetracker.google.com/issues/new?component=187149&template=1162659
+  documentation_uri: https://cloud.google.com/bigquery/docs
+  api_short_name: bigquerystorage
+  github_label: 'api: bigquerystorage'
+  doc_tag_prefix: bigquerystorage
+  organization: CLOUD
+  library_settings:
+  - version: google.cloud.bigquery.storage.v1alpha
+    launch_stage: ALPHA
+    java_settings:
+      common:
+        destinations:
+        - PACKAGE_MANAGER
+    cpp_settings:
+      common:
+        destinations:
+        - PACKAGE_MANAGER
+    python_settings:
+      common:
+        destinations:
+        - PACKAGE_MANAGER
+    go_settings:
+      common:
+        destinations:
+        - PACKAGE_MANAGER
diff --git a/google/cloud/bigquery/storage/v1alpha/metastore_partition.proto b/google/cloud/bigquery/storage/v1alpha/metastore_partition.proto
@@ -268,3 +268,15 @@ message StreamMetastorePartitionsResponse {
   // stream.
   int64 total_partitions_inserted_count = 3;
 }
+
+// Structured custom error message for batch size too large error.
+// The error can be attached as error details in the returned rpc Status for
+// more structured error handling in the client.
+message BatchSizeTooLargeError {
+  // The maximum number of items that are supported in a single batch. This is
+  // returned as a hint to the client to adjust the batch size.
+  int64 max_batch_size = 1;
+
+  // Optional. The error message that is returned to the client.
+  string error_message = 2 [(google.api.field_behavior) = OPTIONAL];
+}
