gcloud pubsub subscriptions pull

NAME
gcloud pubsub subscriptions pull - pulls one or more Cloud Pub/Sub messages from a subscription
SYNOPSIS
gcloud pubsub subscriptions pullSUBSCRIPTION[--auto-ack][--filter=EXPRESSION][--limit=LIMIT; default=1][--page-size=PAGE_SIZE][--sort-by=[FIELD,…]][--uri][GCLOUD_WIDE_FLAG]
DESCRIPTION
Returns one or more messages from the specified Cloud Pub/Sub subscription, ifthere are any messages enqueued.

By default, this command returns only one message from the subscription. Use the--limit flag to specify the max messages to return.

Please note that this command is not guaranteed to return all the messages inyour backlog or the maximum specified in the --limit argument. Receiving fewermessages than available occasionally is normal.

POSITIONAL ARGUMENTS
Subscription resource - Name of the subscription to pull messages from. Thisrepresents a Cloud resource. (NOTE) Some attributes are not given arguments inthis group but can be set in other ways.

To set theproject attribute:

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

This must be specified.

SUBSCRIPTION
ID of the subscription or fully qualified identifier for the subscription.

To set thesubscription attribute:

  • provide the argumentsubscription on the command line.
FLAGS
--auto-ack
Automatically ACK every message pulled from this subscription. Use --no-auto-ackto disable this flag.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filterEXPRESSION to each resource itemto be listed. If the expression evaluatesTrue, then that item islisted. For more details and examples of filter expressions, run $gcloud topic filters. This flaginteracts with other flags that are applied in this order:--flatten,--sort-by,--filter,--limit.
--limit=LIMIT; default=1
Maximum number of resources to list. The default is1. This flaginteracts with other flags that are applied in this order:--flatten,--sort-by,--filter,--limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag specifies themaximum number of resources per page. The default is determined by the serviceif it supports paging, otherwise it isunlimited (no paging).Paging may be applied before or after--filter and--limit depending on the service.
--sort-by=[FIELD,…]
Comma-separated list of resource field key names to sort by. The default orderis ascending. Prefix a field with ``~´´ for descending order on thatfield. This flag interacts with other flags that are applied in this order:--flatten,--sort-by,--filter,--limit.
--uri
Print a list of resource URIs instead of the default output, and change thecommand output to a list of URIs. If this flag is used with--format, the formatting is applied on this URI list. To displayURIs alongside other keys instead, use theuri() transform.
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
These variants are also available:
gcloudalphapubsubsubscriptionspull
gcloudbetapubsubsubscriptionspull

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.