File: //snap/google-cloud-cli/396/help/man/man1/gcloud_alpha_pubsub_lite-subscriptions_subscribe.1
.TH "GCLOUD_ALPHA_PUBSUB_LITE\-SUBSCRIPTIONS_SUBSCRIBE" 1
.SH "NAME"
.HP
gcloud alpha pubsub lite\-subscriptions subscribe \- stream messages from a Pub/Sub Lite subscription
.SH "SYNOPSIS"
.HP
\f5gcloud alpha pubsub lite\-subscriptions subscribe\fR (\fISUBSCRIPTION\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) [\fB\-\-auto\-ack\fR] [\fB\-\-num\-messages\fR=\fINUM_MESSAGES\fR;\ default=1] [\fB\-\-partitions\fR=[\fIINT\fR,...]] [\fIGCLOUD_WIDE_FLAG\ ...\fR]
.SH "DESCRIPTION"
\fB(ALPHA)\fR Streams messages from a Pub/Sub Lite subscription. This command
requires Python 3.6 or greater, and requires the grpcio Python package to be
installed.
For MacOS, Linux, and Cloud Shell users, to install the gRPC client libraries,
run:
.RS 2m
$ sudo pip3 install grpcio
$ export CLOUDSDK_PYTHON_SITEPACKAGES=1
.RE
.SH "EXAMPLES"
To subscribe to a Pub/Sub Lite subscription and automatically acknowledge
messages, run:
.RS 2m
$ gcloud alpha pubsub lite\-subscriptions subscribe mysubscription \e
\-\-location=us\-central1\-a \-\-auto\-ack
.RE
To subscribe to specific partitions in a subscription, run:
.RS 2m
$ gcloud alpha pubsub lite\-subscriptions subscribe mysubscription \e
\-\-location=us\-central1\-a \-\-partitions=0,1,2
.RE
.SH "POSITIONAL ARGUMENTS"
.RS 2m
.TP 2m
Subscription resource \- The Pub/Sub Lite subscription to receive messages from.
The arguments in this group can be used to specify the attributes of this
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
This positional argument must be specified if any of the other arguments in this
group are specified.
.TP 2m
\fB\-\-location\fR=\fILOCATION\fR
ID of the location of the Pub/Sub Lite resource.
To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5subscription\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-location\fR on the command line.
.RE
.sp
.RE
.RE
.sp
.SH "FLAGS"
.RS 2m
.TP 2m
\fB\-\-auto\-ack\fR
Automatically ACK every message received on this subscription.
.TP 2m
\fB\-\-num\-messages\fR=\fINUM_MESSAGES\fR; default=1
The number of messages to stream before exiting. This value must be less than or
equal to 1000.
.TP 2m
\fB\-\-partitions\fR=[\fIINT\fR,...]
The partitions this subscriber should connect to to receive messages. If empty,
partitions will be automatically assigned.
.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 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:
.RS 2m
$ gcloud pubsub lite\-subscriptions subscribe
.RE
.RS 2m
$ gcloud beta pubsub lite\-subscriptions subscribe
.RE