@google-cloud/pubsub 2.18.1 → 2.18.2

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

@@ -102,44 +102,546 @@ export declare class SubscriberClient {
      * @returns {string[]} List of default scopes.
      */
     static get scopes(): string[];
+    /**
+     * Return the project ID used by this class.
+     * @returns {Promise} A promise that resolves to string containing the project ID.
+     */
     getProjectId(): Promise<string>;
     getProjectId(callback: Callback<string, undefined, undefined>): void;
+    /**
+     * Creates a subscription to a given topic. See the [resource name rules]
+     * (https://cloud.google.com/pubsub/docs/admin#resource_names).
+     * If the subscription already exists, returns `ALREADY_EXISTS`.
+     * If the corresponding topic doesn't exist, returns `NOT_FOUND`.
+     *
+     * If the name is not provided in the request, the server will assign a random
+     * name for this subscription on the same project as the topic, conforming
+     * to the [resource name format]
+     * (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated
+     * name is populated in the returned Subscription object. Note that for REST
+     * API requests, you must specify a name in the request.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.name
+     *   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
+     *   (`[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 {string} request.topic
+     *   Required. The name of the topic from which this subscription is receiving
+     *   messages. Format is `projects/{project}/topics/{topic}`. The value of this
+     *   field will be `_deleted-topic_` if the topic has been deleted.
+     * @param {google.pubsub.v1.PushConfig} request.pushConfig
+     *   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.
+     * @param {number} request.ackDeadlineSeconds
+     *   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
+     *   is considered to be <i>outstanding</i>. During that time period, the
+     *   message will not be redelivered (on a best-effort basis).
+     *
+     *   For pull subscriptions, this value is used as the initial value for the ack
+     *   deadline. To override this value for a given message, call
+     *   `ModifyAckDeadline` with the corresponding `ack_id` if using
+     *   non-streaming pull or send the `ack_id` in a
+     *   `StreamingModifyAckDeadlineRequest` if using streaming pull.
+     *   The minimum custom deadline you can specify is 10 seconds.
+     *   The maximum custom deadline you can specify is 600 seconds (10 minutes).
+     *   If this parameter is 0, a default value of 10 seconds is used.
+     *
+     *   For push delivery, this value is also used to set the request timeout for
+     *   the call to the push endpoint.
+     *
+     *   If the subscriber never acknowledges the message, the Pub/Sub
+     *   system will eventually redeliver the message.
+     * @param {boolean} request.retainAckedMessages
+     *   Indicates whether to retain acknowledged messages. If true, then
+     *   messages are not expunged from the subscription's backlog, even if they are
+     *   acknowledged, until they fall out of the `message_retention_duration`
+     *   window. This must be true if you would like to [`Seek` to a timestamp]
+     *   (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in
+     *   the past to replay previously-acknowledged messages.
+     * @param {google.protobuf.Duration} request.messageRetentionDuration
+     *   How long to retain unacknowledged messages in the subscription's backlog,
+     *   from the moment a message is published.
+     *   If `retain_acked_messages` is true, then this also configures the retention
+     *   of acknowledged messages, and thus configures how far back in time a `Seek`
+     *   can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10
+     *   minutes.
+     * @param {number[]} request.labels
+     *   See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
+     *   managing labels</a>.
+     * @param {boolean} request.enableMessageOrdering
+     *   If true, messages published with the same `ordering_key` in `PubsubMessage`
+     *   will be delivered to the subscribers in the order in which they
+     *   are received by the Pub/Sub system. Otherwise, they may be delivered in
+     *   any order.
+     * @param {google.pubsub.v1.ExpirationPolicy} request.expirationPolicy
+     *   A policy that specifies the conditions for this subscription's expiration.
+     *   A subscription is considered active as long as any connected subscriber is
+     *   successfully consuming messages from the subscription or is issuing
+     *   operations on the subscription. If `expiration_policy` is not set, a
+     *   *default policy* with `ttl` of 31 days will be used. The minimum allowed
+     *   value for `expiration_policy.ttl` is 1 day.
+     * @param {string} request.filter
+     *   An expression written in the Pub/Sub [filter
+     *   language](https://cloud.google.com/pubsub/docs/filtering). If non-empty,
+     *   then only `PubsubMessage`s whose `attributes` field matches the filter are
+     *   delivered on this subscription. If empty, then no messages are filtered
+     *   out.
+     * @param {google.pubsub.v1.DeadLetterPolicy} request.deadLetterPolicy
+     *   A policy that specifies the conditions for dead lettering messages in
+     *   this subscription. If dead_letter_policy is not set, dead lettering
+     *   is disabled.
+     *
+     *   The Cloud Pub/Sub service account associated with this subscriptions's
+     *   parent project (i.e.,
+     *   service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
+     *   permission to Acknowledge() messages on this subscription.
+     * @param {google.pubsub.v1.RetryPolicy} request.retryPolicy
+     *   A policy that specifies how Pub/Sub retries message delivery for this
+     *   subscription.
+     *
+     *   If not set, the default retry policy is applied. This generally implies
+     *   that messages will be retried as soon as possible for healthy subscribers.
+     *   RetryPolicy will be triggered on NACKs or acknowledgement deadline
+     *   exceeded events for a given message.
+     * @param {boolean} request.detached
+     *   Indicates whether the subscription is detached from its topic. Detached
+     *   subscriptions don't receive messages from their topic and don't retain any
+     *   backlog. `Pull` and `StreamingPull` requests will return
+     *   FAILED_PRECONDITION. If the subscription is a push subscription, pushes to
+     *   the endpoint will not be made.
+     * @param {google.protobuf.Duration} request.topicMessageRetentionDuration
+     *   Output only. Indicates the minimum duration for which a message is retained
+     *   after it is published to the subscription's topic. If this field is set,
+     *   messages published to the subscription's topic in the last
+     *   `topic_message_retention_duration` are always available to subscribers. See
+     *   the `message_retention_duration` field in `Topic`. This field is set only
+     *   in responses from the server; it is ignored if it is set in any requests.
+     * @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 [Subscription]{@link google.pubsub.v1.Subscription}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   for more details and examples.
+     * @example
+     * ```
+     * const [response] = await client.createSubscription(request);
+     * ```
+     */
     createSubscription(request?: protos.google.pubsub.v1.ISubscription, options?: CallOptions): Promise<[protos.google.pubsub.v1.ISubscription, protos.google.pubsub.v1.ISubscription | undefined, {} | undefined]>;
     createSubscription(request: protos.google.pubsub.v1.ISubscription, options: CallOptions, callback: Callback<protos.google.pubsub.v1.ISubscription, protos.google.pubsub.v1.ISubscription | null | undefined, {} | null | undefined>): void;
     createSubscription(request: protos.google.pubsub.v1.ISubscription, callback: Callback<protos.google.pubsub.v1.ISubscription, protos.google.pubsub.v1.ISubscription | null | undefined, {} | null | undefined>): void;
+    /**
+     * Gets the configuration details of a subscription.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.subscription
+     *   Required. The name of the subscription to get.
+     *   Format is `projects/{project}/subscriptions/{sub}`.
+     * @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 [Subscription]{@link google.pubsub.v1.Subscription}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   for more details and examples.
+     * @example
+     * ```
+     * const [response] = await client.getSubscription(request);
+     * ```
+     */
     getSubscription(request?: protos.google.pubsub.v1.IGetSubscriptionRequest, options?: CallOptions): Promise<[protos.google.pubsub.v1.ISubscription, protos.google.pubsub.v1.IGetSubscriptionRequest | undefined, {} | undefined]>;
     getSubscription(request: protos.google.pubsub.v1.IGetSubscriptionRequest, options: CallOptions, callback: Callback<protos.google.pubsub.v1.ISubscription, protos.google.pubsub.v1.IGetSubscriptionRequest | null | undefined, {} | null | undefined>): void;
     getSubscription(request: protos.google.pubsub.v1.IGetSubscriptionRequest, callback: Callback<protos.google.pubsub.v1.ISubscription, protos.google.pubsub.v1.IGetSubscriptionRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Updates an existing subscription. Note that certain properties of a
+     * subscription, such as its topic, are not modifiable.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {google.pubsub.v1.Subscription} request.subscription
+     *   Required. The updated subscription object.
+     * @param {google.protobuf.FieldMask} request.updateMask
+     *   Required. Indicates which fields in the provided subscription to update.
+     *   Must be specified and non-empty.
+     * @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 [Subscription]{@link google.pubsub.v1.Subscription}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   for more details and examples.
+     * @example
+     * ```
+     * const [response] = await client.updateSubscription(request);
+     * ```
+     */
     updateSubscription(request?: protos.google.pubsub.v1.IUpdateSubscriptionRequest, options?: CallOptions): Promise<[protos.google.pubsub.v1.ISubscription, protos.google.pubsub.v1.IUpdateSubscriptionRequest | undefined, {} | undefined]>;
     updateSubscription(request: protos.google.pubsub.v1.IUpdateSubscriptionRequest, options: CallOptions, callback: Callback<protos.google.pubsub.v1.ISubscription, protos.google.pubsub.v1.IUpdateSubscriptionRequest | null | undefined, {} | null | undefined>): void;
     updateSubscription(request: protos.google.pubsub.v1.IUpdateSubscriptionRequest, callback: Callback<protos.google.pubsub.v1.ISubscription, protos.google.pubsub.v1.IUpdateSubscriptionRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Deletes an existing subscription. All messages retained in the subscription
+     * are immediately dropped. Calls to `Pull` after deletion will return
+     * `NOT_FOUND`. After a subscription is deleted, a new one may be created with
+     * the same name, but the new one has no association with the old
+     * subscription or its topic unless the same topic is specified.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.subscription
+     *   Required. The subscription to delete.
+     *   Format is `projects/{project}/subscriptions/{sub}`.
+     * @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
+     * ```
+     * const [response] = await client.deleteSubscription(request);
+     * ```
+     */
     deleteSubscription(request?: protos.google.pubsub.v1.IDeleteSubscriptionRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.pubsub.v1.IDeleteSubscriptionRequest | undefined, {} | undefined]>;
     deleteSubscription(request: protos.google.pubsub.v1.IDeleteSubscriptionRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.pubsub.v1.IDeleteSubscriptionRequest | null | undefined, {} | null | undefined>): void;
     deleteSubscription(request: protos.google.pubsub.v1.IDeleteSubscriptionRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.pubsub.v1.IDeleteSubscriptionRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Modifies the ack deadline for a specific message. This method is useful
+     * to indicate that more time is needed to process a message by the
+     * subscriber, or to make the message available for redelivery if the
+     * processing was interrupted. Note that this does not modify the
+     * subscription-level `ackDeadlineSeconds` used for subsequent messages.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.subscription
+     *   Required. The name of the subscription.
+     *   Format is `projects/{project}/subscriptions/{sub}`.
+     * @param {string[]} request.ackIds
+     *   Required. List of acknowledgment IDs.
+     * @param {number} request.ackDeadlineSeconds
+     *   Required. The new ack deadline with respect to the time this request was
+     *   sent to the Pub/Sub system. For example, if the value is 10, the new ack
+     *   deadline will expire 10 seconds after the `ModifyAckDeadline` call was
+     *   made. Specifying zero might immediately make the message available for
+     *   delivery to another subscriber client. This typically results in an
+     *   increase in the rate of message redeliveries (that is, duplicates).
+     *   The minimum deadline you can specify is 0 seconds.
+     *   The maximum deadline you can specify is 600 seconds (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 [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
+     * ```
+     * const [response] = await client.modifyAckDeadline(request);
+     * ```
+     */
     modifyAckDeadline(request?: protos.google.pubsub.v1.IModifyAckDeadlineRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.pubsub.v1.IModifyAckDeadlineRequest | undefined, {} | undefined]>;
     modifyAckDeadline(request: protos.google.pubsub.v1.IModifyAckDeadlineRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.pubsub.v1.IModifyAckDeadlineRequest | null | undefined, {} | null | undefined>): void;
     modifyAckDeadline(request: protos.google.pubsub.v1.IModifyAckDeadlineRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.pubsub.v1.IModifyAckDeadlineRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Acknowledges the messages associated with the `ack_ids` in the
+     * `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages
+     * from the subscription.
+     *
+     * Acknowledging a message whose ack deadline has expired may succeed,
+     * but such a message may be redelivered later. Acknowledging a message more
+     * than once will not result in an error.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.subscription
+     *   Required. The subscription whose message is being acknowledged.
+     *   Format is `projects/{project}/subscriptions/{sub}`.
+     * @param {string[]} request.ackIds
+     *   Required. The acknowledgment ID for the messages being acknowledged that
+     *   was returned by the Pub/Sub system in the `Pull` response. Must not be
+     *   empty.
+     * @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
+     * ```
+     * const [response] = await client.acknowledge(request);
+     * ```
+     */
     acknowledge(request?: protos.google.pubsub.v1.IAcknowledgeRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.pubsub.v1.IAcknowledgeRequest | undefined, {} | undefined]>;
     acknowledge(request: protos.google.pubsub.v1.IAcknowledgeRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.pubsub.v1.IAcknowledgeRequest | null | undefined, {} | null | undefined>): void;
     acknowledge(request: protos.google.pubsub.v1.IAcknowledgeRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.pubsub.v1.IAcknowledgeRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Pulls messages from the server. The server may return `UNAVAILABLE` if
+     * there are too many concurrent pull requests pending for the given
+     * subscription.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.subscription
+     *   Required. The subscription from which messages should be pulled.
+     *   Format is `projects/{project}/subscriptions/{sub}`.
+     * @param {boolean} [request.returnImmediately]
+     *   Optional. If this field set to true, the system will respond immediately
+     *   even if it there are no messages available to return in the `Pull`
+     *   response. Otherwise, the system may wait (for a bounded amount of time)
+     *   until at least one message is available, rather than returning no messages.
+     *   Warning: setting this field to `true` is discouraged because it adversely
+     *   impacts the performance of `Pull` operations. We recommend that users do
+     *   not set this field.
+     * @param {number} request.maxMessages
+     *   Required. The maximum number of messages to return for this request. Must
+     *   be a positive integer. The Pub/Sub system may return fewer than the number
+     *   specified.
+     * @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 [PullResponse]{@link google.pubsub.v1.PullResponse}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   for more details and examples.
+     * @example
+     * ```
+     * const [response] = await client.pull(request);
+     * ```
+     */
     pull(request?: protos.google.pubsub.v1.IPullRequest, options?: CallOptions): Promise<[protos.google.pubsub.v1.IPullResponse, protos.google.pubsub.v1.IPullRequest | undefined, {} | undefined]>;
     pull(request: protos.google.pubsub.v1.IPullRequest, options: CallOptions, callback: Callback<protos.google.pubsub.v1.IPullResponse, protos.google.pubsub.v1.IPullRequest | null | undefined, {} | null | undefined>): void;
     pull(request: protos.google.pubsub.v1.IPullRequest, callback: Callback<protos.google.pubsub.v1.IPullResponse, protos.google.pubsub.v1.IPullRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Modifies the `PushConfig` for a specified subscription.
+     *
+     * This may be used to change a push subscription to a pull one (signified by
+     * an empty `PushConfig`) or vice versa, or change the endpoint URL and other
+     * attributes of a push subscription. Messages will accumulate for delivery
+     * continuously through the call regardless of changes to the `PushConfig`.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.subscription
+     *   Required. The name of the subscription.
+     *   Format is `projects/{project}/subscriptions/{sub}`.
+     * @param {google.pubsub.v1.PushConfig} request.pushConfig
+     *   Required. The push configuration for future deliveries.
+     *
+     *   An empty `pushConfig` indicates that the Pub/Sub system should
+     *   stop pushing messages from the given subscription and allow
+     *   messages to be pulled and acknowledged - effectively pausing
+     *   the subscription if `Pull` or `StreamingPull` is not called.
+     * @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
+     * ```
+     * const [response] = await client.modifyPushConfig(request);
+     * ```
+     */
     modifyPushConfig(request?: protos.google.pubsub.v1.IModifyPushConfigRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.pubsub.v1.IModifyPushConfigRequest | undefined, {} | undefined]>;
     modifyPushConfig(request: protos.google.pubsub.v1.IModifyPushConfigRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.pubsub.v1.IModifyPushConfigRequest | null | undefined, {} | null | undefined>): void;
     modifyPushConfig(request: protos.google.pubsub.v1.IModifyPushConfigRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.pubsub.v1.IModifyPushConfigRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Gets the configuration details of a snapshot. Snapshots are used in
+     * <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>
+     * 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.snapshot
+     *   Required. The name of the snapshot to get.
+     *   Format is `projects/{project}/snapshots/{snap}`.
+     * @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 [Snapshot]{@link google.pubsub.v1.Snapshot}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   for more details and examples.
+     * @example
+     * ```
+     * const [response] = await client.getSnapshot(request);
+     * ```
+     */
     getSnapshot(request?: protos.google.pubsub.v1.IGetSnapshotRequest, options?: CallOptions): Promise<[protos.google.pubsub.v1.ISnapshot, protos.google.pubsub.v1.IGetSnapshotRequest | undefined, {} | undefined]>;
     getSnapshot(request: protos.google.pubsub.v1.IGetSnapshotRequest, options: CallOptions, callback: Callback<protos.google.pubsub.v1.ISnapshot, protos.google.pubsub.v1.IGetSnapshotRequest | null | undefined, {} | null | undefined>): void;
     getSnapshot(request: protos.google.pubsub.v1.IGetSnapshotRequest, callback: Callback<protos.google.pubsub.v1.ISnapshot, protos.google.pubsub.v1.IGetSnapshotRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Creates a snapshot from the requested subscription. 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.
+     * If the snapshot already exists, returns `ALREADY_EXISTS`.
+     * If the requested subscription doesn't exist, returns `NOT_FOUND`.
+     * If the backlog in the subscription is too old -- and the resulting snapshot
+     * would expire in less than 1 hour -- then `FAILED_PRECONDITION` is returned.
+     * See also the `Snapshot.expire_time` field. If the name is not provided in
+     * the request, the server will assign a random
+     * name for this snapshot on the same project as the subscription, conforming
+     * to the [resource name format]
+     * (https://cloud.google.com/pubsub/docs/admin#resource_names). The
+     * generated name is populated in the returned Snapshot object. Note that for
+     * REST API requests, you must specify a name in the request.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.name
+     *   Required. User-provided name for this snapshot. If the name is not provided
+     *   in the request, the server will assign a random name for this snapshot on
+     *   the same project as the subscription. Note that for REST API requests, you
+     *   must specify a name.  See the <a
+     *   href="https://cloud.google.com/pubsub/docs/admin#resource_names"> resource
+     *   name rules</a>. Format is `projects/{project}/snapshots/{snap}`.
+     * @param {string} request.subscription
+     *   Required. The subscription whose backlog the snapshot retains.
+     *   Specifically, the created snapshot is guaranteed to retain:
+     *    (a) The existing backlog on the subscription. More precisely, this is
+     *        defined as the messages in the subscription's backlog that are
+     *        unacknowledged upon the successful completion of the
+     *        `CreateSnapshot` request; as well as:
+     *    (b) Any messages published to the subscription's topic following the
+     *        successful completion of the CreateSnapshot request.
+     *   Format is `projects/{project}/subscriptions/{sub}`.
+     * @param {number[]} request.labels
+     *   See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
+     *   managing labels</a>.
+     * @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 [Snapshot]{@link google.pubsub.v1.Snapshot}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   for more details and examples.
+     * @example
+     * ```
+     * const [response] = await client.createSnapshot(request);
+     * ```
+     */
     createSnapshot(request?: protos.google.pubsub.v1.ICreateSnapshotRequest, options?: CallOptions): Promise<[protos.google.pubsub.v1.ISnapshot, protos.google.pubsub.v1.ICreateSnapshotRequest | undefined, {} | undefined]>;
     createSnapshot(request: protos.google.pubsub.v1.ICreateSnapshotRequest, options: CallOptions, callback: Callback<protos.google.pubsub.v1.ISnapshot, protos.google.pubsub.v1.ICreateSnapshotRequest | null | undefined, {} | null | undefined>): void;
     createSnapshot(request: protos.google.pubsub.v1.ICreateSnapshotRequest, callback: Callback<protos.google.pubsub.v1.ISnapshot, protos.google.pubsub.v1.ICreateSnapshotRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Updates an existing snapshot. Snapshots are used in
+     * <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>
+     * 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 {google.pubsub.v1.Snapshot} request.snapshot
+     *   Required. The updated snapshot object.
+     * @param {google.protobuf.FieldMask} request.updateMask
+     *   Required. Indicates which fields in the provided snapshot to update.
+     *   Must be specified and non-empty.
+     * @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 [Snapshot]{@link google.pubsub.v1.Snapshot}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   for more details and examples.
+     * @example
+     * ```
+     * const [response] = await client.updateSnapshot(request);
+     * ```
+     */
     updateSnapshot(request?: protos.google.pubsub.v1.IUpdateSnapshotRequest, options?: CallOptions): Promise<[protos.google.pubsub.v1.ISnapshot, protos.google.pubsub.v1.IUpdateSnapshotRequest | undefined, {} | undefined]>;
     updateSnapshot(request: protos.google.pubsub.v1.IUpdateSnapshotRequest, options: CallOptions, callback: Callback<protos.google.pubsub.v1.ISnapshot, protos.google.pubsub.v1.IUpdateSnapshotRequest | null | undefined, {} | null | undefined>): void;
     updateSnapshot(request: protos.google.pubsub.v1.IUpdateSnapshotRequest, callback: Callback<protos.google.pubsub.v1.ISnapshot, protos.google.pubsub.v1.IUpdateSnapshotRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Removes an existing snapshot. 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.
+     * When the snapshot is deleted, all messages retained in the snapshot
+     * are immediately dropped. After a snapshot is deleted, a new one may be
+     * created with the same name, but the new one has no association with the old
+     * snapshot or its subscription, unless the same subscription is specified.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.snapshot
+     *   Required. The name of the snapshot to delete.
+     *   Format is `projects/{project}/snapshots/{snap}`.
+     * @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
+     * ```
+     * const [response] = await client.deleteSnapshot(request);
+     * ```
+     */
     deleteSnapshot(request?: protos.google.pubsub.v1.IDeleteSnapshotRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.pubsub.v1.IDeleteSnapshotRequest | undefined, {} | undefined]>;
     deleteSnapshot(request: protos.google.pubsub.v1.IDeleteSnapshotRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.pubsub.v1.IDeleteSnapshotRequest | null | undefined, {} | null | undefined>): void;
     deleteSnapshot(request: protos.google.pubsub.v1.IDeleteSnapshotRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.pubsub.v1.IDeleteSnapshotRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Seeks an existing subscription to a point in time or to a given snapshot,
+     * whichever is provided in the request. 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. Note that both the subscription and the
+     * snapshot must be on the same topic.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.subscription
+     *   Required. The subscription to affect.
+     * @param {google.protobuf.Timestamp} request.time
+     *   The time to seek to.
+     *   Messages retained in the subscription that were published before this
+     *   time are marked as acknowledged, and messages retained in the
+     *   subscription that were published after this time are marked as
+     *   unacknowledged. Note that this operation affects only those messages
+     *   retained in the subscription (configured by the combination of
+     *   `message_retention_duration` and `retain_acked_messages`). For example,
+     *   if `time` corresponds to a point before the message retention
+     *   window (or to a point before the system's notion of the subscription
+     *   creation time), only retained messages will be marked as unacknowledged,
+     *   and already-expunged messages will not be restored.
+     * @param {string} request.snapshot
+     *   The snapshot to seek to. The snapshot's topic must be the same as that of
+     *   the provided subscription.
+     *   Format is `projects/{project}/snapshots/{snap}`.
+     * @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 [SeekResponse]{@link google.pubsub.v1.SeekResponse}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   for more details and examples.
+     * @example
+     * ```
+     * const [response] = await client.seek(request);
+     * ```
+     */
     seek(request?: protos.google.pubsub.v1.ISeekRequest, options?: CallOptions): Promise<[protos.google.pubsub.v1.ISeekResponse, protos.google.pubsub.v1.ISeekRequest | undefined, {} | undefined]>;
     seek(request: protos.google.pubsub.v1.ISeekRequest, options: CallOptions, callback: Callback<protos.google.pubsub.v1.ISeekResponse, protos.google.pubsub.v1.ISeekRequest | null | undefined, {} | null | undefined>): void;
     seek(request: protos.google.pubsub.v1.ISeekRequest, callback: Callback<protos.google.pubsub.v1.ISeekResponse, protos.google.pubsub.v1.ISeekRequest | null | undefined, {} | null | undefined>): void;
@@ -162,13 +664,42 @@ export declare class SubscriberClient {
      *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#bi-directional-streaming)
      *   for more details and examples.
      * @example
+     * ```
      * const stream = client.streamingPull();
      * stream.on('data', (response) => { ... });
      * stream.on('end', () => { ... });
      * stream.write(request);
      * stream.end();
+     * ```
      */
     streamingPull(options?: CallOptions): gax.CancellableStream;
+    /**
+     * Lists matching subscriptions.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.project
+     *   Required. The name of the project in which to list subscriptions.
+     *   Format is `projects/{project-id}`.
+     * @param {number} request.pageSize
+     *   Maximum number of subscriptions to return.
+     * @param {string} request.pageToken
+     *   The value returned by the last `ListSubscriptionsResponse`; indicates that
+     *   this is a continuation of a prior `ListSubscriptions` 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 [Subscription]{@link google.pubsub.v1.Subscription}.
+     *   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 `listSubscriptionsAsync()`
+     *   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.
+     */
     listSubscriptions(request?: protos.google.pubsub.v1.IListSubscriptionsRequest, options?: CallOptions): Promise<[protos.google.pubsub.v1.ISubscription[], protos.google.pubsub.v1.IListSubscriptionsRequest | null, protos.google.pubsub.v1.IListSubscriptionsResponse]>;
     listSubscriptions(request: protos.google.pubsub.v1.IListSubscriptionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.pubsub.v1.IListSubscriptionsRequest, protos.google.pubsub.v1.IListSubscriptionsResponse | null | undefined, protos.google.pubsub.v1.ISubscription>): void;
     listSubscriptions(request: protos.google.pubsub.v1.IListSubscriptionsRequest, callback: PaginationCallback<protos.google.pubsub.v1.IListSubscriptionsRequest, protos.google.pubsub.v1.IListSubscriptionsResponse | null | undefined, protos.google.pubsub.v1.ISubscription>): void;
@@ -224,12 +755,45 @@ export declare class SubscriberClient {
      *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
      *   for more details and examples.
      * @example
+     * ```
      * const iterable = client.listSubscriptionsAsync(request);
      * for await (const response of iterable) {
      *   // process response
      * }
+     * ```
      */
     listSubscriptionsAsync(request?: protos.google.pubsub.v1.IListSubscriptionsRequest, options?: CallOptions): AsyncIterable<protos.google.pubsub.v1.ISubscription>;
+    /**
+     * Lists the existing snapshots. 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.project
+     *   Required. The name of the project in which to list snapshots.
+     *   Format is `projects/{project-id}`.
+     * @param {number} request.pageSize
+     *   Maximum number of snapshots to return.
+     * @param {string} request.pageToken
+     *   The value returned by the last `ListSnapshotsResponse`; indicates that this
+     *   is a continuation of a prior `ListSnapshots` 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 [Snapshot]{@link google.pubsub.v1.Snapshot}.
+     *   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 `listSnapshotsAsync()`
+     *   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.
+     */
     listSnapshots(request?: protos.google.pubsub.v1.IListSnapshotsRequest, options?: CallOptions): Promise<[protos.google.pubsub.v1.ISnapshot[], protos.google.pubsub.v1.IListSnapshotsRequest | null, protos.google.pubsub.v1.IListSnapshotsResponse]>;
     listSnapshots(request: protos.google.pubsub.v1.IListSnapshotsRequest, options: CallOptions, callback: PaginationCallback<protos.google.pubsub.v1.IListSnapshotsRequest, protos.google.pubsub.v1.IListSnapshotsResponse | null | undefined, protos.google.pubsub.v1.ISnapshot>): void;
     listSnapshots(request: protos.google.pubsub.v1.IListSnapshotsRequest, callback: PaginationCallback<protos.google.pubsub.v1.IListSnapshotsRequest, protos.google.pubsub.v1.IListSnapshotsResponse | null | undefined, protos.google.pubsub.v1.ISnapshot>): void;
@@ -285,10 +849,12 @@ export declare class SubscriberClient {
      *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
      *   for more details and examples.
      * @example
+     * ```
      * const iterable = client.listSnapshotsAsync(request);
      * for await (const response of iterable) {
      *   // process response
      * }
+     * ```
      */
     listSnapshotsAsync(request?: protos.google.pubsub.v1.IListSnapshotsRequest, options?: CallOptions): AsyncIterable<protos.google.pubsub.v1.ISnapshot>;
     /**