@google-cloud/pubsub 4.11.0 → 5.0.0

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

@@ -19,6 +19,7 @@ export declare class SubscriberClient {
     private _defaults;
     private _universeDomain;
     private _servicePath;
+    private _log;
     auth: gax.GoogleAuth;
     descriptors: Descriptors;
     warn: (code: string, message: string, warnType?: string) => void;
@@ -54,7 +55,7 @@ export declare class SubscriberClient {
      *     Developer's Console, e.g. 'grape-spaceship-123'. We will also check
      *     the environment variable GCLOUD_PROJECT for your project ID. If your
      *     app is running in an environment which supports
-     *     {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
+     *     {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
      *     your project ID will be detected automatically.
      * @param {string} [options.apiEndpoint] - The domain name of the
      *     API remote host.
@@ -257,12 +258,17 @@ export declare class SubscriberClient {
      * @param {google.pubsub.v1.Subscription.AnalyticsHubSubscriptionInfo} request.analyticsHubSubscriptionInfo
      *   Output only. Information about the associated Analytics Hub subscription.
      *   Only set if the subscritpion is created by Analytics Hub.
+     * @param {number[]} [request.messageTransforms]
+     *   Optional. Transforms to be applied to messages before they are delivered to
+     *   subscribers. Transforms are applied in the order 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 {@link protos.google.pubsub.v1.Subscription|Subscription}.
      *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
      *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/subscriber.create_subscription.js</caption>
+     * region_tag:pubsub_v1_generated_Subscriber_CreateSubscription_async
      */
     createSubscription(request?: protos.google.pubsub.v1.ISubscription, options?: CallOptions): Promise<[
         protos.google.pubsub.v1.ISubscription,
@@ -285,6 +291,8 @@ export declare class SubscriberClient {
      *   The first element of the array is an object representing {@link protos.google.pubsub.v1.Subscription|Subscription}.
      *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
      *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/subscriber.get_subscription.js</caption>
+     * region_tag:pubsub_v1_generated_Subscriber_GetSubscription_async
      */
     getSubscription(request?: protos.google.pubsub.v1.IGetSubscriptionRequest, options?: CallOptions): Promise<[
         protos.google.pubsub.v1.ISubscription,
@@ -311,6 +319,8 @@ export declare class SubscriberClient {
      *   The first element of the array is an object representing {@link protos.google.pubsub.v1.Subscription|Subscription}.
      *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
      *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/subscriber.update_subscription.js</caption>
+     * region_tag:pubsub_v1_generated_Subscriber_UpdateSubscription_async
      */
     updateSubscription(request?: protos.google.pubsub.v1.IUpdateSubscriptionRequest, options?: CallOptions): Promise<[
         protos.google.pubsub.v1.ISubscription,
@@ -337,6 +347,8 @@ export declare class SubscriberClient {
      *   The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
      *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
      *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/subscriber.delete_subscription.js</caption>
+     * region_tag:pubsub_v1_generated_Subscriber_DeleteSubscription_async
      */
     deleteSubscription(request?: protos.google.pubsub.v1.IDeleteSubscriptionRequest, options?: CallOptions): Promise<[
         protos.google.protobuf.IEmpty,
@@ -375,6 +387,8 @@ export declare class SubscriberClient {
      *   The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
      *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
      *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/subscriber.modify_ack_deadline.js</caption>
+     * region_tag:pubsub_v1_generated_Subscriber_ModifyAckDeadline_async
      */
     modifyAckDeadline(request?: protos.google.pubsub.v1.IModifyAckDeadlineRequest, options?: CallOptions): Promise<[
         protos.google.protobuf.IEmpty,
@@ -407,6 +421,8 @@ export declare class SubscriberClient {
      *   The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
      *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
      *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/subscriber.acknowledge.js</caption>
+     * region_tag:pubsub_v1_generated_Subscriber_Acknowledge_async
      */
     acknowledge(request?: protos.google.pubsub.v1.IAcknowledgeRequest, options?: CallOptions): Promise<[
         protos.google.protobuf.IEmpty,
@@ -441,6 +457,8 @@ export declare class SubscriberClient {
      *   The first element of the array is an object representing {@link protos.google.pubsub.v1.PullResponse|PullResponse}.
      *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
      *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/subscriber.pull.js</caption>
+     * region_tag:pubsub_v1_generated_Subscriber_Pull_async
      */
     pull(request?: protos.google.pubsub.v1.IPullRequest, options?: CallOptions): Promise<[
         protos.google.pubsub.v1.IPullResponse,
@@ -475,6 +493,8 @@ export declare class SubscriberClient {
      *   The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
      *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
      *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/subscriber.modify_push_config.js</caption>
+     * region_tag:pubsub_v1_generated_Subscriber_ModifyPushConfig_async
      */
     modifyPushConfig(request?: protos.google.pubsub.v1.IModifyPushConfigRequest, options?: CallOptions): Promise<[
         protos.google.protobuf.IEmpty,
@@ -501,6 +521,8 @@ export declare class SubscriberClient {
      *   The first element of the array is an object representing {@link protos.google.pubsub.v1.Snapshot|Snapshot}.
      *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
      *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/subscriber.get_snapshot.js</caption>
+     * region_tag:pubsub_v1_generated_Subscriber_GetSnapshot_async
      */
     getSnapshot(request?: protos.google.pubsub.v1.IGetSnapshotRequest, options?: CallOptions): Promise<[
         protos.google.pubsub.v1.ISnapshot,
@@ -555,6 +577,8 @@ export declare class SubscriberClient {
      *   The first element of the array is an object representing {@link protos.google.pubsub.v1.Snapshot|Snapshot}.
      *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
      *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/subscriber.create_snapshot.js</caption>
+     * region_tag:pubsub_v1_generated_Subscriber_CreateSnapshot_async
      */
     createSnapshot(request?: protos.google.pubsub.v1.ICreateSnapshotRequest, options?: CallOptions): Promise<[
         protos.google.pubsub.v1.ISnapshot,
@@ -584,6 +608,8 @@ export declare class SubscriberClient {
      *   The first element of the array is an object representing {@link protos.google.pubsub.v1.Snapshot|Snapshot}.
      *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
      *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/subscriber.update_snapshot.js</caption>
+     * region_tag:pubsub_v1_generated_Subscriber_UpdateSnapshot_async
      */
     updateSnapshot(request?: protos.google.pubsub.v1.IUpdateSnapshotRequest, options?: CallOptions): Promise<[
         protos.google.pubsub.v1.ISnapshot,
@@ -614,6 +640,8 @@ export declare class SubscriberClient {
      *   The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
      *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
      *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/subscriber.delete_snapshot.js</caption>
+     * region_tag:pubsub_v1_generated_Subscriber_DeleteSnapshot_async
      */
     deleteSnapshot(request?: protos.google.pubsub.v1.IDeleteSnapshotRequest, options?: CallOptions): Promise<[
         protos.google.protobuf.IEmpty,
@@ -657,6 +685,8 @@ export declare class SubscriberClient {
      *   The first element of the array is an object representing {@link protos.google.pubsub.v1.SeekResponse|SeekResponse}.
      *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
      *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/subscriber.seek.js</caption>
+     * region_tag:pubsub_v1_generated_Subscriber_Seek_async
      */
     seek(request?: protos.google.pubsub.v1.ISeekRequest, options?: CallOptions): Promise<[
         protos.google.pubsub.v1.ISeekResponse,
@@ -682,6 +712,8 @@ export declare class SubscriberClient {
      *   will emit objects representing {@link protos.google.pubsub.v1.StreamingPullResponse|StreamingPullResponse} on 'data' event asynchronously.
      *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#bi-directional-streaming | documentation }
      *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/subscriber.streaming_pull.js</caption>
+     * region_tag:pubsub_v1_generated_Subscriber_StreamingPull_async
      */
     streamingPull(options?: CallOptions): gax.CancellableStream;
     /**
@@ -718,7 +750,7 @@ export declare class SubscriberClient {
     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;
     /**
-     * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
+     * Equivalent to `listSubscriptions`, but returns a NodeJS Stream object.
      * @param {Object} request
      *   The request object that will be sent.
      * @param {string} request.project
@@ -766,6 +798,8 @@ export declare class SubscriberClient {
      *   so you can stop the iteration when you don't need more results.
      *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
      *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/subscriber.list_subscriptions.js</caption>
+     * region_tag:pubsub_v1_generated_Subscriber_ListSubscriptions_async
      */
     listSubscriptionsAsync(request?: protos.google.pubsub.v1.IListSubscriptionsRequest, options?: CallOptions): AsyncIterable<protos.google.pubsub.v1.ISubscription>;
     /**
@@ -806,7 +840,7 @@ export declare class SubscriberClient {
     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;
     /**
-     * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
+     * Equivalent to `listSnapshots`, but returns a NodeJS Stream object.
      * @param {Object} request
      *   The request object that will be sent.
      * @param {string} request.project
@@ -854,6 +888,8 @@ export declare class SubscriberClient {
      *   so you can stop the iteration when you don't need more results.
      *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
      *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/subscriber.list_snapshots.js</caption>
+     * region_tag:pubsub_v1_generated_Subscriber_ListSnapshots_async
      */
     listSnapshotsAsync(request?: protos.google.pubsub.v1.IListSnapshotsRequest, options?: CallOptions): AsyncIterable<protos.google.pubsub.v1.ISnapshot>;
     /**