Skip to main content
Version: v1

Interface: SubscriberOptions

Hierarchy#

  • GoogleCloudSubscriberOptions

    ↳ SubscriberOptions

Properties#

ackDeadline#

• Optional ackDeadline: number

Inherited from#

GoogleCloudSubscriberOptions.ackDeadline

Defined in#

node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:105


ackDeadlineSeconds#

• Optional ackDeadlineSeconds: number

Defined in#

src/subscriber/subscriberV2.ts:182


batching#

• Optional batching: BatchOptions

Inherited from#

GoogleCloudSubscriberOptions.batching

Defined in#

node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:106


deadLetterPolicy#

• Optional deadLetterPolicy: Object

Type declaration#

NameType
createDefaultSubscription?boolean
deadLetterTopicstring
maxDeliveryAttemptsnumber

Defined in#

src/subscriber/subscriberV2.ts:184


enableMessageOrdering#

• Optional enableMessageOrdering: boolean

If true, messages published with the same ordering_key in PubsubMessage will be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order.

Defined in#

src/subscriber/subscriberV2.ts:215


enableOpenTelemetryTracing#

• Optional enableOpenTelemetryTracing: boolean

Inherited from#

GoogleCloudSubscriberOptions.enableOpenTelemetryTracing

Defined in#

node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:110


filter#

• Optional filter: string

An expression written in the Pub/Sub filter language. If non-empty, then only PubsubMessages whose attributes field matches the filter are delivered on this subscription. If empty, then no messages are filtered out.

Defined in#

src/subscriber/subscriberV2.ts:207


flowControl#

• Optional flowControl: FlowControlOptions

Inherited from#

GoogleCloudSubscriberOptions.flowControl

Defined in#

node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:107


project#

• Optional project: GooglePubSubProject

Defined in#

src/subscriber/subscriberV2.ts:183


retryPolicy#

• Optional retryPolicy: Object

Type declaration#

NameType
maximumBackoffObject
maximumBackoff.nanos?number
maximumBackoff.secondsnumber
minimumBackoffObject
minimumBackoff.nanos?number
minimumBackoff.secondsnumber

Defined in#

src/subscriber/subscriberV2.ts:189


streamingOptions#

• Optional streamingOptions: MessageStreamOptions

Inherited from#

GoogleCloudSubscriberOptions.streamingOptions

Defined in#

node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:109


useLegacyFlowControl#

• Optional useLegacyFlowControl: boolean

Inherited from#

GoogleCloudSubscriberOptions.useLegacyFlowControl

Defined in#

node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:108