gcloud beta pubsub subscriptions pull - pulls one or more Cloud Pub/Sub messages from a subscription

gcloud beta pubsub subscriptions pullSUBSCRIPTION[--auto-ack][--max-messages=MAX_MESSAGES; default=1][--return-immediately    |--no-wait][--filter=EXPRESSION][--limit=LIMIT][--page-size=PAGE_SIZE][--sort-by=[FIELD,…]][--uri][GCLOUD_WIDE_FLAG …]

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.

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.

--auto-ack

Automatically ACK every message pulled from this subscription. Use --no-auto-ackto disable this flag.

--max-messages=MAX_MESSAGES; default=1

(DEPRECATED) The maximum number of messages that Cloud Pub/Sub can return inthis response.

--max-messages is deprecated. Please use --limit instead.

Pull timeout behavior.

At most one of these can be specified:

--return-immediately

If this flag is set, the system responds immediately with any messages readilyavailable in memory buffers. If no messages are available in the buffers,returns an empty list of messages as response, even if having messages in thebacklog. Do not set this flag as it adversely impacts the performance of pull.Use --no-return-immediately to disable this flag.

--wait

(DEPRECATED) Wait (for a bounded amount of time) for new messages from thesubscription, if there are none.

--wait is deprecated. This flag is non-operational, as the waitbehavior is now the default. Enabled by default, use--no-wait todisable.

--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

Maximum number of resources to list. The default isunlimited. Thisflag interacts 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.

Run$gcloud help for details.