.TH "GCLOUD_BETA_PUBSUB_SUBSCRIPTIONS_PULL" 1



.SH "NAME"
.HP
gcloud beta pubsub subscriptions pull \- pulls one or more Cloud Pub/Sub messages from a subscription



.SH "SYNOPSIS"
.HP
\f5gcloud beta pubsub subscriptions pull\fR \fISUBSCRIPTION\fR [\fB\-\-auto\-ack\fR] [\fB\-\-max\-messages\fR=\fIMAX_MESSAGES\fR;\ default=1] [\fB\-\-return\-immediately\fR\ |\ \fB\-\-no\-wait\fR] [\fB\-\-filter\fR=\fIEXPRESSION\fR] [\fB\-\-limit\fR=\fILIMIT\fR] [\fB\-\-page\-size\fR=\fIPAGE_SIZE\fR] [\fB\-\-sort\-by\fR=[\fIFIELD\fR,...]] [\fB\-\-uri\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(BETA)\fR Returns one or more messages from the specified Cloud Pub/Sub
subscription, if there are any messages enqueued.

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

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



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Subscription resource \- Name of the subscription to pull messages from. 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 \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5subscription\fR on the command line with a fully
specified name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fISUBSCRIPTION\fR

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

To set the \f5subscription\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5subscription\fR on the command line.
.RE
.sp


.RE
.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-auto\-ack\fR

Automatically ACK every message pulled from this subscription. Use
\-\-no\-auto\-ack to disable this flag.

.TP 2m
\fB\-\-max\-messages\fR=\fIMAX_MESSAGES\fR; default=1

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

\f5\-\-max\-messages\fR is deprecated. Please use \-\-limit instead.

.TP 2m

Pull timeout behavior.

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-return\-immediately\fR

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

.TP 2m
\fB\-\-wait\fR

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

\f5\-\-wait\fR is deprecated. This flag is non\-operational, as the wait
behavior is now the default. Enabled by default, use \fB\-\-no\-wait\fR to
disable.


.RE
.RE
.sp

.SH "LIST COMMAND FLAGS"

.RS 2m
.TP 2m
\fB\-\-filter\fR=\fIEXPRESSION\fR

Apply a Boolean filter \fIEXPRESSION\fR to each resource item to be listed. If
the expression evaluates \f5True\fR, then that item is listed. For more details
and examples of filter expressions, run $ gcloud topic filters. This flag
interacts with other flags that are applied in this order: \fB\-\-flatten\fR,
\fB\-\-sort\-by\fR, \fB\-\-filter\fR, \fB\-\-limit\fR.

.TP 2m
\fB\-\-limit\fR=\fILIMIT\fR

Maximum number of resources to list. The default is \fBunlimited\fR. This flag
interacts with other flags that are applied in this order: \fB\-\-flatten\fR,
\fB\-\-sort\-by\fR, \fB\-\-filter\fR, \fB\-\-limit\fR.

.TP 2m
\fB\-\-page\-size\fR=\fIPAGE_SIZE\fR

Some services group resource list output into pages. This flag specifies the
maximum number of resources per page. The default is determined by the service
if it supports paging, otherwise it is \fBunlimited\fR (no paging). Paging may
be applied before or after \fB\-\-filter\fR and \fB\-\-limit\fR depending on the
service.

.TP 2m
\fB\-\-sort\-by\fR=[\fIFIELD\fR,...]

Comma\-separated list of resource field key names to sort by. The default order
is ascending. Prefix a field with ``~'' for descending order on that field. This
flag interacts with other flags that are applied in this order:
\fB\-\-flatten\fR, \fB\-\-sort\-by\fR, \fB\-\-filter\fR, \fB\-\-limit\fR.

.TP 2m
\fB\-\-uri\fR

Print a list of resource URIs instead of the default output, and change the
command output to a list of URIs. If this flag is used with \fB\-\-format\fR,
the formatting is applied on this URI list. To display URIs alongside other keys
instead, use the \fBuri()\fR transform.


.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "NOTES"

This command is currently in beta and might change without notice. These
variants are also available:

.RS 2m
$ gcloud pubsub subscriptions pull
.RE

.RS 2m
$ gcloud alpha pubsub subscriptions pull
.RE