@google-cloud/pubsub 2.18.1 → 2.18.5

package/build/src/v1/publisher_client.d.ts

@@ -103,24 +103,206 @@ export declare class PublisherClient {
     static get scopes(): string[];
     getProjectId(): Promise<string>;
     getProjectId(callback: Callback<string, undefined, undefined>): void;
+    /**
+     * Creates the given topic with the given name. See the [resource name rules]
+     * (https://cloud.google.com/pubsub/docs/admin#resource_names).
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.name
+     *   Required. The name of the topic. It must have the format
+     *   `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter,
+     *   and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
+     *   underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
+     *   signs (`%`). It must be between 3 and 255 characters in length, and it
+     *   must not start with `"goog"`.
+     * @param {number[]} request.labels
+     *   See [Creating and managing labels]
+     *   (https://cloud.google.com/pubsub/docs/labels).
+     * @param {google.pubsub.v1.MessageStoragePolicy} request.messageStoragePolicy
+     *   Policy constraining the set of Google Cloud Platform regions where messages
+     *   published to the topic may be stored. If not present, then no constraints
+     *   are in effect.
+     * @param {string} request.kmsKeyName
+     *   The resource name of the Cloud KMS CryptoKey to be used to protect access
+     *   to messages published on this topic.
+     *
+     *   The expected format is `projects/* /locations/* /keyRings/* /cryptoKeys/*`.
+     * @param {google.pubsub.v1.SchemaSettings} request.schemaSettings
+     *   Settings for validating messages published against a schema.
+     * @param {boolean} request.satisfiesPzs
+     *   Reserved for future use. This field is set only in responses from the
+     *   server; it is ignored if it is set in any requests.
+     * @param {google.protobuf.Duration} request.messageRetentionDuration
+     *   Indicates the minimum duration to retain a message after it is published to
+     *   the topic. If this field is set, messages published to the topic in the
+     *   last `message_retention_duration` are always available to subscribers. For
+     *   instance, it allows any attached subscription to [seek to a
+     *   timestamp](https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time)
+     *   that is up to `message_retention_duration` in the past. If this field is
+     *   not set, message retention is controlled by settings on individual
+     *   subscriptions. Cannot be more than 7 days or less than 10 minutes.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing [Topic]{@link google.pubsub.v1.Topic}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/publisher.create_topic.js</caption>
+     * region_tag:pubsub_v1_generated_Publisher_CreateTopic_async
+     */
     createTopic(request?: protos.google.pubsub.v1.ITopic, options?: CallOptions): Promise<[protos.google.pubsub.v1.ITopic, protos.google.pubsub.v1.ITopic | undefined, {} | undefined]>;
     createTopic(request: protos.google.pubsub.v1.ITopic, options: CallOptions, callback: Callback<protos.google.pubsub.v1.ITopic, protos.google.pubsub.v1.ITopic | null | undefined, {} | null | undefined>): void;
     createTopic(request: protos.google.pubsub.v1.ITopic, callback: Callback<protos.google.pubsub.v1.ITopic, protos.google.pubsub.v1.ITopic | null | undefined, {} | null | undefined>): void;
+    /**
+     * Updates an existing topic. Note that certain properties of a
+     * topic are not modifiable.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {google.pubsub.v1.Topic} request.topic
+     *   Required. The updated topic object.
+     * @param {google.protobuf.FieldMask} request.updateMask
+     *   Required. Indicates which fields in the provided topic to update. Must be
+     *   specified and non-empty. Note that if `update_mask` contains
+     *   "message_storage_policy" but the `message_storage_policy` is not set in
+     *   the `topic` provided above, then the updated value is determined by the
+     *   policy configured at the project or organization level.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing [Topic]{@link google.pubsub.v1.Topic}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/publisher.update_topic.js</caption>
+     * region_tag:pubsub_v1_generated_Publisher_UpdateTopic_async
+     */
     updateTopic(request?: protos.google.pubsub.v1.IUpdateTopicRequest, options?: CallOptions): Promise<[protos.google.pubsub.v1.ITopic, protos.google.pubsub.v1.IUpdateTopicRequest | undefined, {} | undefined]>;
     updateTopic(request: protos.google.pubsub.v1.IUpdateTopicRequest, options: CallOptions, callback: Callback<protos.google.pubsub.v1.ITopic, protos.google.pubsub.v1.IUpdateTopicRequest | null | undefined, {} | null | undefined>): void;
     updateTopic(request: protos.google.pubsub.v1.IUpdateTopicRequest, callback: Callback<protos.google.pubsub.v1.ITopic, protos.google.pubsub.v1.IUpdateTopicRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic
+     * does not exist.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.topic
+     *   Required. The messages in the request will be published on this topic.
+     *   Format is `projects/{project}/topics/{topic}`.
+     * @param {number[]} request.messages
+     *   Required. The messages to publish.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing [PublishResponse]{@link google.pubsub.v1.PublishResponse}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/publisher.publish.js</caption>
+     * region_tag:pubsub_v1_generated_Publisher_Publish_async
+     */
     publish(request?: protos.google.pubsub.v1.IPublishRequest, options?: CallOptions): Promise<[protos.google.pubsub.v1.IPublishResponse, protos.google.pubsub.v1.IPublishRequest | undefined, {} | undefined]>;
     publish(request: protos.google.pubsub.v1.IPublishRequest, options: CallOptions, callback: Callback<protos.google.pubsub.v1.IPublishResponse, protos.google.pubsub.v1.IPublishRequest | null | undefined, {} | null | undefined>): void;
     publish(request: protos.google.pubsub.v1.IPublishRequest, callback: Callback<protos.google.pubsub.v1.IPublishResponse, protos.google.pubsub.v1.IPublishRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Gets the configuration of a topic.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.topic
+     *   Required. The name of the topic to get.
+     *   Format is `projects/{project}/topics/{topic}`.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing [Topic]{@link google.pubsub.v1.Topic}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/publisher.get_topic.js</caption>
+     * region_tag:pubsub_v1_generated_Publisher_GetTopic_async
+     */
     getTopic(request?: protos.google.pubsub.v1.IGetTopicRequest, options?: CallOptions): Promise<[protos.google.pubsub.v1.ITopic, protos.google.pubsub.v1.IGetTopicRequest | undefined, {} | undefined]>;
     getTopic(request: protos.google.pubsub.v1.IGetTopicRequest, options: CallOptions, callback: Callback<protos.google.pubsub.v1.ITopic, protos.google.pubsub.v1.IGetTopicRequest | null | undefined, {} | null | undefined>): void;
     getTopic(request: protos.google.pubsub.v1.IGetTopicRequest, callback: Callback<protos.google.pubsub.v1.ITopic, protos.google.pubsub.v1.IGetTopicRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Deletes the topic with the given name. Returns `NOT_FOUND` if the topic
+     * does not exist. After a topic is deleted, a new topic may be created with
+     * the same name; this is an entirely new topic with none of the old
+     * configuration or subscriptions. Existing subscriptions to this topic are
+     * not deleted, but their `topic` field is set to `_deleted-topic_`.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.topic
+     *   Required. Name of the topic to delete.
+     *   Format is `projects/{project}/topics/{topic}`.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing [Empty]{@link google.protobuf.Empty}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/publisher.delete_topic.js</caption>
+     * region_tag:pubsub_v1_generated_Publisher_DeleteTopic_async
+     */
     deleteTopic(request?: protos.google.pubsub.v1.IDeleteTopicRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.pubsub.v1.IDeleteTopicRequest | undefined, {} | undefined]>;
     deleteTopic(request: protos.google.pubsub.v1.IDeleteTopicRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.pubsub.v1.IDeleteTopicRequest | null | undefined, {} | null | undefined>): void;
     deleteTopic(request: protos.google.pubsub.v1.IDeleteTopicRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.pubsub.v1.IDeleteTopicRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Detaches a subscription from this topic. All messages retained in the
+     * subscription are dropped. Subsequent `Pull` and `StreamingPull` requests
+     * will return FAILED_PRECONDITION. If the subscription is a push
+     * subscription, pushes to the endpoint will stop.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.subscription
+     *   Required. The subscription to detach.
+     *   Format is `projects/{project}/subscriptions/{subscription}`.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing [DetachSubscriptionResponse]{@link google.pubsub.v1.DetachSubscriptionResponse}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/publisher.detach_subscription.js</caption>
+     * region_tag:pubsub_v1_generated_Publisher_DetachSubscription_async
+     */
     detachSubscription(request?: protos.google.pubsub.v1.IDetachSubscriptionRequest, options?: CallOptions): Promise<[protos.google.pubsub.v1.IDetachSubscriptionResponse, protos.google.pubsub.v1.IDetachSubscriptionRequest | undefined, {} | undefined]>;
     detachSubscription(request: protos.google.pubsub.v1.IDetachSubscriptionRequest, options: CallOptions, callback: Callback<protos.google.pubsub.v1.IDetachSubscriptionResponse, protos.google.pubsub.v1.IDetachSubscriptionRequest | null | undefined, {} | null | undefined>): void;
     detachSubscription(request: protos.google.pubsub.v1.IDetachSubscriptionRequest, callback: Callback<protos.google.pubsub.v1.IDetachSubscriptionResponse, protos.google.pubsub.v1.IDetachSubscriptionRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Lists matching topics.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.project
+     *   Required. The name of the project in which to list topics.
+     *   Format is `projects/{project-id}`.
+     * @param {number} request.pageSize
+     *   Maximum number of topics to return.
+     * @param {string} request.pageToken
+     *   The value returned by the last `ListTopicsResponse`; indicates that this is
+     *   a continuation of a prior `ListTopics` call, and that the system should
+     *   return the next page of data.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is Array of [Topic]{@link google.pubsub.v1.Topic}.
+     *   The client library will perform auto-pagination by default: it will call the API as many
+     *   times as needed and will merge results from all the pages into this array.
+     *   Note that it can affect your quota.
+     *   We recommend using `listTopicsAsync()`
+     *   method described below for async iteration which you can stop as needed.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   for more details and examples.
+     */
     listTopics(request?: protos.google.pubsub.v1.IListTopicsRequest, options?: CallOptions): Promise<[protos.google.pubsub.v1.ITopic[], protos.google.pubsub.v1.IListTopicsRequest | null, protos.google.pubsub.v1.IListTopicsResponse]>;
     listTopics(request: protos.google.pubsub.v1.IListTopicsRequest, options: CallOptions, callback: PaginationCallback<protos.google.pubsub.v1.IListTopicsRequest, protos.google.pubsub.v1.IListTopicsResponse | null | undefined, protos.google.pubsub.v1.ITopic>): void;
     listTopics(request: protos.google.pubsub.v1.IListTopicsRequest, callback: PaginationCallback<protos.google.pubsub.v1.IListTopicsRequest, protos.google.pubsub.v1.IListTopicsResponse | null | undefined, protos.google.pubsub.v1.ITopic>): void;
@@ -175,13 +357,37 @@ export declare class PublisherClient {
      *   Please see the
      *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
      *   for more details and examples.
-     * @example
-     * const iterable = client.listTopicsAsync(request);
-     * for await (const response of iterable) {
-     *   // process response
-     * }
+     * @example <caption>include:samples/generated/v1/publisher.list_topics.js</caption>
+     * region_tag:pubsub_v1_generated_Publisher_ListTopics_async
      */
     listTopicsAsync(request?: protos.google.pubsub.v1.IListTopicsRequest, options?: CallOptions): AsyncIterable<protos.google.pubsub.v1.ITopic>;
+    /**
+     * Lists the names of the attached subscriptions on this topic.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.topic
+     *   Required. The name of the topic that subscriptions are attached to.
+     *   Format is `projects/{project}/topics/{topic}`.
+     * @param {number} request.pageSize
+     *   Maximum number of subscription names to return.
+     * @param {string} request.pageToken
+     *   The value returned by the last `ListTopicSubscriptionsResponse`; indicates
+     *   that this is a continuation of a prior `ListTopicSubscriptions` call, and
+     *   that the system should return the next page of data.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is Array of string.
+     *   The client library will perform auto-pagination by default: it will call the API as many
+     *   times as needed and will merge results from all the pages into this array.
+     *   Note that it can affect your quota.
+     *   We recommend using `listTopicSubscriptionsAsync()`
+     *   method described below for async iteration which you can stop as needed.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   for more details and examples.
+     */
     listTopicSubscriptions(request?: protos.google.pubsub.v1.IListTopicSubscriptionsRequest, options?: CallOptions): Promise<[string[], protos.google.pubsub.v1.IListTopicSubscriptionsRequest | null, protos.google.pubsub.v1.IListTopicSubscriptionsResponse]>;
     listTopicSubscriptions(request: protos.google.pubsub.v1.IListTopicSubscriptionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.pubsub.v1.IListTopicSubscriptionsRequest, protos.google.pubsub.v1.IListTopicSubscriptionsResponse | null | undefined, string>): void;
     listTopicSubscriptions(request: protos.google.pubsub.v1.IListTopicSubscriptionsRequest, callback: PaginationCallback<protos.google.pubsub.v1.IListTopicSubscriptionsRequest, protos.google.pubsub.v1.IListTopicSubscriptionsResponse | null | undefined, string>): void;
@@ -236,13 +442,41 @@ export declare class PublisherClient {
      *   Please see the
      *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
      *   for more details and examples.
-     * @example
-     * const iterable = client.listTopicSubscriptionsAsync(request);
-     * for await (const response of iterable) {
-     *   // process response
-     * }
+     * @example <caption>include:samples/generated/v1/publisher.list_topic_subscriptions.js</caption>
+     * region_tag:pubsub_v1_generated_Publisher_ListTopicSubscriptions_async
      */
     listTopicSubscriptionsAsync(request?: protos.google.pubsub.v1.IListTopicSubscriptionsRequest, options?: CallOptions): AsyncIterable<string>;
+    /**
+     * Lists the names of the snapshots on this topic. Snapshots are used in
+     * [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations,
+     * which allow you to manage message acknowledgments in bulk. That is, you can
+     * set the acknowledgment state of messages in an existing subscription to the
+     * state captured by a snapshot.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.topic
+     *   Required. The name of the topic that snapshots are attached to.
+     *   Format is `projects/{project}/topics/{topic}`.
+     * @param {number} request.pageSize
+     *   Maximum number of snapshot names to return.
+     * @param {string} request.pageToken
+     *   The value returned by the last `ListTopicSnapshotsResponse`; indicates
+     *   that this is a continuation of a prior `ListTopicSnapshots` call, and
+     *   that the system should return the next page of data.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is Array of string.
+     *   The client library will perform auto-pagination by default: it will call the API as many
+     *   times as needed and will merge results from all the pages into this array.
+     *   Note that it can affect your quota.
+     *   We recommend using `listTopicSnapshotsAsync()`
+     *   method described below for async iteration which you can stop as needed.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   for more details and examples.
+     */
     listTopicSnapshots(request?: protos.google.pubsub.v1.IListTopicSnapshotsRequest, options?: CallOptions): Promise<[string[], protos.google.pubsub.v1.IListTopicSnapshotsRequest | null, protos.google.pubsub.v1.IListTopicSnapshotsResponse]>;
     listTopicSnapshots(request: protos.google.pubsub.v1.IListTopicSnapshotsRequest, options: CallOptions, callback: PaginationCallback<protos.google.pubsub.v1.IListTopicSnapshotsRequest, protos.google.pubsub.v1.IListTopicSnapshotsResponse | null | undefined, string>): void;
     listTopicSnapshots(request: protos.google.pubsub.v1.IListTopicSnapshotsRequest, callback: PaginationCallback<protos.google.pubsub.v1.IListTopicSnapshotsRequest, protos.google.pubsub.v1.IListTopicSnapshotsResponse | null | undefined, string>): void;
@@ -297,11 +531,8 @@ export declare class PublisherClient {
      *   Please see the
      *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
      *   for more details and examples.
-     * @example
-     * const iterable = client.listTopicSnapshotsAsync(request);
-     * for await (const response of iterable) {
-     *   // process response
-     * }
+     * @example <caption>include:samples/generated/v1/publisher.list_topic_snapshots.js</caption>
+     * region_tag:pubsub_v1_generated_Publisher_ListTopicSnapshots_async
      */
     listTopicSnapshotsAsync(request?: protos.google.pubsub.v1.IListTopicSnapshotsRequest, options?: CallOptions): AsyncIterable<string>;
     /**