feat: Add IngestionFailureEvent to the external proto (#1984)

* feat: Add IngestionFailureEvent to the external proto PiperOrigin-RevId: 684152766 Source-Link: googleapis/googleapis@d992b06 Source-Link: googleapis/googleapis-gen@f7405e1 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZjc0MDVlMWRjNzVjZGRkMTBhNmFjYTk2MjExMzE4NTg2ZmI2MWZjMCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Megan Potter <[email protected]>
googleapis · Nov 7, 2024 · 7075430 · 7075430
1 parent 48b5b7c
commit 7075430
Show file tree

Hide file tree

Showing 4 changed files with 1,537 additions and 0 deletions.
diff --git a/protos/google/pubsub/v1/pubsub.proto b/protos/google/pubsub/v1/pubsub.proto
@@ -365,6 +365,63 @@ message PlatformLogsSettings {
   Severity severity = 1 [(google.api.field_behavior) = OPTIONAL];
 }
 
+// Payload of the Platform Log entry sent when a failure is encountered while
+// ingesting.
+message IngestionFailureEvent {
+  // Specifies the reason why some data may have been left out of
+  // the desired Pub/Sub message due to the API message limits
+  // (https://cloud.google.com/pubsub/quotas#resource_limits). For example,
+  // when the number of attributes is larger than 100, the number of
+  // attributes is truncated to 100 to respect the limit on the attribute count.
+  // Other attribute limits are treated similarly. When the size of the desired
+  // message would've been larger than 10MB, the message won't be published at
+  // all, and ingestion of the subsequent messages will proceed as normal.
+  message ApiViolationReason {}
+
+  // Set when an Avro file is unsupported or its format is not valid. When this
+  // occurs, one or more Avro objects won't be ingested.
+  message AvroFailureReason {}
+
+  // Failure when ingesting from a Cloud Storage source.
+  message CloudStorageFailure {
+    // Optional. Name of the Cloud Storage bucket used for ingestion.
+    string bucket = 1 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Name of the Cloud Storage object which contained the section
+    // that couldn't be ingested.
+    string object_name = 2 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Generation of the Cloud Storage object which contained the
+    // section that couldn't be ingested.
+    int64 object_generation = 3 [(google.api.field_behavior) = OPTIONAL];
+
+    // Reason why ingestion failed for the specified object.
+    oneof reason {
+      // Optional. Failure encountered when parsing an Avro file.
+      AvroFailureReason avro_failure_reason = 5
+          [(google.api.field_behavior) = OPTIONAL];
+
+      // Optional. The Pub/Sub API limits prevented the desired message from
+      // being published.
+      ApiViolationReason api_violation_reason = 6
+          [(google.api.field_behavior) = OPTIONAL];
+    }
+  }
+
+  // Required. Name of the import topic. Format is:
+  // projects/{project_name}/topics/{topic_name}.
+  string topic = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. Error details explaining why ingestion to Pub/Sub has failed.
+  string error_message = 2 [(google.api.field_behavior) = REQUIRED];
+
+  oneof failure {
+    // Optional. Failure when ingesting from Cloud Storage.
+    CloudStorageFailure cloud_storage_failure = 3
+        [(google.api.field_behavior) = OPTIONAL];
+  }
+}
+
 // A topic resource.
 message Topic {
   option (google.api.resource) = {