Global - Documentation

Type Definitions

BatchOptions :object

Properties:

Name	Type	Attributes	Default	Description
`callOptions`	object	<optional>		Request configuration option, outlined here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
`maxMessages`	number	<optional>	3000	Maximum number of messages allowed in each batch sent.
`maxMilliseconds`	number	<optional>	100	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.

Source:

message-queues.js, line 37

BatchPublishOptions

Properties:

Name	Type	Attributes	Default	Description
`maxBytes`	number	<optional>	1024^2 * 5	The maximum number of bytes to buffer before sending a payload.
`maxMessages`	number	<optional>	1000	The maximum number of messages to buffer before sending a payload.
`maxMilliseconds`	number	<optional>	100	The maximum duration to wait before sending a payload.

Source:

publisher.js, line 23

ClientConfig :object

Properties:

Name Type Attributes Default Description

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.

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

apiEndpoint

string

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.

email

string

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

credentials

object

Credentials object.

Properties

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

autoRetry

boolean

true

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

maxRetries

number

Maximum number of automatic retries attempted before returning the error.

promise

Constructor

Custom promise module to use instead of native Promises.

Source:

pubsub.js, line 37

CreateSnapshotCallback(errnullable, snapshot, apiResponse)

Parameters:

Name	Type	Attributes	Description
`err`	Error	<nullable>	Request error, if any.
`snapshot`	Snapshot		The new Snapshot.
`apiResponse`	object		The full API response.

Source:

subscription.js, line 292

CreateSnapshotResponse :array

Properties:

Name	Type	Description
`0`	Snapshot	The new Snapshot.
`1`	object	The full API response.

Source:

subscription.js, line 287

CreateSubscriptionCallback(errnullable, Subscription, apiResponse)

Parameters:

Name	Type	Attributes	Description
`err`	Error	<nullable>	Request error, if any.
`Subscription`	Subscription
`apiResponse`	object		The full API response.

Source:

pubsub.js, line 132

CreateSubscriptionRequest :object

Options for creating a subscription.

See a Subscription resource.

Properties:

Name Type Attributes Default Description

flowControl

object

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

Properties

Name	Type	Attributes	Default	Description
`maxBytes`	number	<optional>		The maximum number of bytes in un-acked messages to allow before the subscription pauses incoming messages. Defaults to 20% of free memory.
`maxMessages`	number	<optional>	Infinity	The maximum number of un-acked messages to allow before the subscription pauses incoming messages.

gaxOpts

object

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

messageRetentionDuration

number | google.protobuf.Duration

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.

pushEndpoint

string

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

retainAckedMessages

boolean

false

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

expirationPolicy

ExpirationPolicy

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

Source:

pubsub.js, line 138

CreateSubscriptionResponse :array

Properties:

Name	Type	Description
`0`	Subscription	The new Subscription.
`1`	object	The full API response.

Source:

pubsub.js, line 127

CreateTopicCallback(errnullable, topic, apiResponse)

Parameters:

Name	Type	Attributes	Description
`err`	Error	<nullable>	Request error, if any.
`topic`	Topic		The new Topic.
`apiResponse`	object		The full API response.

Source:

pubsub.js, line 249

CreateTopicResponse :array

Properties:

Name	Type	Description
`0`	Topic	The new Topic.
`1`	object	The full API response.

Source:

pubsub.js, line 244

ExpirationPolicy :object

A policy that specifies the conditions for this subscription's expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If expirationPolicy is not set, a default policy with ttl of 31 days will be used. The minimum allowed value for expirationPolicy.ttl is 1 day.

Properties:

Name	Type	Description
`ttl`	google.protobuf.Duration	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.

Source:

subscription.js, line 26

FlowControlOptions :object

Properties:

Name	Type	Attributes	Default	Description
`allowExcessMessages`	boolean	<optional>	true	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.
`maxBytes`	number	<optional>		The desired amount of memory to allow message data to consume, defaults to 20% of available memory. Its possible that this value will be exceeded since messages are received in batches.
`maxExtension`	number	<optional>	Infinity	The maximum duration (in seconds) to extend the message deadline before redelivering.
`maxMessages`	number	<optional>	100	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.

Source:

lease-manager.js, line 20

GetPolicyCallback(errnullable, acl)

Parameters:

Name	Type	Attributes	Description
`err`	Error	<nullable>	Request error, if any.
`acl`	object		The policy.

Source:

iam.js, line 74

GetPolicyResponse :array

Properties:

Name	Type	Description
`0`	object	The policy.

Source:

iam.js, line 70

GetSnapshotsCallback(errnullable, snapshots, apiResponse)

Parameters:

