PublisherClient - Documentation

Constructor

new PublisherClient(optionsopt)

Construct an instance of PublisherClient.

Parameters:

Name Type Attributes Description

options

object

The configuration object. See the subsequent parameters for more details.

Properties

Name Type Attributes Description

credentials

object

Credentials object.

Properties

Name	Type	Attributes	Description
`client_email`	string	<optional>
`private_key`	string	<optional>

email

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

string

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port

number

The port on which to connect to the remote host.

projectId

string

The project ID from the Google 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 Application Default Credentials, your project ID will be detected automatically.

apiEndpoint

string

The domain name of the API remote host.

Members

(static) apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

(static) port

The port for this API service.

(static) scopes

The scopes needed to make gRPC calls for every method defined in this service.

(static) servicePath

The DNS address for this API service.

Methods

close()

Terminate the GRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

createTopic(request, optionsopt) → {Promise}

Creates the given topic with the given name. See the resource name rules.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	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"`.
`labels`	Array.<number>	See Creating and managing labels.
`messageStoragePolicy`	google.pubsub.v1.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.
`kmsKeyName`	string	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/*`.

options

object

Call options. See CallOptions for more details.

deleteTopic(request, optionsopt) → {Promise}

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_.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`topic`	string	Required. Name of the topic to delete. Format is `projects/{project}/topics/{topic}`.

options

object

Call options. See CallOptions for more details.

detachSubscription(request, optionsopt) → {Promise}

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.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`subscription`	string	Required. The subscription to detach. Format is `projects/{project}/subscriptions/{subscription}`.

options

object

Call options. See CallOptions for more details.

getIamPolicy(request, optionsopt, callbackopt) → {Promise}

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Attributes Description

resource

string

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

options

Object

OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy. This field is only used by Cloud IAM.

This object should have the same structure as GetPolicyOptions

options

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Policy.

getProjectId(callback)

Return the project ID used by this class.

Parameters:

Name	Type	Description
`callback`	function	the callback to be called with the current project Id.

getTopic(request, optionsopt) → {Promise}

Gets the configuration of a topic.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`topic`	string	Required. The name of the topic to get. Format is `projects/{project}/topics/{topic}`.

options

object

Call options. See CallOptions for more details.

initialize() → {Promise}

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

listTopics(request, optionsopt) → {Promise}

Lists matching topics.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`project`	string	Required. The name of the project in which to list topics. Format is `projects/{project-id}`.
`pageSize`	number	Maximum number of topics to return.
`pageToken`	string	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.

options

object

Call options. See CallOptions for more details.

listTopicsAsync(request, optionsopt) → {Object}

Equivalent to listTopics, but returns an iterable object.

for-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`project`	string	Required. The name of the project in which to list topics. Format is `projects/{project-id}`.
`pageSize`	number	Maximum number of topics to return.
`pageToken`	string	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.

options

object

Call options. See CallOptions for more details.

listTopicSnapshots(request, optionsopt) → {Promise}

Lists the names of the snapshots on this topic. Snapshots are used in Seek 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.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`topic`	string	Required. The name of the topic that snapshots are attached to. Format is `projects/{project}/topics/{topic}`.
`pageSize`	number	Maximum number of snapshot names to return.
`pageToken`	string	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.

options

object

Call options. See CallOptions for more details.

listTopicSnapshotsAsync(request, optionsopt) → {Object}

Equivalent to listTopicSnapshots, but returns an iterable object.

for-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`topic`	string	Required. The name of the topic that snapshots are attached to. Format is `projects/{project}/topics/{topic}`.
`pageSize`	number	Maximum number of snapshot names to return.
`pageToken`	string	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.

options

object

Call options. See CallOptions for more details.

listTopicSnapshotsStream(request, optionsopt) → {Stream}

Equivalent to listTopicSnapshots, but returns a NodeJS Stream object.

This fetches the paged responses for listTopicSnapshots continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`topic`	string	Required. The name of the topic that snapshots are attached to. Format is `projects/{project}/topics/{topic}`.
`pageSize`	number	Maximum number of snapshot names to return.
`pageToken`	string	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.

options

object

Call options. See CallOptions for more details.

See:

https://nodejs.org/api/stream.html

listTopicsStream(request, optionsopt) → {Stream}

Equivalent to listTopics, but returns a NodeJS Stream object.

This fetches the paged responses for listTopics continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`project`	string	Required. The name of the project in which to list topics. Format is `projects/{project-id}`.
`pageSize`	number	Maximum number of topics to return.
`pageToken`	string	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.

options

object

Call options. See CallOptions for more details.

See:

https://nodejs.org/api/stream.html

listTopicSubscriptions(request, optionsopt) → {Promise}

Lists the names of the attached subscriptions on this topic.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`topic`	string	Required. The name of the topic that subscriptions are attached to. Format is `projects/{project}/topics/{topic}`.
`pageSize`	number	Maximum number of subscription names to return.
`pageToken`	string	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.

options

object

Call options. See CallOptions for more details.

listTopicSubscriptionsAsync(request, optionsopt) → {Object}

Equivalent to listTopicSubscriptions, but returns an iterable object.

for-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`topic`	string	Required. The name of the topic that subscriptions are attached to. Format is `projects/{project}/topics/{topic}`.
`pageSize`	number	Maximum number of subscription names to return.
`pageToken`	string	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.

options

object

Call options. See CallOptions for more details.

listTopicSubscriptionsStream(request, optionsopt) → {Stream}

Equivalent to listTopicSubscriptions, but returns a NodeJS Stream object.

This fetches the paged responses for listTopicSubscriptions continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`topic`	string	Required. The name of the topic that subscriptions are attached to. Format is `projects/{project}/topics/{topic}`.
`pageSize`	number	Maximum number of subscription names to return.
`pageToken`	string	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.

options

object

Call options. See CallOptions for more details.

See:

https://nodejs.org/api/stream.html

matchProjectFromProjectName(projectName) → {string}

Parse the project from Project resource.

Parameters:

Name	Type	Description
`projectName`	string	A fully-qualified path representing Project resource.

matchProjectFromProjectTopicName(projectTopicName) → {string}

Parse the project from ProjectTopic resource.

Parameters:

Name	Type	Description
`projectTopicName`	string	A fully-qualified path representing project_topic resource.

matchProjectFromSnapshotName(snapshotName) → {string}

Parse the project from Snapshot resource.

Parameters:

Name	Type	Description
`snapshotName`	string	A fully-qualified path representing Snapshot resource.

matchProjectFromSubscriptionName(subscriptionName) → {string}

Parse the project from Subscription resource.

Parameters:

Name	Type	Description
`subscriptionName`	string	A fully-qualified path representing Subscription resource.

matchSnapshotFromSnapshotName(snapshotName) → {string}

Parse the snapshot from Snapshot resource.

Parameters:

Name	Type	Description
`snapshotName`	string	A fully-qualified path representing Snapshot resource.

matchSubscriptionFromSubscriptionName(subscriptionName) → {string}

Parse the subscription from Subscription resource.

Parameters:

Name	Type	Description
`subscriptionName`	string	A fully-qualified path representing Subscription resource.

matchTopicFromProjectTopicName(projectTopicName) → {string}

Parse the topic from ProjectTopic resource.

Parameters:

Name	Type	Description
`projectTopicName`	string	A fully-qualified path representing project_topic resource.

projectPath(project) → {string}

Return a fully-qualified project resource name string.

Parameters:

Name	Type	Description
`project`	string

projectTopicPath(project, topic) → {string}

Return a fully-qualified projectTopic resource name string.

Parameters:

Name	Type	Description
`project`	string
`topic`	string

publish(request, optionsopt) → {Promise}

Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`topic`	string	Required. The messages in the request will be published on this topic. Format is `projects/{project}/topics/{topic}`.
`messages`	Array.<number>	Required. The messages to publish.

options

object

Call options. See CallOptions for more details.

setIamPolicy(request, optionsopt, callbackopt) → {Promise}

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`resource`	string	REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
`permissions`	Array.<string>	The set of permissions to check for the `resource`. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

options

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing TestIamPermissionsResponse.

snapshotPath(project, snapshot) → {string}

Return a fully-qualified snapshot resource name string.

Parameters:

Name	Type	Description
`project`	string
`snapshot`	string

subscriptionPath(project, subscription) → {string}

Return a fully-qualified subscription resource name string.

Parameters:

Name	Type	Description
`project`	string
`subscription`	string

testIamPermissions(request, optionsopt, callbackopt) → {Promise}

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`resource`	string	REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
`permissions`	Array.<string>	The set of permissions to check for the `resource`. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

options

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing TestIamPermissionsResponse.

updateTopic(request, optionsopt) → {Promise}

Updates an existing topic. Note that certain properties of a topic are not modifiable.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`topic`	google.pubsub.v1.Topic	Required. The updated topic object.
`updateMask`	google.protobuf.FieldMask	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.

options

object

Call options. See CallOptions for more details.