mirror of
https://github.com/imjasonh/gcloud-help
synced 2026-07-11 07:29:40 +00:00
78 lines
3.1 KiB
Text
78 lines
3.1 KiB
Text
NAME
|
|
gcloud alpha pubsub topics publish - publishes a message to the specified
|
|
topic
|
|
|
|
SYNOPSIS
|
|
gcloud alpha pubsub topics publish TOPIC [MESSAGE_BODY]
|
|
[--attribute=[ATTRIBUTE,...]] [--message=MESSAGE]
|
|
[--ordering-key=ORDERING_KEY] [GCLOUD_WIDE_FLAG ...]
|
|
|
|
DESCRIPTION
|
|
(ALPHA) Publishes a message to the specified topic name for testing and
|
|
troubleshooting. Use with caution: all associated subscribers must be able
|
|
to consume and acknowledge any message you publish, otherwise the system
|
|
will continuously re-attempt delivery of the bad message for 7 days.
|
|
|
|
EXAMPLES
|
|
To publish messages in a batch to a specific Cloud Pub/Sub topic, run:
|
|
|
|
$ gcloud alpha pubsub topics publish mytopic \
|
|
--message="Hello World!" --attribute=KEY1=VAL1,KEY2=VAL2
|
|
|
|
POSITIONAL ARGUMENTS
|
|
Topic resource - Name of the topic to publish messages to. This represents
|
|
a Cloud resource. (NOTE) Some attributes are not given arguments in this
|
|
group but can be set in other ways. To set the project attribute:
|
|
◆ provide the argument topic on the command line with a fully specified
|
|
name;
|
|
◆ provide the argument --project on the command line;
|
|
◆ set the property core/project.
|
|
|
|
This must be specified.
|
|
|
|
TOPIC
|
|
ID of the topic or fully qualified identifier for the topic. To set
|
|
the topic attribute:
|
|
▸ provide the argument topic on the command line.
|
|
|
|
[MESSAGE_BODY]
|
|
(DEPRECATED) The body of the message to publish to the given topic
|
|
name. Information on message formatting and size limits can be found
|
|
at: https://cloud.google.com/pubsub/docs/publisher#publish
|
|
|
|
Positional argument MESSAGE_BODY is deprecated. Please use --message
|
|
instead.
|
|
|
|
FLAGS
|
|
--attribute=[ATTRIBUTE,...]
|
|
Comma-separated list of attributes. Each ATTRIBUTE has the form
|
|
name="value". You can specify up to 100 attributes.
|
|
|
|
--message=MESSAGE
|
|
The body of the message to publish to the given topic name. Information
|
|
on message formatting and size limits can be found at:
|
|
https://cloud.google.com/pubsub/docs/publisher#publish
|
|
|
|
--ordering-key=ORDERING_KEY
|
|
The key for ordering delivery to subscribers. All messages with the
|
|
same ordering key are sent to subscribers in the order that Pub/Sub
|
|
receives them.
|
|
|
|
GCLOUD WIDE FLAGS
|
|
These flags are available to all commands: --access-token-file, --account,
|
|
--billing-project, --configuration, --flags-file, --flatten, --format,
|
|
--help, --impersonate-service-account, --log-http, --project, --quiet,
|
|
--trace-token, --user-output-enabled, --verbosity.
|
|
|
|
Run $ gcloud help for details.
|
|
|
|
NOTES
|
|
This command is currently in alpha and might change without notice. If this
|
|
command fails with API permission errors despite specifying the correct
|
|
project, you might be trying to access an API with an invitation-only early
|
|
access allowlist. These variants are also available:
|
|
|
|
$ gcloud pubsub topics publish
|
|
|
|
$ gcloud beta pubsub topics publish
|
|
|