Name	Type	Attributes	Description
`err`	Error	<nullable>	Request error, if any.
`snapshots`	Array.<Snapshot>		Array of Snapshot instances.
`apiResponse`	object		The full API response.

Source:

pubsub.js, line 350

GetSnapshotsRequest :object

Query object for listing snapshots.

Properties:

Name	Type	Attributes	Default	Description
`autoPaginate`	boolean	<optional>	true	Have pagination handled automatically.
`options.gaxOpts`	object	<optional>		Request configuration options, outlined here: https://googleapis.github.io/gax-nodejs/CallSettings.html.
`options.pageSize`	number	<optional>		Maximum number of results to return.
`options.pageToken`	string	<optional>		Page token.

Source:

pubsub.js, line 334

GetSnapshotsResponse :array

Properties:

Name	Type	Description
`0`	Array.<Snapshot>	Array of Snapshot instances.
`1`	object	The full API response.

Source:

pubsub.js, line 345

GetSubscriptionCallback(errnullable, subscription, apiResponse)

Parameters:

Name	Type	Attributes	Description
`err`	Error	<nullable>	Request error, if any.
`subscription`	Subscription		The Subscription.
`apiResponse`	object		The full API response.

Source:

subscription.js, line 449

GetSubscriptionMetadataCallback(errnullable, apiResponse)

Parameters:

Name	Type	Attributes	Description
`err`	Error	<nullable>	Request error, if any.
`apiResponse`	object		The full API response.

Source:

subscription.js, line 505

GetSubscriptionMetadataResponse :array

Properties:

Name	Type	Description
`0`	object	The full API response.

Source:

subscription.js, line 501

GetSubscriptionResponse :array

Properties:

Name	Type	Description
`0`	Subscription	The Subscription.
`1`	object	The full API response.

Source:

subscription.js, line 444

GetSubscriptionsCallback(errnullable, subscriptions, apiResponse)

Parameters:

Name	Type	Attributes	Description
`err`	Error	<nullable>	Request error, if any.
`subscriptions`	Array.<Subscription>		Array of Subscription instances.
`apiResponse`	object		The full API response.

Source:

pubsub.js, line 426

GetSubscriptionsRequest :object

Query object for listing subscriptions.

Parameters:

Name	Type	Description
`options.topic`	string \| Topic	The name of the topic to list subscriptions from.

Properties:

Name	Type	Attributes	Default	Description
`autoPaginate`	boolean	<optional>	true	Have pagination handled automatically.
`options.gaxOpts`	object	<optional>		Request configuration options, outlined here: https://googleapis.github.io/gax-nodejs/CallSettings.html.
`options.pageSize`	number	<optional>		Maximum number of results to return.
`options.pageToken`	string	<optional>		Page token.

Source:

pubsub.js, line 408

GetSubscriptionsResponse :array

Properties:

Name	Type	Description
`0`	Array.<Subscription>	Array of Subscription instances.
`1`	object	The full API response.

Source:

pubsub.js, line 421

GetTopicCallback(errnullable, topic, apiResponse)

Parameters:

Name	Type	Attributes	Description
`err`	Error	<nullable>	Request error, if any.
`topic`	Topic		The Topic.
`apiResponse`	object		The full API response.

Source:

topic.js, line 267

GetTopicMetadataCallback(errnullable, apiResponse)

Parameters:

Name	Type	Attributes	Description
`err`	Error	<nullable>	Request error, if any.
`apiResponse`	object		The full API response.

Source:

topic.js, line 322

GetTopicMetadataResponse :array

Properties:

Name	Type	Description
`0`	object	The full API response.

Source:

topic.js, line 318

GetTopicResponse :array

Properties:

Name	Type	Description
`0`	Topic	The Topic.
`1`	object	The full API response.

Source:

topic.js, line 262

GetTopicsCallback(errnullable, topics, apiResponse)

Parameters:

Name	Type	Attributes	Description
`err`	Error	<nullable>	Request error, if any.
`topics`	Array.<Topic>		Array of Topic instances.
`apiResponse`	object		The full API response.

Source:

pubsub.js, line 515

GetTopicsRequest :object

Query object for listing topics.

Properties:

Name	Type	Attributes	Default	Description
`autoPaginate`	boolean	<optional>	true	Have pagination handled automatically.
`options.gaxOpts`	object	<optional>		Request configuration options, outlined here: https://googleapis.github.io/gax-nodejs/CallSettings.html.
`options.pageSize`	number	<optional>		Maximum number of results to return.
`options.pageToken`	string	<optional>		Page token.

Source:

pubsub.js, line 499

GetTopicsResponse :array

Properties:

Name	Type	Description
`0`	Array.<Topic>	Array of Topic instances.
`1`	object	The full API response.

