.TH "GCLOUD_ALPHA_PUBSUB_LITE\-SUBSCRIPTIONS_SEEK" 1



.SH "NAME"
.HP
gcloud alpha pubsub lite\-subscriptions seek \- seek a Pub/Sub Lite subscription



.SH "SYNOPSIS"
.HP
\f5gcloud alpha pubsub lite\-subscriptions seek\fR (\fISUBSCRIPTION\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) (\fB\-\-event\-time\fR=\fIEVENT_TIME\fR\ |\ \fB\-\-publish\-time\fR=\fIPUBLISH_TIME\fR\ |\ \fB\-\-starting\-offset\fR=\fISTARTING_OFFSET\fR) [\fB\-\-async\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR Initiate an out\-of\-band seek operation for a Pub/Sub Lite
subscription to a specified target, which may be timestamps or named locations
within the message backlog.

The seek operation will complete once subscriber clients react to the seek for
all partitions of the topic. Note that the seek operation will not complete
until subscribers are online. It may take some time (usually within 30 seconds)
for the seek to propagate if subscribers are online. Use the \-\-async flag if
it's not necessary to wait for completion.



.SH "EXAMPLES"

To seek a Pub/Sub Lite subscription to the beginning of the message backlog,
run:

.RS 2m
$ gcloud alpha pubsub lite\-subscriptions seek mysubscription \e
  \-\-location=us\-central1\-a \-\-starting\-offset=beginning
.RE

To seek a Pub/Sub Lite subscription to a publish time without waiting for the
operation to complete, run:

.RS 2m
$ gcloud alpha pubsub lite\-subscriptions seek mysubscription \e
  \-\-location=us\-central1\-a \-\-publish\-time="2021\-01\-01T12:00:00Z" \e
  \-\-async
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Subscription resource \- Subscription to seek. 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 "REQUIRED FLAGS"

.RS 2m
.TP 2m

Exactly one of these must be specified:


.RS 2m
.TP 2m
\fB\-\-event\-time\fR=\fIEVENT_TIME\fR

The event time to which you seek a subscription. The subscription seeks to the
first message with event time greater than or equal to the specified event time.
Messages missing an event time use publish time as a fallback. As event times
are user supplied, subsequent messages may have event times less than the
specified event time and must be filtered by the client, if necessary. Run $
gcloud topic datetimes for information on time formats.

.TP 2m
\fB\-\-publish\-time\fR=\fIPUBLISH_TIME\fR

The publish time to which you seek a subscription. Messages with publish time
greater than or equal to the specified time are delivered after the seek
operation. Run $ gcloud topic datetimes for information on time formats.

.TP 2m
\fB\-\-starting\-offset\fR=\fISTARTING_OFFSET\fR

The offset at which a newly created or seeked subscription starts receiving
messages. A subscription can be initialized at the offset of the oldest retained
message (\f5beginning\fR), or at the current HEAD offset (\f5end\fR).
\fISTARTING_OFFSET\fR must be one of: \fBbeginning\fR, \fBend\fR.


.RE
.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-async\fR

Return immediately, without waiting for the operation in progress to complete.


.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 "API REFERENCE"

This command uses the \fBpubsublite/v1\fR API. The full documentation for this
API can be found at: https://cloud.google.com/pubsub/lite/docs



.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 seek
.RE

.RS 2m
$ gcloud beta pubsub lite\-subscriptions seek
.RE