@google-cloud/pubsub 3.5.2 → 3.7.0

package/CHANGELOG.md

@@ -4,6 +4,20 @@
 
 [1]: https://www.npmjs.com/package/@google-cloud/pubsub?activeTab=versions
 
+## [3.7.0](https://github.com/googleapis/nodejs-pubsub/compare/v3.6.0...v3.7.0) (2023-05-26)
+
+
+### Features
+
+* Add push config wrapper fields ([#1730](https://github.com/googleapis/nodejs-pubsub/issues/1730)) ([a552719](https://github.com/googleapis/nodejs-pubsub/commit/a552719dfebda4c1263c352ea99bf8f9570290b7))
+
+## [3.6.0](https://github.com/googleapis/nodejs-pubsub/compare/v3.5.2...v3.6.0) (2023-05-12)
+
+
+### Features
+
+* Add cloud storage subscription fields ([#1724](https://github.com/googleapis/nodejs-pubsub/issues/1724)) ([f61a64a](https://github.com/googleapis/nodejs-pubsub/commit/f61a64a2daffdfbf4c7b18d50434899c572d108c))
+
 ## [3.5.2](https://github.com/googleapis/nodejs-pubsub/compare/v3.5.1...v3.5.2) (2023-04-26)
 
 

package/build/protos/google/pubsub/v1/pubsub.proto

@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -647,9 +647,9 @@ service Subscriber {
   }
 }
 
-// A subscription resource. If none of `push_config` or `bigquery_config` is
-// set, then the subscriber will pull and ack messages using API methods. At
-// most one of these fields may be set.
+// A subscription resource. If none of `push_config`, `bigquery_config`, or
+// `cloud_storage_config` is set, then the subscriber will pull and ack messages
+// using API methods. At most one of these fields may be set.
 message Subscription {
   option (google.api.resource) = {
     type: "pubsub.googleapis.com/Subscription"
@@ -694,6 +694,10 @@ message Subscription {
   // used to configure it.
   BigQueryConfig bigquery_config = 18;
 
+  // If delivery to Google Cloud Storage is used with this subscription, this
+  // field is used to configure it.
+  CloudStorageConfig cloud_storage_config = 22;
+
   // The approximate amount of time (on a best-effort basis) Pub/Sub waits for
   // the subscriber to acknowledge receipt before resending the message. In the
   // interval after the message is delivered and before it is acknowledged, it
@@ -885,9 +889,9 @@ message PushConfig {
   message OidcToken {
     // [Service account
     // email](https://cloud.google.com/iam/docs/service-accounts)
-    // to be used for generating the OIDC token. The caller (for
-    // CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
-    // have the iam.serviceAccounts.actAs permission for the service account.
+    // used for generating the OIDC token. For more information
+    // on setting up authentication, see
+    // [Push subscriptions](https://cloud.google.com/pubsub/docs/push).
     string service_account_email = 1;
 
     // Audience to be used when generating OIDC token. The audience claim
@@ -899,6 +903,19 @@ message PushConfig {
     string audience = 2;
   }
 
+  // The payload to the push endpoint is in the form of the JSON representation
+  // of a PubsubMessage
+  // (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
+  message PubsubWrapper {}
+
+  // Sets the `data` field as the HTTP body for delivery.
+  message NoWrapper {
+    // When true, writes the Pub/Sub message metadata to
+    // `x-goog-pubsub-<KEY>:<VAL>` headers of the HTTP request. Writes the
+    // Pub/Sub message attributes to `<KEY>:<VAL>` headers of the HTTP request.
+    bool write_metadata = 1;
+  }
+
   // A URL locating the endpoint to which messages should be pushed.
   // For example, a Webhook endpoint might use `https://example.com/push`.
   string push_endpoint = 1;
@@ -936,6 +953,18 @@ message PushConfig {
     // `Authorization` header in the HTTP request for every pushed message.
     OidcToken oidc_token = 3;
   }
+
+  // The format of the delivered message to the push endpoint is defined by
+  // the chosen wrapper. When unset, `PubsubWrapper` is used.
+  oneof wrapper {
+    // When set, the payload to the push endpoint is in the form of the JSON
+    // representation of a PubsubMessage
+    // (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
+    PubsubWrapper pubsub_wrapper = 4;
+
+    // When set, the payload to the push endpoint is not wrapped.
+    NoWrapper no_wrapper = 5;
+  }
 }
 
 // Configuration for a BigQuery subscription.
@@ -990,6 +1019,75 @@ message BigQueryConfig {
   State state = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
 }
 
+// Configuration for a Cloud Storage subscription.
+message CloudStorageConfig {
+  // Configuration for writing message data in text format.
+  // Message payloads will be written to files as raw text, separated by a
+  // newline.
+  message TextConfig {}
+
+  // Configuration for writing message data in Avro format.
+  // Message payloads and metadata will be written to files as an Avro binary.
+  message AvroConfig {
+    // When true, write the subscription name, message_id, publish_time,
+    // attributes, and ordering_key as additional fields in the output.
+    bool write_metadata = 1;
+  }
+
+  // Possible states for a Cloud Storage subscription.
+  enum State {
+    // Default value. This value is unused.
+    STATE_UNSPECIFIED = 0;
+
+    // The subscription can actively send messages to Cloud Storage.
+    ACTIVE = 1;
+
+    // Cannot write to the Cloud Storage bucket because of permission denied
+    // errors.
+    PERMISSION_DENIED = 2;
+
+    // Cannot write to the Cloud Storage bucket because it does not exist.
+    NOT_FOUND = 3;
+  }
+
+  // Required. User-provided name for the Cloud Storage bucket.
+  // The bucket must be created by the user. The bucket name must be without
+  // any prefix like "gs://". See the [bucket naming
+  // requirements] (https://cloud.google.com/storage/docs/buckets#naming).
+  string bucket = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // User-provided prefix for Cloud Storage filename. See the [object naming
+  // requirements](https://cloud.google.com/storage/docs/objects#naming).
+  string filename_prefix = 2;
+
+  // User-provided suffix for Cloud Storage filename. See the [object naming
+  // requirements](https://cloud.google.com/storage/docs/objects#naming).
+  string filename_suffix = 3;
+
+  // Defaults to text format.
+  oneof output_format {
+    // If set, message data will be written to Cloud Storage in text format.
+    TextConfig text_config = 4;
+
+    // If set, message data will be written to Cloud Storage in Avro format.
+    AvroConfig avro_config = 5;
+  }
+
+  // The maximum duration that can elapse before a new Cloud Storage file is
+  // created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed
+  // the subscription's acknowledgement deadline.
+  google.protobuf.Duration max_duration = 6;
+
+  // The maximum bytes that can be written to a Cloud Storage file before a new
+  // file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded
+  // in cases where messages are larger than the limit.
+  int64 max_bytes = 7;
+
+  // Output only. An output-only field that indicates whether or not the
+  // subscription can receive messages.
+  State state = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
 // A message and its corresponding acknowledgment ID.
 message ReceivedMessage {
   // This ID can be used to acknowledge the received message.

package/build/protos/google/pubsub/v1/schema.proto

@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.