gcloud alpha pubsub topics publish

NAME
gcloud alpha pubsub topics publish - publishes a message to the specified topic
SYNOPSIS
gcloud alpha pubsub topics publishTOPIC[MESSAGE_BODY][--attribute=[ATTRIBUTE,…]][--message=MESSAGE][--ordering-key=ORDERING_KEY][GCLOUD_WIDE_FLAG …]
DESCRIPTION
(ALPHA) Publishes a message to the specified topic name for testingand troubleshooting. Use with caution: all associated subscribers must be ableto consume and acknowledge any message you publish, otherwise the system willcontinuously 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:
gcloudalphapubsubtopicspublishmytopic--message="Hello World!"--attribute=KEY1=VAL1,KEY2=VAL2
POSITIONAL ARGUMENTS
Topic resource - Name of the topic to publish messages to. This represents aCloud resource. (NOTE) Some attributes are not given arguments in this group butcan be set in other ways.

To set theproject attribute:

  • provide the argumenttopic on the command line with a fullyspecified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.

This must be specified.

TOPIC
ID of the topic or fully qualified identifier for the topic.

To set thetopic attribute:

  • provide the argumenttopic 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 argumentMESSAGE_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 onmessage 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 sameordering 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 thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. These variants are also available:
gcloudpubsubtopicspublish
gcloudbetapubsubtopicspublish

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-05-07 UTC.