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
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#
| Name | Type |
|---|---|
createDefaultSubscription? | boolean |
deadLetterTopic | string |
maxDeliveryAttempts | number |
Defined in#
src/subscriber/subscriberV2.ts:75
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:106
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:98
flowControl#
• Optional flowControl: FlowControlOptions
Inherited from#
GoogleCloudSubscriberOptions.flowControl
Defined in#
node_modules/@google-cloud/pubsub/build/src/subscriber.d.ts:107
labels#
• Optional labels: null | { [k: string]: string; }
Defined in#
src/subscriber/subscriberV2.ts:74
project#
• Optional project: GooglePubSubProject
Defined in#
src/subscriber/subscriberV2.ts:73
retryPolicy#
• Optional retryPolicy: Object
Type declaration#
| Name | Type |
|---|---|
maximumBackoff | Object |
maximumBackoff.nanos? | number |
maximumBackoff.seconds | number |
minimumBackoff | Object |
minimumBackoff.nanos? | number |
minimumBackoff.seconds | number |
Defined in#
src/subscriber/subscriberV2.ts:80
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