Global

Request configuration option, outlined here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.

Maximum number of messages allowed in each batch sent.

Maximum duration to wait before sending a batch. Batches can be sent earlier if the maxMessages option is met before the configured duration has passed.

The maximum number of bytes to buffer before sending a payload.

The maximum number of messages to buffer before sending a payload.

The maximum duration to wait before sending a payload.

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.

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 above is not necessary. NOTE: .pem and .p12 require you to specify the email option as well.

The apiEndpoint from options will set the host. If not set, the PUBSUB_EMULATOR_HOST environment variable from the gcloud SDK is honored, otherwise the actual API endpoint will be used.

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

Credentials object.

Properties

Automatically retry requests if the response is related to rate limits or certain intermittent server errors. We will exponentially backoff subsequent requests by default.

Maximum number of automatic retries attempted before returning the error.

Custom promise module to use instead of native Promises.

The new Snapshot.

The full API response.

A policy that specifies the conditions for dead lettering messages in this subscription.

Flow control configurations for receiving messages. Note that these options do not persist across subscription instances.

Properties

Request configuration options, outlined here: https://googleapis.github.io/gax-nodejs/CallSettings.html.

Set this to override the default duration of 7 days. This value is expected in seconds. Acceptable values are in the range of 10 minutes and 7 days.

A URL to a custom endpoint that messages should be pushed to.

If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message. This object should have the same structure as OidcToken

If set, acked messages are retained in the subscription's backlog for the length of time specified by options.messageRetentionDuration.

A policy that specifies the conditions for this subscription's expiration.

The new Subscription.

The full API response.

The new Topic.

The full API response.

Specifies the "time-to-live" duration for an associated resource. The resource expires if it is not active for a period of ttl. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values for ttl depend on the type of the associated resource, as well. If ttl is not set, the associated resource never expires.

PubSub delivers messages in batches with no way to configure the batch size. Sometimes this can be overwhelming if you only want to process a few messages at a time. Setting this option to false will make the client manage any excess messages until you're ready for them. This will prevent them from being redelivered and make the maxMessages option behave more predictably.

The desired amount of memory to allow message data to consume. (Default: 100MB) It's possible that this value will be exceeded, since messages are received in batches.

The maximum duration (in seconds) to extend the message deadline before redelivering.

The desired number of messages to allow in memory before pausing the message stream. Unless allowExcessMessages is set to false, it is very likely that this value will be exceeded since any given message batch could contain a greater number of messages than the desired amount of messages.

The policy.

Have pagination handled automatically.

Request configuration options, outlined here: https://googleapis.github.io/gax-nodejs/CallSettings.html.

Maximum number of results to return.

Page token.

Array of Snapshot instances.

The full API response.

The full API response.

The Subscription.

The full API response.

Have pagination handled automatically.

Request configuration options, outlined here: https://googleapis.github.io/gax-nodejs/CallSettings.html.

Maximum number of results to return.

Page token.

Array of Subscription instances.

The full API response.

The full API response.

The Topic.

The full API response.

Have pagination handled automatically.

Request configuration options, outlined here: https://googleapis.github.io/gax-nodejs/CallSettings.html.

Maximum number of results to return.

Page token.

Array of Topic instances.

The full API response.

The message data.

Convenience property to publish JSON data. This will transform the provided JSON into a Buffer before publishing. Subscription objects will always return message data in the form of a Buffer, so any JSON published will require manual deserialization.

Attributes for this message.

A message ordering key.

Configures the Buffer level for all underlying streams. See https://nodejs.org/en/docs/guides/backpressuring-in-streams/ for more details.

Number of streaming connections to make.

Timeout for establishing a connection.

The full API response.

The full API response.

The policy.

The full API response.

The full API response.

Acknowledge deadline in seconds. If left unset the initial value will be 10 seconds, but it will evolve into the 99th percentile time it takes to acknowledge a message.

Request batching options.

Flow control options.

Streaming options.

Whether the subscription exists

A subset of permissions that the caller is allowed.

The full API response.

Whether the topic exists