.TH "GCLOUD_BETA_FIRESTORE_FIELDS_TTLS_UPDATE" 1



.SH "NAME"
.HP
gcloud beta firestore fields ttls update \- update the TTL configuration of the given field



.SH "SYNOPSIS"
.HP
\f5gcloud beta firestore fields ttls update\fR (\fIFIELD\fR\ :\ \fB\-\-collection\-group\fR=\fICOLLECTION_GROUP\fR\ \fB\-\-database\fR=\fIDATABASE\fR) (\fB\-\-disable\-ttl\fR\ |\ \fB\-\-enable\-ttl\fR) [\fB\-\-async\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(BETA)\fR Update the TTL configuration of the given field.

This enables or disables using a field as the TTL field for its collection group
or kind. Note that only one field can be the TTL field for a collection group.



.SH "EXAMPLES"

The following command sets the \f5expiry\fR field of the \f5Events\fR collection
group (kind) to be the TTL field:

.RS 2m
$ gcloud beta firestore fields ttls update expiry \e
    \-\-collection\-group=Events \-\-enable\-ttl
.RE

The following command disables the \f5expiry\fR field so it is no longer the TTL
for the \f5Events\fR collection group (kind):

.RS 2m
$ gcloud beta firestore fields ttls update expiry \e
    \-\-collection\-group=Events \-\-disable\-ttl
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Field resource \- Field to update. 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 \f5field\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
\fIFIELD\fR

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

To set the \f5field\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5field\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\-\-collection\-group\fR=\fICOLLECTION_GROUP\fR

Collection group of the field.


To set the \f5collection\-group\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5field\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-collection\-group\fR on the command line.
.RE
.sp

.TP 2m
\fB\-\-database\fR=\fIDATABASE\fR

Database of the field.


To set the \f5database\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5field\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-database\fR on the command line;
.IP "\(bu" 2m
the default value of argument [\-\-database] is \f5(default)\fR.
.RE
.sp


.RE
.RE
.sp

.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m

Exactly one of these must be specified:


.RS 2m
.TP 2m
\fB\-\-disable\-ttl\fR

Set to make this field no longer the TTL for its collection group.

.TP 2m
\fB\-\-enable\-ttl\fR

Set to enable this field as the TTL for its collection group.


.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 \fBfirestore/v1\fR API. The full documentation for this
API can be found at: https://cloud.google.com/firestore



.SH "NOTES"

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

.RS 2m
$ gcloud firestore fields ttls update
.RE

.RS 2m
$ gcloud alpha firestore fields ttls update
.RE