Source:

pubsub.js, line 510

MessageStreamOptions :object

Properties:

Name	Type	Attributes	Default	Description
`highWaterMark`	number	<optional>	0	Configures the Buffer level for all underlying streams. See https://nodejs.org/en/docs/guides/backpressuring-in-streams/ for more details.
`maxStreams`	number	<optional>	5	Number of streaming connections to make.
`timeout`	number	<optional>	300000	Timeout for establishing a connection.

Source:

message-stream.js, line 73

ModifyPushConfigCallback(errnullable, apiResponse)

Parameters:

Name	Type	Attributes	Description
`err`	Error	<nullable>	Request error, if any.
`apiResponse`	object		The full API response.

Source:

subscription.js, line 560

ModifyPushConfigResponse :array

Properties:

Name	Type	Description
`0`	object	The full API response.

Source:

subscription.js, line 556

PermissionsResponse :Array.<string>

A subset of TestPermissionsRequest.permissions that the caller is allowed.

Source:

iam.js, line 207

See:

https://cloud.google.com/pubsub/docs/reference/rpc/google.iam.v1#google.iam.v1.TestIamPermissionsRequest

PublishOptions

Properties:

Name	Type	Attributes	Description
`batching`	BatchPublishOptions	<optional>	Batching settings.
`gaxOpts`	object	<optional>	Request configuration options, outlined here: https://googleapis.github.io/gax-nodejs/CallSettings.html.

Source:

publisher.js, line 32

SeekCallback(errnullable, apiResponse)

Parameters:

Name	Type	Attributes	Description
`err`	Error	<nullable>	Request error, if any.
`apiResponse`	object		The full API response.

Source:

subscription.js, line 648

SeekResponse :array

Properties:

Name	Type	Description
`0`	object	The full API response.

Source:

subscription.js, line 644

SetPolicyCallback(errnullable, acl)

Parameters:

Name	Type	Attributes	Description
`err`	Error	<nullable>	Request error, if any.
`acl`	object		The policy.

Source:

iam.js, line 126

SetPolicyResponse :array

Properties:

Name	Type	Description
`0`	object	The policy.

Source:

iam.js, line 122

SetSubscriptionMetadataCallback(errnullable, apiResponse)

Parameters:

Name	Type	Attributes	Description
`err`	Error	<nullable>	Request error, if any.
`apiResponse`	object		The full API response.

Source:

subscription.js, line 707

SetSubscriptionMetadataResponse :array

Properties:

Name	Type	Description
`0`	object	The full API response.

Source:

subscription.js, line 703

SetTopicMetadataCallback(errnullable, apiResponse)

Parameters:

Name	Type	Attributes	Description
`err`	Error	<nullable>	Request error, if any.
`apiResponse`	object		The full API response.

Source:

topic.js, line 538

SetTopicMetadataResponse :array

Properties:

Name	Type	Description
`0`	object	The full API response.

Source:

topic.js, line 534

SubscriberOptions :object

Properties:

Name	Type	Attributes	Default	Description
`ackDeadline`	number	<optional>	10	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.
`batching`	BatchOptions	<optional>		Request batching options.
`flowControl`	FlowControlOptions	<optional>		Flow control options.
`streamingOptions`	MessageStreamOptions	<optional>		Streaming options.

Source:

subscriber.js, line 170

SubscriptionExistsCallback(errnullable, exists)

Parameters:

Name	Type	Attributes	Description
`err`	Error	<nullable>	Request error, if any.
`exists`	boolean		Whether the subscription exists.

Source:

subscription.js, line 404

SubscriptionExistsResponse :array

Properties:

Name	Type	Description
`0`	boolean	Whether the subscription exists

Source:

subscription.js, line 400

TestIamPermissionsCallback(errnullable, permissions, apiResponse)

Parameters:

Name	Type	Attributes	Description
`err`	Error	<nullable>	Request error, if any.
`permissions`	TestIamPermissionsAPIResponse		A subset of permissions that the caller is allowed.
`apiResponse`	PermissionsResponse		The full API response.

Source:

iam.js, line 196

TestIamPermissionsResponse :array

Properties:

Name	Type	Description
`0`	Array.<object>	A subset of permissions that the caller is allowed.
`1`	PermissionsResponse	The full API response.

Source:

iam.js, line 202

TopicExistsCallback(errnullable, exists)

Parameters:

Name	Type	Attributes	Description
`err`	Error	<nullable>	Request error, if any.
`exists`	boolean		Whether the topic exists.

Source:

topic.js, line 223

TopicExistsResponse :array

Properties:

Name	Type	Description
`0`	boolean	Whether the topic exists

Source:

topic.js, line 219