@google-cloud/pubsub 2.18.1 → 2.18.5

package/build/src/topic.d.ts

@@ -51,13 +51,17 @@ export declare type MessageOptions = PubsubMessage & {
  * @param {PublishOptions} [options] Publisher configuration object.
  *
  * @example
+ * ```
  * const {PubSub} = require('@google-cloud/pubsub');
  * const pubsub = new PubSub();
  *
  * const topic = pubsub.topic('my-topic');
  *
- * @example <caption>To enable message ordering, set `enableMessageOrdering` to true. Please note that this does not persist to an actual topic.</caption>
+ * ```
+ * @example To enable message ordering, set `enableMessageOrdering` to true. Please note that this does not persist to an actual topic.
+ * ```
  * const topic = pubsub.topic('ordered-topic', {enableMessageOrdering: true});
+ * ```
  */
 export declare class Topic {
     name: string;
@@ -69,35 +73,441 @@ export declare class Topic {
     publisher: Publisher;
     getSubscriptionsStream: () => ObjectStream<Subscription>;
     constructor(pubsub: PubSub, name: string, options?: PublishOptions);
+    /**
+     * Immediately sends all remaining queued data. This is mostly useful
+     * if you are planning to call close() on the PubSub object that holds
+     * the server connections.
+     *
+     * @param {EmptyCallback} [callback] Callback function.
+     * @returns {Promise<EmptyResponse>}
+     */
     flush(): Promise<void>;
     flush(callback: EmptyCallback): void;
+    /**
+     * Create a topic.
+     *
+     * @param {object} [gaxOpts] Request configuration options, outlined
+     *     here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
+     * @param {CreateTopicCallback} [callback] Callback function.
+     * @returns {Promise<CreateTopicResponse>}
+     *
+     * @example
+     * ```
+     * const {PubSub} = require('@google-cloud/pubsub');
+     * const pubsub = new PubSub();
+     *
+     * const topic = pubsub.topic('my-topic');
+     *
+     * topic.create((err, topic, apiResponse) => {
+     *   if (!err) {
+     *     // The topic was created successfully.
+     *   }
+     * });
+     *
+     * //-
+     * // If the callback is omitted, we'll return a Promise.
+     * //-
+     * topic.create().then((data) => {
+     *   const topic = data[0];
+     *   const apiResponse = data[1];
+     * });
+     * ```
+     */
     create(gaxOpts?: CallOptions): Promise<CreateTopicResponse>;
     create(callback: CreateTopicCallback): void;
     create(gaxOpts: CallOptions, callback: CreateTopicCallback): void;
+    /**
+     * Create a subscription to this topic.
+     *
+     * @see [Subscriptions: create API Documentation]{@link https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/create}
+     *
+     * @throws {Error} If subscription name is omitted.
+     *
+     * @param {string} name The name of the subscription.
+     * @param {CreateSubscriptionRequest} [options] See a
+     *     [Subscription
+     * resource](https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions).
+     * @param {CreateSubscriptionCallback} [callback] Callback function.
+     * @returns {Promise<CreateSubscriptionResponse>}
+     *
+     * @example
+     * ```
+     * const {PubSub} = require('@google-cloud/pubsub');
+     * const pubsub = new PubSub();
+     *
+     * const topic = pubsub.topic('my-topic');
+     * const callback = function(err, subscription, apiResponse) {};
+     *
+     * // Without specifying any options.
+     * topic.createSubscription('newMessages', callback);
+     *
+     * // With options.
+     * topic.createSubscription('newMessages', {
+     *   ackDeadlineSeconds: 90
+     * }, callback);
+     *
+     * //-
+     * // If the callback is omitted, we'll return a Promise.
+     * //-
+     * topic.createSubscription('newMessages').then((data) => {
+     *   const subscription = data[0];
+     *   const apiResponse = data[1];
+     * });
+     * ```
+     */
     createSubscription(name: string, callback: CreateSubscriptionCallback): void;
     createSubscription(name: string, options?: CreateSubscriptionOptions): Promise<CreateSubscriptionResponse>;
     createSubscription(name: string, options: CreateSubscriptionOptions, callback: CreateSubscriptionCallback): void;
+    /**
+     * Delete the topic. This will not delete subscriptions to this topic.
+     *
+     * @see [Topics: delete API Documentation]{@link https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics/delete}
+     *
+     * @param {object} [gaxOpts] Request configuration options, outlined
+     *     here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
+     * @param {function} [callback] The callback function.
+     * @param {?error} callback.err An error returned while making this
+     *     request.
+     * @param {object} callback.apiResponse Raw API response.
+     *
+     * @example
+     * ```
+     * const {PubSub} = require('@google-cloud/pubsub');
+     * const pubsub = new PubSub();
+     *
+     * const topic = pubsub.topic('my-topic');
+     *
+     * topic.delete((err, apiResponse) => {});
+     *
+     * //-
+     * // If the callback is omitted, we'll return a Promise.
+     * //-
+     * topic.delete().then((data) => {
+     *   const apiResponse = data[0];
+     * });
+     * ```
+     */
     delete(callback: EmptyCallback): void;
     delete(gaxOpts?: CallOptions): Promise<EmptyResponse>;
     delete(gaxOpts: CallOptions, callback: EmptyCallback): void;
+    /**
+     * @typedef {array} TopicExistsResponse
+     * @property {boolean} 0 Whether the topic exists
+     */
+    /**
+     * @callback TopicExistsCallback
+     * @param {?Error} err Request error, if any.
+     * @param {boolean} exists Whether the topic exists.
+     */
+    /**
+     * Check if a topic exists.
+     *
+     * @param {TopicExistsCallback} [callback] Callback function.
+     * @returns {Promise<TopicExistsResponse>}
+     *
+     * @example
+     * ```
+     * const {PubSub} = require('@google-cloud/pubsub');
+     * const pubsub = new PubSub();
+     *
+     * const topic = pubsub.topic('my-topic');
+     *
+     * topic.exists((err, exists) => {});
+     *
+     * //-
+     * // If the callback is omitted, we'll return a Promise.
+     * //-
+     * topic.exists().then((data) => {
+     *   const exists = data[0];
+     * });
+     * ```
+     */
     exists(): Promise<ExistsResponse>;
     exists(callback: ExistsCallback): void;
+    /**
+     * @typedef {array} GetTopicResponse
+     * @property {Topic} 0 The {@link Topic}.
+     * @property {object} 1 The full API response.
+     */
+    /**
+     * @callback GetTopicCallback
+     * @param {?Error} err Request error, if any.
+     * @param {Topic} topic The {@link Topic}.
+     * @param {object} apiResponse The full API response.
+     */
+    /**
+     * Get a topic if it exists.
+     *
+     * @param {object} [gaxOpts] Request configuration options, outlined
+     *     here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
+     * @param {boolean} [gaxOpts.autoCreate=false] Automatically create the topic
+     *     does not already exist.
+     * @param {GetTopicCallback} [callback] Callback function.
+     * @returns {Promise<GetTopicResponse>}
+     *
+     * @example
+     * ```
+     * const {PubSub} = require('@google-cloud/pubsub');
+     * const pubsub = new PubSub();
+     *
+     * const topic = pubsub.topic('my-topic');
+     *
+     * topic.get((err, topic, apiResponse) => {
+     *   // The `topic` data has been populated.
+     * });
+     *
+     * //-
+     * // If the callback is omitted, we'll return a Promise.
+     * //-
+     * topic.get().then((data) => {
+     *   const topic = data[0];
+     *   const apiResponse = data[1];
+     * });
+     * ```
+     */
     get(callback: GetTopicCallback): void;
     get(gaxOpts?: GetTopicOptions): Promise<GetTopicResponse>;
     get(gaxOpts: GetTopicOptions, callback: GetTopicCallback): void;
+    /**
+     * @typedef {array} GetTopicMetadataResponse
+     * @property {object} 0 The full API response.
+     */
+    /**
+     * @callback GetTopicMetadataCallback
+     * @param {?Error} err Request error, if any.
+     * @param {object} apiResponse The full API response.
+     */
+    /**
+     * Get the official representation of this topic from the API.
+     *
+     * @see [Topics: get API Documentation]{@link https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics/get}
+     *
+     * @param {object} [gaxOpts] Request configuration options, outlined
+     *     here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
+     * @param {GetTopicMetadataCallback} [callback] Callback function.
+     * @returns {Promise<GetTopicMetadataResponse>}
+     *
+     * @example
+     * ```
+     * const {PubSub} = require('@google-cloud/pubsub');
+     * const pubsub = new PubSub();
+     *
+     * const topic = pubsub.topic('my-topic');
+     *
+     * topic.getMetadata((err, apiResponse) => {});
+     *
+     * //-
+     * // If the callback is omitted, we'll return a Promise.
+     * //-
+     * topic.getMetadata().then((data) => {
+     *   const apiResponse = data[0];
+     * });
+     * ```
+     */
     getMetadata(callback: GetTopicMetadataCallback): void;
     getMetadata(gaxOpts: CallOptions, callback: GetTopicMetadataCallback): void;
     getMetadata(gaxOpts?: CallOptions): Promise<GetTopicMetadataResponse>;
+    /**
+     * Get a list of the subscriptions registered to this topic. You may
+     * optionally provide a query object as the first argument to customize the
+     * response.
+     *
+     * Your provided callback will be invoked with an error object if an API error
+     * occurred or an array of {module:pubsub/subscription} objects.
+     *
+     * @see [Subscriptions: list API Documentation]{@link https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics.subscriptions/list}
+     *
+     * @param {GetSubscriptionsRequest} [query] Query object for listing subscriptions.
+     * @param {GetSubscriptionsCallback} [callback] Callback function.
+     * @returns {Promise<GetSubscriptionsResponse>}
+     *
+     * @example
+     * ```
+     * const {PubSub} = require('@google-cloud/pubsub');
+     * const pubsub = new PubSub();
+     *
+     * const topic = pubsub.topic('my-topic');
+     *
+     * topic.getSubscriptions((err, subscriptions) => {
+     *   // subscriptions is an array of `Subscription` objects.
+     * });
+     *
+     * // Customize the query.
+     * topic.getSubscriptions({
+     *   pageSize: 3
+     * }, callback);
+     *
+     * //-
+     * // If the callback is omitted, we'll return a Promise.
+     * //-
+     * topic.getSubscriptions().then((data) => {
+     *   const subscriptions = data[0];
+     * });
+     * ```
+     */
     getSubscriptions(callback: GetTopicSubscriptionsCallback): void;
     getSubscriptions(options: PageOptions, callback: GetTopicSubscriptionsCallback): void;
     getSubscriptions(options?: PageOptions): Promise<GetTopicSubscriptionsResponse>;
+    /**
+     * Publish the provided message.
+     *
+     * @deprecated Please use {@link Topic#publishMessage}.
+     *
+     * @throws {TypeError} If data is not a Buffer object.
+     * @throws {TypeError} If any value in `attributes` object is not a string.
+     *
+     * @param {buffer} data The message data. This must come in the form of a
+     *     Buffer object.
+     * @param {object.<string, string>} [attributes] Attributes for this message.
+     * @param {PublishCallback} [callback] Callback function.
+     * @returns {Promise<PublishResponse>}
+     *
+     * @example
+     * ```
+     * const {PubSub} = require('@google-cloud/pubsub');
+     * const pubsub = new PubSub();
+     *
+     * const topic = pubsub.topic('my-topic');
+     * const data = Buffer.from('Hello, world!');
+     *
+     * const callback = (err, messageId) => {
+     *   if (err) {
+     *     // Error handling omitted.
+     *   }
+     * };
+     *
+     * topic.publish(data, callback);
+     *
+     * ```
+     * @example Optionally you can provide an object containing attributes for the message. Note that all values in the object must be strings.
+     * ```
+     * const attributes = {
+     *   key: 'value'
+     * };
+     *
+     * topic.publish(data, attributes, callback);
+     *
+     * ```
+     * @example If the callback is omitted, we'll return a Promise.
+     * ```
+     * topic.publish(data).then((messageId) => {});
+     * ```
+     */
     publish(data: Buffer, attributes?: Attributes): Promise<string>;
     publish(data: Buffer, callback: PublishCallback): void;
     publish(data: Buffer, attributes: Attributes, callback: PublishCallback): void;
+    /**
+     * Publish the provided JSON. It should be noted that all messages published
+     * are done so in the form of a Buffer. This is simply a convenience method
+     * that will transform JSON into a Buffer before publishing.
+     * {@link Subscription} objects will always return message data in the form of
+     * a Buffer, so any JSON published will require manual deserialization.
+     *
+     * @deprecated Please use the `json` option via {@link Topic#publishMessage}.
+     *
+     * @throws {Error} If non-object data is provided.
+     *
+     * @param {object} json The JSON data to publish.
+     * @param {object} [attributes] Attributes for this message.
+     * @param {PublishCallback} [callback] Callback function.
+     * @returns {Promise<PublishResponse>}
+     *
+     * @example
+     * ```
+     * const {PubSub} = require('@google-cloud/pubsub');
+     * const pubsub = new PubSub();
+     * const topic = pubsub.topic('my-topic');
+     *
+     * const data = {
+     *   foo: 'bar'
+     * };
+     *
+     * const callback = (err, messageId) => {
+     *   if (err) {
+     *     // Error handling omitted.
+     *   }
+     * };
+     *
+     * topic.publishJSON(data, callback);
+     *
+     * ```
+     * @example Optionally you can provide an object containing attributes for the message. Note that all values in the object must be strings.
+     * ```
+     * const attributes = {
+     *   key: 'value'
+     * };
+     *
+     * topic.publishJSON(data, attributes, callback);
+     *
+     * ```
+     * @example If the callback is omitted, we'll return a Promise.
+     * ```
+     * topic.publishJSON(data).then((messageId) => {});
+     * ```
+     */
     publishJSON(json: object, attributes?: Attributes): Promise<string>;
     publishJSON(json: object, callback: PublishCallback): void;
     publishJSON(json: object, attributes: Attributes, callback: PublishCallback): void;
-    publishMessage(message: MessageOptions): Promise<[string]>;
+    /**
+     * @typedef {object} MessageOptions
+     * @property {buffer} [data] The message data.
+     * @property {object} [json] Convenience property to publish JSON data. This
+     *     will transform the provided JSON into a Buffer before publishing.
+     *     {@link Subscription} objects will always return message data in the
+     *     form of a Buffer, so any JSON published will require manual
+     *     deserialization.
+     * @property {object.<string, string>} [attributes] Attributes for this
+     *     message.
+     * @property {string} [orderingKey] A message ordering key.
+     */
+    /**
+     * Publish the provided message.
+     *
+     * @throws {TypeError} If data is not a Buffer object.
+     * @throws {TypeError} If any value in `attributes` object is not a string.
+     *
+     * @param {MessageOptions} message Message object.
+     * @param {PublishCallback} [callback] Callback function.
+     * @returns {Promise<PublishResponse>}
+     *
+     * @example
+     * ```
+     * const {PubSub} = require('@google-cloud/pubsub');
+     * const pubsub = new PubSub();
+     * const topic = pubsub.topic('my-topic');
+     *
+     * const data = Buffer.from('Hello, world!');
+     *
+     * const callback = (err, messageId) => {
+     *   if (err) {
+     *     // Error handling omitted.
+     *   }
+     * };
+     *
+     * topic.publishMessage({data}, callback);
+     *
+     * ```
+     * @example Publish JSON message data.
+     * ```
+     * const json = {foo: 'bar'};
+     *
+     * topic.publishMessage({json}, callback);
+     *
+     * ```
+     * @example To publish messages in order (this is still experimental), make sure message ordering is enabled and provide an ordering key
+     * ```
+     * const topic = pubsub.topic('ordered-topic', {messageOrdering: true});
+     * const orderingKey = 'my-key';
+     *
+     * topic.publishMessage({data, orderingKey}, callback);
+     *
+     * ```
+     * @example If the callback is omitted, we'll return a Promise.
+     * ```
+     * const [messageId] = await topic.publishMessage({data});
+     * ```
+     */
+    publishMessage(message: MessageOptions): Promise<string>;
     publishMessage(message: MessageOptions, callback: PublishCallback): void;
     /**
      * Creates a FlowControlledPublisher for this Topic.
@@ -122,6 +532,7 @@ export declare class Topic {
      * @param {string} orderingKey The ordering key in question.
      *
      * @example
+     * ```
      * const {PubSub} = require('@google-cloud/pubsub');
      * const pubsub = new PubSub();
      * const topic = pubsub.topic('my-topic', {messageOrdering: true});
@@ -134,8 +545,56 @@ export declare class Topic {
      *     topic.resumePublishing(orderingKey);
      *   }
      * });
+     * ```
      */
     resumePublishing(orderingKey: string): void;
+    /**
+     * @typedef {array} SetTopicMetadataResponse
+     * @property {object} 0 The full API response.
+     */
+    /**
+     * @callback SetTopicMetadataCallback
+     * @param {?Error} err Request error, if any.
+     * @param {object} apiResponse The full API response.
+     */
+    /**
+     * Updates the topic.
+     *
+     * @see [UpdateTopicRequest API Documentation]{@link https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#google.pubsub.v1.UpdateTopicRequest}
+     *
+     * @param {object} metadata The fields to update. This should be structured
+     *     like a {@link
+     * https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic|Topic
+     * object}.
+     * @param {object} [gaxOpts] Request configuration options, outlined
+     *     here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
+     * @param {SetTopicMetadataCallback} [callback] Callback function.
+     * @returns {Promise<SetTopicMetadataResponse>}
+     *
+     * @example
+     * ```
+     * const {PubSub} = require('@google-cloud/pubsub');
+     * const pubsub = new PubSub();
+     *
+     * const topic = pubsub.topic('my-topic');
+     * const metadata = {
+     *   labels: {foo: 'bar'}
+     * };
+     *
+     * topic.setMetadata(metadata, err => {
+     *   if (err) {
+     *     // Error handling omitted.
+     *   }
+     * });
+     *
+     * ```
+     * @example If the callback is omitted, we'll return a Promise.
+     * ```
+     * topic.setMetadata(metadata).then((data) => {
+     *   const apiResponse = data[0];
+     * });
+     * ```
+     */
     setMetadata(options: TopicMetadata, gaxOpts?: CallOptions): Promise<SetTopicMetadataResponse>;
     setMetadata(options: TopicMetadata, callback: SetTopicMetadataCallback): void;
     setMetadata(options: TopicMetadata, gaxOpts: CallOptions, callback: SetTopicMetadataCallback): void;
@@ -145,6 +604,7 @@ export declare class Topic {
      * @param {PublishOptions} options The publisher options.
      *
      * @example
+     * ```
      * const {PubSub} = require('@google-cloud/pubsub');
      * const pubsub = new PubSub();
      *
@@ -155,6 +615,7 @@ export declare class Topic {
      *     maxMilliseconds: 10
      *   }
      * });
+     * ```
      */
     setPublishOptions(options: PublishOptions): void;
     /**
@@ -162,6 +623,7 @@ export declare class Topic {
      * back into {@link Topic#setPublishOptions}.
      *
      * @example
+     * ```
      * const {PubSub} = require('@google-cloud/pubsub');
      * const pubsub = new PubSub();
      *
@@ -170,6 +632,7 @@ export declare class Topic {
      * const defaults = topic.getPublishOptionDefaults();
      * defaults.batching.maxMilliseconds = 10;
      * topic.setPublishOptions(defaults);
+     * ```
      */
     getPublishOptionDefaults(): PublishOptions;
     /**
@@ -184,6 +647,7 @@ export declare class Topic {
      * @return {Subscription}
      *
      * @example
+     * ```
      * const {PubSub} = require('@google-cloud/pubsub');
      * const pubsub = new PubSub();
      *
@@ -199,6 +663,7 @@ export declare class Topic {
      *   // message.attributes = Attributes of the message.
      *   // message.publishTime = Timestamp when Pub/Sub received the message.
      * });
+     * ```
      */
     subscription(name: string, options?: SubscriptionOptions): Subscription;
     /**