@google-cloud/pubsub 2.19.1 → 3.0.0

package/CHANGELOG.md

@@ -4,6 +4,49 @@
 
 [1]: https://www.npmjs.com/package/@google-cloud/pubsub?activeTab=versions
 
+## [3.0.0](https://github.com/googleapis/nodejs-pubsub/compare/v2.19.4...v3.0.0) (2022-05-26)
+
+
+### ⚠ BREAKING CHANGES
+
+* update library to use Node 12 (#1564)
+
+### Features
+
+* add BigQuery configuration for subscriptions ([#1563](https://github.com/googleapis/nodejs-pubsub/issues/1563)) ([29d38a1](https://github.com/googleapis/nodejs-pubsub/commit/29d38a17663adcd02252a5b6c778d053208de12f))
+
+
+### Bug Fixes
+
+* **deps:** update dependency google-gax to v2.30.4 ([#1555](https://github.com/googleapis/nodejs-pubsub/issues/1555)) ([518fce1](https://github.com/googleapis/nodejs-pubsub/commit/518fce1adbdaae492a1d6db38daadb2be9c0a505))
+* fixes for dynamic routing and streaming descriptors ([#1566](https://github.com/googleapis/nodejs-pubsub/issues/1566)) ([158c606](https://github.com/googleapis/nodejs-pubsub/commit/158c606a88077a59ac04d4abcce7c732120c4ebb))
+
+
+### Build System
+
+* update library to use Node 12 ([#1564](https://github.com/googleapis/nodejs-pubsub/issues/1564)) ([adb4319](https://github.com/googleapis/nodejs-pubsub/commit/adb43190247a6282fc2abdcf75d7b07fe3fdc1dc))
+
+### [2.19.4](https://github.com/googleapis/nodejs-pubsub/compare/v2.19.3...v2.19.4) (2022-05-05)
+
+
+### Bug Fixes
+
+* **deps:** update dependency google-gax to v2.30.3 ([#1549](https://github.com/googleapis/nodejs-pubsub/issues/1549)) ([5810331](https://github.com/googleapis/nodejs-pubsub/commit/581033199dfe2a80a83b472bc77b1d7eab53b62d))
+
+### [2.19.3](https://github.com/googleapis/nodejs-pubsub/compare/v2.19.2...v2.19.3) (2022-04-26)
+
+
+### Bug Fixes
+
+* **deps:** update dependency google-gax to v2.30.2 ([#1502](https://github.com/googleapis/nodejs-pubsub/issues/1502)) ([37d075e](https://github.com/googleapis/nodejs-pubsub/commit/37d075e6ae4e588155a9f0c0506b9a497be6bf06))
+
+### [2.19.2](https://github.com/googleapis/nodejs-pubsub/compare/v2.19.1...v2.19.2) (2022-04-21)
+
+
+### Bug Fixes
+
+* fix flaky schema and subscription tests ([#1518](https://github.com/googleapis/nodejs-pubsub/issues/1518)) ([5ff0105](https://github.com/googleapis/nodejs-pubsub/commit/5ff0105cf84751beb6f06343aaf5228157faae4d))
+
 ### [2.19.1](https://github.com/googleapis/nodejs-pubsub/compare/v2.19.0...v2.19.1) (2022-04-06)
 
 

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

@@ -1,4 +1,4 @@
-// Copyright 2021 Google LLC
+// Copyright 2022 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -642,6 +642,20 @@ message Subscription {
     pattern: "projects/{project}/subscriptions/{subscription}"
   };
 
+  // Possible states for a subscription.
+  enum State {
+    // Default value. This value is unused.
+    STATE_UNSPECIFIED = 0;
+
+    // The subscription can actively receive messages
+    ACTIVE = 1;
+
+    // The subscription cannot receive messages because of an error with the
+    // resource to which it pushes messages. See the more detailed error state
+    // in the corresponding configuration.
+    RESOURCE_ERROR = 2;
+  }
+
   // Required. The name of the subscription. It must have the format
   // `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
   // start with a letter, and contain only letters (`[A-Za-z]`), numbers
@@ -659,10 +673,17 @@ message Subscription {
   ];
 
   // If push delivery is used with this subscription, this field is
-  // used to configure it. An empty `pushConfig` signifies that the subscriber
-  // will pull and ack messages using API methods.
+  // used to configure it. Either `pushConfig` or `bigQueryConfig` can be set,
+  // but not both. If both are empty, then the subscriber will pull and ack
+  // messages using API methods.
   PushConfig push_config = 4;
 
+  // If delivery to BigQuery is used with this subscription, this field is
+  // used to configure it. Either `pushConfig` or `bigQueryConfig` can be set,
+  // but not both. If both are empty, then the subscriber will pull and ack
+  // messages using API methods.
+  BigQueryConfig bigquery_config = 18;
+
   // 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
@@ -773,6 +794,10 @@ message Subscription {
   // in responses from the server; it is ignored if it is set in any requests.
   google.protobuf.Duration topic_message_retention_duration = 17
       [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. An output-only field indicating whether or not the subscription can receive
+  // messages.
+  State state = 19 [(google.api.field_behavior) = OUTPUT_ONLY];
 }
 
 // A policy that specifies how Cloud Pub/Sub retries message delivery.
@@ -902,6 +927,53 @@ message PushConfig {
   }
 }
 
+// Configuration for a BigQuery subscription.
+message BigQueryConfig {
+  // Possible states for a BigQuery subscription.
+  enum State {
+    // Default value. This value is unused.
+    STATE_UNSPECIFIED = 0;
+
+    // The subscription can actively send messages to BigQuery
+    ACTIVE = 1;
+
+    // Cannot write to the BigQuery table because of permission denied errors.
+    PERMISSION_DENIED = 2;
+
+    // Cannot write to the BigQuery table because it does not exist.
+    NOT_FOUND = 3;
+
+    // Cannot write to the BigQuery table due to a schema mismatch.
+    SCHEMA_MISMATCH = 4;
+  }
+
+  // The name of the table to which to write data, of the form
+  // {projectId}:{datasetId}.{tableId}
+  string table = 1;
+
+  // When true, use the topic's schema as the columns to write to in BigQuery,
+  // if it exists.
+  bool use_topic_schema = 2;
+
+  // When true, write the subscription name, message_id, publish_time,
+  // attributes, and ordering_key to additional columns in the table. The
+  // subscription name, message_id, and publish_time fields are put in their own
+  // columns while all other message properties (other than data) are written to
+  // a JSON object in the attributes column.
+  bool write_metadata = 3;
+
+  // When true and use_topic_schema is true, any fields that are a part of the
+  // topic schema that are not part of the BigQuery table schema are dropped
+  // when writing to BigQuery. Otherwise, the schemas must be kept in sync and
+  // any messages with extra fields are not written and remain in the
+  // subscription's backlog.
+  bool drop_unknown_fields = 4;
+
+  // Output only. An output-only field that indicates whether or not the subscription can
+  // receive messages.
+  State state = 5 [(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/protos.d.ts

@@ -2264,6 +2264,9 @@ export namespace google {
                 /** Subscription pushConfig */
                 pushConfig?: (google.pubsub.v1.IPushConfig|null);
 
+                /** Subscription bigqueryConfig */
+                bigqueryConfig?: (google.pubsub.v1.IBigQueryConfig|null);
+
                 /** Subscription ackDeadlineSeconds */
                 ackDeadlineSeconds?: (number|null);
 
@@ -2299,6 +2302,9 @@ export namespace google {
 
                 /** Subscription topicMessageRetentionDuration */
                 topicMessageRetentionDuration?: (google.protobuf.IDuration|null);
+
+                /** Subscription state */
+                state?: (google.pubsub.v1.Subscription.State|keyof typeof google.pubsub.v1.Subscription.State|null);
             }
 
             /** Represents a Subscription. */
@@ -2319,6 +2325,9 @@ export namespace google {
                 /** Subscription pushConfig. */
                 public pushConfig?: (google.pubsub.v1.IPushConfig|null);
 
+                /** Subscription bigqueryConfig. */
+                public bigqueryConfig?: (google.pubsub.v1.IBigQueryConfig|null);
+
                 /** Subscription ackDeadlineSeconds. */
                 public ackDeadlineSeconds: number;
 
@@ -2355,6 +2364,9 @@ export namespace google {
                 /** Subscription topicMessageRetentionDuration. */
                 public topicMessageRetentionDuration?: (google.protobuf.IDuration|null);
 
+                /** Subscription state. */
+                public state: (google.pubsub.v1.Subscription.State|keyof typeof google.pubsub.v1.Subscription.State);
+
                 /**
                  * Creates a new Subscription instance using the specified properties.
                  * @param [properties] Properties to set
@@ -2426,6 +2438,16 @@ export namespace google {
                 public toJSON(): { [k: string]: any };
             }
 
+            namespace Subscription {
+
+                /** State enum. */
+                enum State {
+                    STATE_UNSPECIFIED = 0,
+                    ACTIVE = 1,
+                    RESOURCE_ERROR = 2
+                }
+            }
+
             /** Properties of a RetryPolicy. */
             interface IRetryPolicy {
 
@@ -2912,6 +2934,132 @@ export namespace google {
                 }
             }
 
+            /** Properties of a BigQueryConfig. */
+            interface IBigQueryConfig {
+
+                /** BigQueryConfig table */
+                table?: (string|null);
+
+                /** BigQueryConfig useTopicSchema */
+                useTopicSchema?: (boolean|null);
+
+                /** BigQueryConfig writeMetadata */
+                writeMetadata?: (boolean|null);
+
+                /** BigQueryConfig dropUnknownFields */
+                dropUnknownFields?: (boolean|null);
+
+                /** BigQueryConfig state */
+                state?: (google.pubsub.v1.BigQueryConfig.State|keyof typeof google.pubsub.v1.BigQueryConfig.State|null);
+            }
+
+            /** Represents a BigQueryConfig. */
+            class BigQueryConfig implements IBigQueryConfig {
+
+                /**
+                 * Constructs a new BigQueryConfig.
+                 * @param [properties] Properties to set
+                 */
+                constructor(properties?: google.pubsub.v1.IBigQueryConfig);
+
+                /** BigQueryConfig table. */
+                public table: string;
+
+                /** BigQueryConfig useTopicSchema. */
+                public useTopicSchema: boolean;
+
+                /** BigQueryConfig writeMetadata. */
+                public writeMetadata: boolean;
+
+                /** BigQueryConfig dropUnknownFields. */
+                public dropUnknownFields: boolean;
+
+                /** BigQueryConfig state. */
+                public state: (google.pubsub.v1.BigQueryConfig.State|keyof typeof google.pubsub.v1.BigQueryConfig.State);
+
+                /**
+                 * Creates a new BigQueryConfig instance using the specified properties.
+                 * @param [properties] Properties to set
+                 * @returns BigQueryConfig instance
+                 */
+                public static create(properties?: google.pubsub.v1.IBigQueryConfig): google.pubsub.v1.BigQueryConfig;
+
+                /**
+                 * Encodes the specified BigQueryConfig message. Does not implicitly {@link google.pubsub.v1.BigQueryConfig.verify|verify} messages.
+                 * @param message BigQueryConfig message or plain object to encode
+                 * @param [writer] Writer to encode to
+                 * @returns Writer
+                 */
+                public static encode(message: google.pubsub.v1.IBigQueryConfig, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                /**
+                 * Encodes the specified BigQueryConfig message, length delimited. Does not implicitly {@link google.pubsub.v1.BigQueryConfig.verify|verify} messages.
+                 * @param message BigQueryConfig message or plain object to encode
+                 * @param [writer] Writer to encode to
+                 * @returns Writer
+                 */
+                public static encodeDelimited(message: google.pubsub.v1.IBigQueryConfig, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                /**
+                 * Decodes a BigQueryConfig message from the specified reader or buffer.
+                 * @param reader Reader or buffer to decode from
+                 * @param [length] Message length if known beforehand
+                 * @returns BigQueryConfig
+                 * @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.BigQueryConfig;
+
+                /**
+                 * Decodes a BigQueryConfig message from the specified reader or buffer, length delimited.
+                 * @param reader Reader or buffer to decode from
+                 * @returns BigQueryConfig
+                 * @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.BigQueryConfig;
+
+                /**
+                 * Verifies a BigQueryConfig 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 BigQueryConfig message from a plain object. Also converts values to their respective internal types.
+                 * @param object Plain object
+                 * @returns BigQueryConfig
+                 */
+                public static fromObject(object: { [k: string]: any }): google.pubsub.v1.BigQueryConfig;
+
+                /**
+                 * Creates a plain object from a BigQueryConfig message. Also converts values to other types if specified.
+                 * @param message BigQueryConfig
+                 * @param [options] Conversion options
+                 * @returns Plain object
+                 */
+                public static toObject(message: google.pubsub.v1.BigQueryConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+                /**
+                 * Converts this BigQueryConfig to JSON.
+                 * @returns JSON object
+                 */
+                public toJSON(): { [k: string]: any };
+            }
+
+            namespace BigQueryConfig {
+
+                /** State enum. */
+                enum State {
+                    STATE_UNSPECIFIED = 0,
+                    ACTIVE = 1,
+                    PERMISSION_DENIED = 2,
+                    NOT_FOUND = 3,
+                    SCHEMA_MISMATCH = 4
+                }
+            }
+
             /** Properties of a ReceivedMessage. */
             interface IReceivedMessage {
 
@@ -8982,6 +9130,9 @@ export namespace google {
             /** FieldOptions lazy */
             lazy?: (boolean|null);
 
+            /** FieldOptions unverifiedLazy */
+            unverifiedLazy?: (boolean|null);
+
             /** FieldOptions deprecated */
             deprecated?: (boolean|null);
 
@@ -9019,6 +9170,9 @@ export namespace google {
             /** FieldOptions lazy. */
             public lazy: boolean;
 
+            /** FieldOptions unverifiedLazy. */
+            public unverifiedLazy: boolean;
+
             /** FieldOptions deprecated. */
             public deprecated: boolean;