@google-cloud/pubsub 3.5.1 → 3.6.0

package/CHANGELOG.md

@@ -4,6 +4,20 @@
 
 [1]: https://www.npmjs.com/package/@google-cloud/pubsub?activeTab=versions
 
+## [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)
+
+
+### Bug Fixes
+
+* Avoid zalgo when calling down to publish messages ([#1710](https://github.com/googleapis/nodejs-pubsub/issues/1710)) ([dedae1e](https://github.com/googleapis/nodejs-pubsub/commit/dedae1e46cb3214abc33578a878a2298cdae6cac))
+
 ## [3.5.1](https://github.com/googleapis/nodejs-pubsub/compare/v3.5.0...v3.5.1) (2023-04-20)
 
 

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
@@ -990,6 +994,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.

package/build/protos/protos.d.ts

@@ -2398,6 +2398,9 @@ export namespace google {
                 /** Subscription bigqueryConfig */
                 bigqueryConfig?: (google.pubsub.v1.IBigQueryConfig|null);
 
+                /** Subscription cloudStorageConfig */
+                cloudStorageConfig?: (google.pubsub.v1.ICloudStorageConfig|null);
+
                 /** Subscription ackDeadlineSeconds */
                 ackDeadlineSeconds?: (number|null);
 
@@ -2459,6 +2462,9 @@ export namespace google {
                 /** Subscription bigqueryConfig. */
                 public bigqueryConfig?: (google.pubsub.v1.IBigQueryConfig|null);
 
+                /** Subscription cloudStorageConfig. */
+                public cloudStorageConfig?: (google.pubsub.v1.ICloudStorageConfig|null);
+
                 /** Subscription ackDeadlineSeconds. */
                 public ackDeadlineSeconds: number;
 
@@ -3240,6 +3246,347 @@ export namespace google {
                 }
             }
 
+            /** Properties of a CloudStorageConfig. */
+            interface ICloudStorageConfig {
+
+                /** CloudStorageConfig bucket */
+                bucket?: (string|null);
+
+                /** CloudStorageConfig filenamePrefix */
+                filenamePrefix?: (string|null);
+
+                /** CloudStorageConfig filenameSuffix */
+                filenameSuffix?: (string|null);
+
+                /** CloudStorageConfig textConfig */
+                textConfig?: (google.pubsub.v1.CloudStorageConfig.ITextConfig|null);
+
+                /** CloudStorageConfig avroConfig */
+                avroConfig?: (google.pubsub.v1.CloudStorageConfig.IAvroConfig|null);
+
+                /** CloudStorageConfig maxDuration */
+                maxDuration?: (google.protobuf.IDuration|null);
+
+                /** CloudStorageConfig maxBytes */
+                maxBytes?: (number|Long|string|null);
+
+                /** CloudStorageConfig state */
+                state?: (google.pubsub.v1.CloudStorageConfig.State|keyof typeof google.pubsub.v1.CloudStorageConfig.State|null);
+            }
+
+            /** Represents a CloudStorageConfig. */
+            class CloudStorageConfig implements ICloudStorageConfig {
+
+                /**
+                 * Constructs a new CloudStorageConfig.
+                 * @param [properties] Properties to set
+                 */
+                constructor(properties?: google.pubsub.v1.ICloudStorageConfig);
+
+                /** CloudStorageConfig bucket. */
+                public bucket: string;
+
+                /** CloudStorageConfig filenamePrefix. */
+                public filenamePrefix: string;
+
+                /** CloudStorageConfig filenameSuffix. */
+                public filenameSuffix: string;
+
+                /** CloudStorageConfig textConfig. */
+                public textConfig?: (google.pubsub.v1.CloudStorageConfig.ITextConfig|null);
+
+                /** CloudStorageConfig avroConfig. */
+                public avroConfig?: (google.pubsub.v1.CloudStorageConfig.IAvroConfig|null);
+
+                /** CloudStorageConfig maxDuration. */
+                public maxDuration?: (google.protobuf.IDuration|null);
+
+                /** CloudStorageConfig maxBytes. */
+                public maxBytes: (number|Long|string);
+
+                /** CloudStorageConfig state. */
+                public state: (google.pubsub.v1.CloudStorageConfig.State|keyof typeof google.pubsub.v1.CloudStorageConfig.State);
+
+                /** CloudStorageConfig outputFormat. */
+                public outputFormat?: ("textConfig"|"avroConfig");
+
+                /**
+                 * Creates a new CloudStorageConfig instance using the specified properties.
+                 * @param [properties] Properties to set
+                 * @returns CloudStorageConfig instance
+                 */
+                public static create(properties?: google.pubsub.v1.ICloudStorageConfig): google.pubsub.v1.CloudStorageConfig;
+
+                /**
+                 * Encodes the specified CloudStorageConfig message. Does not implicitly {@link google.pubsub.v1.CloudStorageConfig.verify|verify} messages.
+                 * @param message CloudStorageConfig message or plain object to encode
+                 * @param [writer] Writer to encode to
+                 * @returns Writer
+                 */
+                public static encode(message: google.pubsub.v1.ICloudStorageConfig, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                /**
+                 * Encodes the specified CloudStorageConfig message, length delimited. Does not implicitly {@link google.pubsub.v1.CloudStorageConfig.verify|verify} messages.
+                 * @param message CloudStorageConfig message or plain object to encode
+                 * @param [writer] Writer to encode to
+                 * @returns Writer
+                 */
+                public static encodeDelimited(message: google.pubsub.v1.ICloudStorageConfig, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                /**
+                 * Decodes a CloudStorageConfig message from the specified reader or buffer.
+                 * @param reader Reader or buffer to decode from
+                 * @param [length] Message length if known beforehand
+                 * @returns CloudStorageConfig
+                 * @throws {Error} If the payload is not a reader or valid buffer
+                 * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                 */
+                public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.pubsub.v1.CloudStorageConfig;
+
+                /**
+                 * Decodes a CloudStorageConfig message from the specified reader or buffer, length delimited.
+                 * @param reader Reader or buffer to decode from
+                 * @returns CloudStorageConfig
+                 * @throws {Error} If the payload is not a reader or valid buffer
+                 * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                 */
+                public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.pubsub.v1.CloudStorageConfig;
+
+                /**
+                 * Verifies a CloudStorageConfig message.
+                 * @param message Plain object to verify
+                 * @returns `null` if valid, otherwise the reason why it is not
+                 */
+                public static verify(message: { [k: string]: any }): (string|null);
+
+                /**
+                 * Creates a CloudStorageConfig message from a plain object. Also converts values to their respective internal types.
+                 * @param object Plain object
+                 * @returns CloudStorageConfig
+                 */
+                public static fromObject(object: { [k: string]: any }): google.pubsub.v1.CloudStorageConfig;
+
+                /**
+                 * Creates a plain object from a CloudStorageConfig message. Also converts values to other types if specified.
+                 * @param message CloudStorageConfig
+                 * @param [options] Conversion options
+                 * @returns Plain object
+                 */
+                public static toObject(message: google.pubsub.v1.CloudStorageConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+                /**
+                 * Converts this CloudStorageConfig to JSON.
+                 * @returns JSON object
+                 */
+                public toJSON(): { [k: string]: any };
+
+                /**
+                 * Gets the default type url for CloudStorageConfig
+                 * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
+                 * @returns The default type url
+                 */
+                public static getTypeUrl(typeUrlPrefix?: string): string;
+            }
+
+            namespace CloudStorageConfig {
+
+                /** Properties of a TextConfig. */
+                interface ITextConfig {
+                }
+
+                /** Represents a TextConfig. */
+                class TextConfig implements ITextConfig {
+
+                    /**
+                     * Constructs a new TextConfig.
+                     * @param [properties] Properties to set
+                     */
+                    constructor(properties?: google.pubsub.v1.CloudStorageConfig.ITextConfig);
+
+                    /**
+                     * Creates a new TextConfig instance using the specified properties.
+                     * @param [properties] Properties to set
+                     * @returns TextConfig instance
+                     */
+                    public static create(properties?: google.pubsub.v1.CloudStorageConfig.ITextConfig): google.pubsub.v1.CloudStorageConfig.TextConfig;
+
+                    /**
+                     * Encodes the specified TextConfig message. Does not implicitly {@link google.pubsub.v1.CloudStorageConfig.TextConfig.verify|verify} messages.
+                     * @param message TextConfig message or plain object to encode
+                     * @param [writer] Writer to encode to
+                     * @returns Writer
+                     */
+                    public static encode(message: google.pubsub.v1.CloudStorageConfig.ITextConfig, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Encodes the specified TextConfig message, length delimited. Does not implicitly {@link google.pubsub.v1.CloudStorageConfig.TextConfig.verify|verify} messages.
+                     * @param message TextConfig message or plain object to encode
+                     * @param [writer] Writer to encode to
+                     * @returns Writer
+                     */
+                    public static encodeDelimited(message: google.pubsub.v1.CloudStorageConfig.ITextConfig, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Decodes a TextConfig message from the specified reader or buffer.
+                     * @param reader Reader or buffer to decode from
+                     * @param [length] Message length if known beforehand
+                     * @returns TextConfig
+                     * @throws {Error} If the payload is not a reader or valid buffer
+                     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                     */
+                    public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.pubsub.v1.CloudStorageConfig.TextConfig;
+
+                    /**
+                     * Decodes a TextConfig message from the specified reader or buffer, length delimited.
+                     * @param reader Reader or buffer to decode from
+                     * @returns TextConfig
+                     * @throws {Error} If the payload is not a reader or valid buffer
+                     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                     */
+                    public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.pubsub.v1.CloudStorageConfig.TextConfig;
+
+                    /**
+                     * Verifies a TextConfig message.
+                     * @param message Plain object to verify
+                     * @returns `null` if valid, otherwise the reason why it is not
+                     */
+                    public static verify(message: { [k: string]: any }): (string|null);
+
+                    /**
+                     * Creates a TextConfig message from a plain object. Also converts values to their respective internal types.
+                     * @param object Plain object
+                     * @returns TextConfig
+                     */
+                    public static fromObject(object: { [k: string]: any }): google.pubsub.v1.CloudStorageConfig.TextConfig;
+
+                    /**
+                     * Creates a plain object from a TextConfig message. Also converts values to other types if specified.
+                     * @param message TextConfig
+                     * @param [options] Conversion options
+                     * @returns Plain object
+                     */
+                    public static toObject(message: google.pubsub.v1.CloudStorageConfig.TextConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+                    /**
+                     * Converts this TextConfig to JSON.
+                     * @returns JSON object
+                     */
+                    public toJSON(): { [k: string]: any };
+
+                    /**
+                     * Gets the default type url for TextConfig
+                     * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
+                     * @returns The default type url
+                     */
+                    public static getTypeUrl(typeUrlPrefix?: string): string;
+                }
+
+                /** Properties of an AvroConfig. */
+                interface IAvroConfig {
+
+                    /** AvroConfig writeMetadata */
+                    writeMetadata?: (boolean|null);
+                }
+
+                /** Represents an AvroConfig. */
+                class AvroConfig implements IAvroConfig {
+
+                    /**
+                     * Constructs a new AvroConfig.
+                     * @param [properties] Properties to set
+                     */
+                    constructor(properties?: google.pubsub.v1.CloudStorageConfig.IAvroConfig);
+
+                    /** AvroConfig writeMetadata. */
+                    public writeMetadata: boolean;
+
+                    /**
+                     * Creates a new AvroConfig instance using the specified properties.
+                     * @param [properties] Properties to set
+                     * @returns AvroConfig instance
+                     */
+                    public static create(properties?: google.pubsub.v1.CloudStorageConfig.IAvroConfig): google.pubsub.v1.CloudStorageConfig.AvroConfig;
+
+                    /**
+                     * Encodes the specified AvroConfig message. Does not implicitly {@link google.pubsub.v1.CloudStorageConfig.AvroConfig.verify|verify} messages.
+                     * @param message AvroConfig message or plain object to encode
+                     * @param [writer] Writer to encode to
+                     * @returns Writer
+                     */
+                    public static encode(message: google.pubsub.v1.CloudStorageConfig.IAvroConfig, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Encodes the specified AvroConfig message, length delimited. Does not implicitly {@link google.pubsub.v1.CloudStorageConfig.AvroConfig.verify|verify} messages.
+                     * @param message AvroConfig message or plain object to encode
+                     * @param [writer] Writer to encode to
+                     * @returns Writer
+                     */
+                    public static encodeDelimited(message: google.pubsub.v1.CloudStorageConfig.IAvroConfig, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Decodes an AvroConfig message from the specified reader or buffer.
+                     * @param reader Reader or buffer to decode from
+                     * @param [length] Message length if known beforehand
+                     * @returns AvroConfig
+                     * @throws {Error} If the payload is not a reader or valid buffer
+                     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                     */
+                    public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.pubsub.v1.CloudStorageConfig.AvroConfig;
+
+                    /**
+                     * Decodes an AvroConfig message from the specified reader or buffer, length delimited.
+                     * @param reader Reader or buffer to decode from
+                     * @returns AvroConfig
+                     * @throws {Error} If the payload is not a reader or valid buffer
+                     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                     */
+                    public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.pubsub.v1.CloudStorageConfig.AvroConfig;
+
+                    /**
+                     * Verifies an AvroConfig message.
+                     * @param message Plain object to verify
+                     * @returns `null` if valid, otherwise the reason why it is not
+                     */
+                    public static verify(message: { [k: string]: any }): (string|null);
+
+                    /**
+                     * Creates an AvroConfig message from a plain object. Also converts values to their respective internal types.
+                     * @param object Plain object
+                     * @returns AvroConfig
+                     */
+                    public static fromObject(object: { [k: string]: any }): google.pubsub.v1.CloudStorageConfig.AvroConfig;
+
+                    /**
+                     * Creates a plain object from an AvroConfig message. Also converts values to other types if specified.
+                     * @param message AvroConfig
+                     * @param [options] Conversion options
+                     * @returns Plain object
+                     */
+                    public static toObject(message: google.pubsub.v1.CloudStorageConfig.AvroConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+                    /**
+                     * Converts this AvroConfig to JSON.
+                     * @returns JSON object
+                     */
+                    public toJSON(): { [k: string]: any };
+
+                    /**
+                     * Gets the default type url for AvroConfig
+                     * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
+                     * @returns The default type url
+                     */
+                    public static getTypeUrl(typeUrlPrefix?: string): string;
+                }
+
+                /** State enum. */
+                enum State {
+                    STATE_UNSPECIFIED = 0,
+                    ACTIVE = 1,
+                    PERMISSION_DENIED = 2,
+                    NOT_FOUND = 3
+                }
+            }
+
             /** Properties of a ReceivedMessage. */
             interface IReceivedMessage {