-
Notifications
You must be signed in to change notification settings - Fork 230
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
samples: add sample for unwrapped push subscriptions (#1865)
* samples: add sample for push subscription with no wrapper * samples: update samples/createPushSubscriptionNoWrapper.js Co-authored-by: Alex Hong <[email protected]> * samples: update samples/createPushSubscriptionNoWrapper.js Co-authored-by: Alex Hong <[email protected]> * samples: update copyright createPushSubscriptionNoWrapper.js * samples: update copyright createPushSubscriptionNoWrapper.ts * samples: update region tag in ts as well * chore: remove commented code in subscriptions.test.ts * docs: update comments to be clearer * samples: update push subscription samples to take a URL parameter for extra clarity * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * tests: use a real URL for the actual testing --------- Co-authored-by: Alex Hong <[email protected]> Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
- Loading branch information
3 people
authored
Jan 17, 2024
1 parent
f953b64
commit 5bb3c50
Showing
7 changed files
with
233 additions
and
6 deletions.
There are no files selected for viewing
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
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,87 @@ | ||
| // Copyright 2024 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 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. | ||
| */ | ||
|
|
||
| // sample-metadata: | ||
| // title: Create Push Subscription With No Wrapper | ||
| // description: Creates a new push subscription, but disables wrapping for payloads. | ||
| // usage: node createPushSubscriptionNoWrapper.js <topic-name-or-id> <subscription-name-or-id> | ||
|
|
||
| // [START pubsub_create_unwrapped_push_subscription] | ||
| /** | ||
| * TODO(developer): Uncomment these variables before running the sample. | ||
| */ | ||
| // const pushEndpoint = 'YOUR_ENDPOINT_URL'; | ||
| // const topicNameOrId = 'YOUR_TOPIC_NAME_OR_ID'; | ||
| // const subscriptionNameOrId = 'YOUR_SUBSCRIPTION_NAME_OR_ID'; | ||
|
|
||
| // 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 createPushSubscriptionNoWrapper( | ||
| pushEndpoint, | ||
| topicNameOrId, | ||
| subscriptionNameOrId | ||
| ) { | ||
| const options = { | ||
| pushConfig: { | ||
| // Set to an HTTPS endpoint of your choice. If necessary, register | ||
| // (authorize) the domain on which the server is hosted. | ||
| pushEndpoint, | ||
| // When true, writes the Pub/Sub message metadata to | ||
| // `x-goog-pubsub-<KEY>:<VAL>` headers of the HTTP request. Writes the | ||
| // Pub/Sub message attributes to `<KEY>:<VAL>` headers of the HTTP request. | ||
| noWrapper: { | ||
| writeMetadata: true, | ||
| }, | ||
| }, | ||
| }; | ||
|
|
||
| await pubSubClient | ||
| .topic(topicNameOrId) | ||
| .createSubscription(subscriptionNameOrId, options); | ||
| console.log(`Subscription ${subscriptionNameOrId} created.`); | ||
| } | ||
| // [END pubsub_create_unwrapped_push_subscription] | ||
|
|
||
| function main( | ||
| pushEndpoint = 'YOUR_ENDPOINT_URL', | ||
| topicNameOrId = 'YOUR_TOPIC_NAME_OR_ID', | ||
| subscriptionNameOrId = 'YOUR_SUBSCRIPTION_NAME_OR_ID' | ||
| ) { | ||
| createPushSubscriptionNoWrapper( | ||
| pushEndpoint, | ||
| topicNameOrId, | ||
| subscriptionNameOrId | ||
| ).catch(err => { | ||
| console.error(err.message); | ||
| process.exitCode = 1; | ||
| }); | ||
| } | ||
|
|
||
| main(...process.argv.slice(2)); |
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
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,83 @@ | ||
| // Copyright 2024 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. | ||
| */ | ||
|
|
||
| // sample-metadata: | ||
| // title: Create Push Subscription With No Wrapper | ||
| // description: Creates a new push subscription, but disables wrapping for payloads. | ||
| // usage: node createPushSubscriptionNoWrapper.js <topic-name-or-id> <subscription-name-or-id> | ||
|
|
||
| // [START pubsub_create_unwrapped_push_subscription] | ||
| /** | ||
| * TODO(developer): Uncomment these variables before running the sample. | ||
| */ | ||
| // const pushEndpoint = 'YOUR_ENDPOINT_URL'; | ||
| // const topicNameOrId = 'YOUR_TOPIC_NAME_OR_ID'; | ||
| // const subscriptionNameOrId = 'YOUR_SUBSCRIPTION_NAME_OR_ID'; | ||
|
|
||
| // Imports the Google Cloud client library | ||
| import {PubSub, CreateSubscriptionOptions} from '@google-cloud/pubsub'; | ||
|
|
||
| // Creates a client; cache this for further use | ||
| const pubSubClient = new PubSub(); | ||
|
|
||
| async function createPushSubscriptionNoWrapper( | ||
| pushEndpoint: string, | ||
| topicNameOrId: string, | ||
| subscriptionNameOrId: string | ||
| ) { | ||
| const options: CreateSubscriptionOptions = { | ||
| pushConfig: { | ||
| // Set to an HTTPS endpoint of your choice. If necessary, register | ||
| // (authorize) the domain on which the server is hosted. | ||
| pushEndpoint, | ||
| // When true, writes the Pub/Sub message metadata to | ||
| // `x-goog-pubsub-<KEY>:<VAL>` headers of the HTTP request. Writes the | ||
| // Pub/Sub message attributes to `<KEY>:<VAL>` headers of the HTTP request. | ||
| noWrapper: { | ||
| writeMetadata: true, | ||
| }, | ||
| }, | ||
| }; | ||
|
|
||
| await pubSubClient | ||
| .topic(topicNameOrId) | ||
| .createSubscription(subscriptionNameOrId, options); | ||
| console.log(`Subscription ${subscriptionNameOrId} created.`); | ||
| } | ||
| // [END pubsub_create_unwrapped_push_subscription] | ||
|
|
||
| function main( | ||
| pushEndpoint = 'YOUR_ENDPOINT_URL', | ||
| topicNameOrId = 'YOUR_TOPIC_NAME_OR_ID', | ||
| subscriptionNameOrId = 'YOUR_SUBSCRIPTION_NAME_OR_ID' | ||
| ) { | ||
| createPushSubscriptionNoWrapper( | ||
| pushEndpoint, | ||
| topicNameOrId, | ||
| subscriptionNameOrId | ||
| ).catch(err => { | ||
| console.error(err.message); | ||
| process.exitCode = 1; | ||
| }); | ||
| } | ||
|
|
||
| main(...process.argv.slice(2)); |