This repository was archived by the owner on Mar 17, 2026. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 235
Expand file tree
/
Copy pathcloseSubscriptionWithTimeout.js
More file actions
97 lines (85 loc) · 3.28 KB
/
closeSubscriptionWithTimeout.js
File metadata and controls
97 lines (85 loc) · 3.28 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// This is a generated sample, using the typeless sample bot. Please
// look for the source TypeScript sample (.ts) for modifications.
'use strict';
/**
* This sample demonstrates how to use the `timeout` option when closing a Pub/Sub
* subscription using the Node.js client library. The timeout allows for graceful
* shutdown, attempting to nack any buffered messages before closing.
*
* For more information, see the README.md under /pubsub and the documentation
* at https://cloud.google.com/pubsub/docs.
*/
// sample-metadata:
// title: Close Subscription with Timeout
// description: Demonstrates closing a subscription with a specified timeout for graceful shutdown.
// usage: node closeSubscriptionWithTimeout.js <topic-name> <subscription-name>
// This sample is currently speculative.
// -START pubsub_close_subscription_with_timeout]
// Imports the Google Cloud client library
const {
PubSub,
Duration,
SubscriptionCloseBehaviors,
} = require('@google-cloud/pubsub');
// Creates a client; cache this for further use
const pubsub = new PubSub();
async function closeSubscriptionWithTimeout(
topicNameOrId,
subscriptionNameOrId,
) {
const topic = pubsub.topic(topicNameOrId);
// Closes the subscription immediately, not waiting for anything.
let subscription = topic.subscription(subscriptionNameOrId, {
closeOptions: {
timeout: Duration.from({seconds: 0}),
},
});
await subscription.close();
// Shuts down the gRPC connection, and waits for just before the timeout
// to send nacks for buffered messages. If `timeout` were missing, this
// would wait for the maximum leasing timeout.
subscription = topic.subscription(subscriptionNameOrId, {
closeOptions: {
behavior: SubscriptionCloseBehaviors.WaitForProcessing,
timeout: Duration.from({seconds: 10}),
},
});
await subscription.close();
// Shuts down the gRPC connection, sends nacks for buffered messages, and waits
// through the timeout for nacks to send.
subscription = topic.subscription(subscriptionNameOrId, {
closeOptions: {
behavior: SubscriptionCloseBehaviors.NackImmediately,
timeout: Duration.from({seconds: 10}),
},
});
await subscription.close();
}
// -END pubsub_close_subscription_with_timeout]
// Presumes topic and subscription have been created prior to running the sample.
// If you uncomment the cleanup code above, the sample will delete them afterwards.
function main(
topicNameOrId = 'YOUR_TOPIC_NAME_OR_ID',
subscriptionNameOrId = 'YOUR_SUBSCRIPTION_NAME_OR_ID',
) {
closeSubscriptionWithTimeout(topicNameOrId, subscriptionNameOrId).catch(
err => {
console.error(err.message);
process.exitCode = 1;
},
);
}
main(...process.argv.slice(2));