-
Notifications
You must be signed in to change notification settings - Fork 227
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Add and improve ordering keys examples (#1071)
* chore: Remove notes about ordering keys being experimental. * feat: Add support for server-side flow control * Revert "chore: Remove notes about ordering keys being experimental." This reverts commit d02f328. * docs: Add and improve ordering keys samples * Fix test format and documentation * Lint fixes Co-authored-by: Megan Potter <57276408+feywind@users.noreply.github.com>
- Loading branch information
1 parent
78a45ff
commit c693830
Showing
7 changed files
with
270 additions
and
136 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
// Copyright 2020 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 application demonstrates how to perform basic operations on | ||
* subscriptions with the Google Cloud Pub/Sub API. | ||
* | ||
* For more information, see the README.md under /pubsub and the documentation | ||
* at https://cloud.google.com/pubsub/docs. | ||
*/ | ||
|
||
'use strict'; | ||
|
||
// sample-metadata: | ||
// title: Create Subscription with ordering enabled | ||
// description: Creates a new subscription with ordering enabled. | ||
// usage: node createSubscriptionWithOrdering.js <topic-name> <subscription-name> | ||
|
||
function main( | ||
topicName = 'YOUR_TOPIC_NAME', | ||
subscriptionName = 'YOUR_SUBSCRIPTION_NAME' | ||
) { | ||
// [START pubsub_ordering_keys_create_subscription] | ||
/** | ||
* TODO(developer): Uncomment these variables before running the sample. | ||
*/ | ||
// const topicName = 'YOUR_TOPIC_NAME'; | ||
// const subscriptionName = 'YOUR_SUBSCRIPTION_NAME'; | ||
|
||
// Imports the Google Cloud client library | ||
const {PubSub} = require('@google-cloud/pubsub'); | ||
|
||
// Creates a client; cache this for further use | ||
const pubSubClient = new PubSub(); | ||
|
||
async function createSubscriptionWithOrdering() { | ||
// Creates a new subscription | ||
await pubSubClient.topic(topicName).createSubscription(subscriptionName, { | ||
enableMessageOrdering: true, | ||
}); | ||
console.log( | ||
`Created subscription ${subscriptionName} with ordering enabled.` | ||
); | ||
console.log( | ||
'To process messages in order, remember to add an ordering key to your messages.' | ||
); | ||
} | ||
|
||
createSubscriptionWithOrdering().catch(console.error); | ||
// [END pubsub_ordering_keys_create_subscription] | ||
} | ||
|
||
main(...process.argv.slice(2)); |
Oops, something went wrong.