@google-cloud/pubsub 4.11.0 → 5.0.0

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

@@ -18,6 +18,7 @@ export declare class PublisherClient {
     private _defaults;
     private _universeDomain;
     private _servicePath;
+    private _log;
     auth: gax.GoogleAuth;
     descriptors: Descriptors;
     warn: (code: string, message: string, warnType?: string) => void;
@@ -53,7 +54,7 @@ export declare class PublisherClient {
      *     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.
@@ -160,12 +161,17 @@ export declare class PublisherClient {
      *   Output only. An output-only field indicating the state of the topic.
      * @param {google.pubsub.v1.IngestionDataSourceSettings} [request.ingestionDataSourceSettings]
      *   Optional. Settings for ingestion from a data source into this topic.
+     * @param {number[]} [request.messageTransforms]
+     *   Optional. Transforms to be applied to messages published to the topic.
+     *   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.Topic|Topic}.
      *   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/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,
@@ -194,6 +200,8 @@ export declare class PublisherClient {
      *   The first element of the array is an object representing {@link protos.google.pubsub.v1.Topic|Topic}.
      *   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/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,
@@ -219,6 +227,8 @@ export declare class PublisherClient {
      *   The first element of the array is an object representing {@link protos.google.pubsub.v1.PublishResponse|PublishResponse}.
      *   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/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,
@@ -241,6 +251,8 @@ export declare class PublisherClient {
      *   The first element of the array is an object representing {@link protos.google.pubsub.v1.Topic|Topic}.
      *   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/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,
@@ -267,6 +279,8 @@ export declare class PublisherClient {
      *   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/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,
@@ -292,6 +306,8 @@ export declare class PublisherClient {
      *   The first element of the array is an object representing {@link protos.google.pubsub.v1.DetachSubscriptionResponse|DetachSubscriptionResponse}.
      *   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/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,
@@ -334,7 +350,7 @@ export declare class PublisherClient {
     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;
     /**
-     * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
+     * Equivalent to `listTopics`, but returns a NodeJS Stream object.
      * @param {Object} request
      *   The request object that will be sent.
      * @param {string} request.project
@@ -382,6 +398,8 @@ export declare class PublisherClient {
      *   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/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>;
     /**
@@ -418,7 +436,7 @@ export declare class PublisherClient {
     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;
     /**
-     * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
+     * Equivalent to `listTopicSubscriptions`, but returns a NodeJS Stream object.
      * @param {Object} request
      *   The request object that will be sent.
      * @param {string} request.topic
@@ -466,6 +484,8 @@ export declare class PublisherClient {
      *   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/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>;
     /**
@@ -506,7 +526,7 @@ export declare class PublisherClient {
     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;
     /**
-     * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
+     * Equivalent to `listTopicSnapshots`, but returns a NodeJS Stream object.
      * @param {Object} request
      *   The request object that will be sent.
      * @param {string} request.topic
@@ -554,6 +574,8 @@ export declare class PublisherClient {
      *   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/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>;
     /**