.TH "GCLOUD_ALPHA_TASKS_LEASE" 1



.SH "NAME"
.HP
gcloud alpha tasks lease \- leases a list of tasks and displays them



.SH "SYNOPSIS"
.HP
\f5gcloud alpha tasks lease\fR \fB\-\-lease\-duration\fR=\fILEASE_DURATION\fR \fB\-\-queue\fR=\fIQUEUE\fR [\fB\-\-location\fR=\fILOCATION\fR] [\fB\-\-oldest\-tag\fR\ |\ \fB\-\-tag\fR=\fITAG\fR] [\fB\-\-filter\fR=\fIEXPRESSION\fR] [\fB\-\-limit\fR=\fILIMIT\fR;\ default=1000] [\fB\-\-sort\-by\fR=[\fIFIELD\fR,...]] [\fB\-\-uri\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR Each task returned from this command will have its schedule time
changed based on the lease duration specified. A task that has been returned by
calling this command will not be returned in a different call before its
schedule time. After the work associated with a task is finished, the lease
holder should call \f5gcloud tasks acknowledge\fR on the task.



.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m
\fB\-\-lease\-duration\fR=\fILEASE_DURATION\fR

The number of seconds for the desired new lease duration for all tasks leased,
starting from now. The maximum lease duration is 1 week.

.TP 2m
\fB\-\-queue\fR=\fIQUEUE\fR

The queue the tasks belong to.


.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-location\fR=\fILOCATION\fR

The location where we want to manage the queue or task. If not specified, uses
the location of the current project's App Engine app if there is an associated
app.

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-oldest\-tag\fR

Only lease tasks which have the same tag as the task with the oldest schedule
time.

.TP 2m
\fB\-\-tag\fR=\fITAG\fR

A tag to filter each task to be leased. If a task has the tag and the task is
available to be leased, then it is listed and leased.


.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; default=1000

The maximum number of tasks to lease. The maximum that can be requested is 1000.

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