gcloud: Wed Oct 5 10:40:53 UTC 2022

gcloud/firestore/fields/help

@@ -0,0 +1,27 @@
+NAME
+    gcloud firestore fields - manage field metadata for Cloud Firestore
+
+SYNOPSIS
+    gcloud firestore fields GROUP [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    Manage field metadata for Cloud Firestore.
+
+GCLOUD WIDE FLAGS
+    These flags are available to all commands: --help.
+
+    Run $ gcloud help for details.
+
+GROUPS
+    GROUP is one of the following:
+
+     ttls
+        Manage Time-to-live metadata for Cloud Firestore.
+
+NOTES
+    These variants are also available:
+
+        $ gcloud alpha firestore fields
+
+        $ gcloud beta firestore fields
+

gcloud/firestore/fields/ttls/help

@@ -0,0 +1,31 @@
+NAME
+    gcloud firestore fields ttls - manage Time-to-live metadata for Cloud
+        Firestore
+
+SYNOPSIS
+    gcloud firestore fields ttls COMMAND [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    Manage Time-to-live metadata for Cloud Firestore.
+
+GCLOUD WIDE FLAGS
+    These flags are available to all commands: --help.
+
+    Run $ gcloud help for details.
+
+COMMANDS
+    COMMAND is one of the following:
+
+     list
+        List all fields used as a Time To Live expiration setting.
+
+     update
+        Update the TTL configuration of the given field.
+
+NOTES
+    These variants are also available:
+
+        $ gcloud alpha firestore fields ttls
+
+        $ gcloud beta firestore fields ttls
+

gcloud/firestore/fields/ttls/list

@@ -0,0 +1,96 @@
+NAME
+    gcloud firestore fields ttls list - list all fields used as a Time To Live
+        expiration setting
+
+SYNOPSIS
+    gcloud firestore fields ttls list [--collection-group=COLLECTION_GROUP]
+        [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
+        [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    List fields that give an expiration timestamp for documents in a collection
+    group or kind.
+
+EXAMPLES
+    The following command lists all TTL fields for the whole database:
+
+        $ gcloud firestore fields ttls list
+
+FLAGS
+     Collection group resource - Collection group of the ttl.
+
+     This can be omitted to include fields across all collection groups
+     (kinds). 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
+     project attribute:
+      ◆ provide the argument --collection-group on the command line with a
+        fully specified name;
+      ◆ provide the argument [--collection-group] on the command line with a
+        fully specified name;
+      ◆ set the property core/project;
+      ◆ provide the argument --project on the command line. To set the
+        database attribute:
+      ◆ provide the argument --collection-group on the command line with a
+        fully specified name;
+      ◆ provide the argument [--collection-group] on the command line with a
+        fully specified name;
+      ◆ provide the argument [--database] on the command line (currently
+        '(default)' is the only supported value).
+
+       --collection-group=COLLECTION_GROUP
+          ID of the collection group or fully qualified identifier for the
+          collection group. To set the collection-group attribute:
+          ▸ provide the argument --collection-group on the command line;
+          ▸ provide the argument [--collection-group] on the command line.
+
+LIST COMMAND FLAGS
+     --filter=EXPRESSION
+        Apply a Boolean filter EXPRESSION to each resource item to be listed.
+        If the expression evaluates True, 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:
+        --flatten, --sort-by, --filter, --limit.
+
+     --limit=LIMIT
+        Maximum number of resources to list. The default is unlimited. This
+        flag interacts with other flags that are applied in this order:
+        --flatten, --sort-by, --filter, --limit.
+
+     --page-size=PAGE_SIZE
+        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
+        unlimited (no paging). Paging may be applied before or after --filter
+        and --limit depending on the service.
+
+     --sort-by=[FIELD,...]
+        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: --flatten, --sort-by, --filter, --limit.
+
+     --uri
+        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
+        --format, the formatting is applied on this URI list. To display URIs
+        alongside other keys instead, use the uri() transform.
+
+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 $ gcloud help for details.
+
+API REFERENCE
+    This command uses the firestore/v1 API. The full documentation for this API
+    can be found at: https://cloud.google.com/firestore
+
+NOTES
+    These variants are also available:
+
+        $ gcloud alpha firestore fields ttls list
+
+        $ gcloud beta firestore fields ttls list
+

gcloud/firestore/fields/ttls/update

@@ -0,0 +1,95 @@
+NAME
+    gcloud firestore fields ttls update - update the TTL configuration of the
+        given field
+
+SYNOPSIS
+    gcloud firestore fields ttls update
+        (FIELD : --collection-group=COLLECTION_GROUP)
+        (--disable-ttl | --enable-ttl) [--async] [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    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.
+
+EXAMPLES
+    The following command sets the expiry field of the Events collection group
+    (kind) to be the TTL field:
+
+        $ gcloud firestore fields ttls update expiry \
+            --collection-group=Events --enable-ttl
+
+    The following command disables the expiry field so it is no longer the TTL
+    for the Events collection group (kind):
+
+        $ gcloud firestore fields ttls update expiry \
+            --collection-group=Events --disable-ttl
+
+POSITIONAL ARGUMENTS
+     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
+     project attribute:
+      ◆ provide the argument field on the command line with a fully specified
+        name;
+      ◆ set the property core/project;
+      ◆ provide the argument --project on the command line. To set the
+        database attribute:
+      ◆ provide the argument field on the command line with a fully specified
+        name;
+      ◆ provide the argument [--database] on the command line (currently
+        '(default)' is the only supported value).
+
+     This must be specified.
+
+       FIELD
+          ID of the field or fully qualified identifier for the field. To set
+          the field attribute:
+          ▸ provide the argument field on the command line.
+
+          This positional argument must be specified if any of the other
+          arguments in this group are specified.
+
+       --collection-group=COLLECTION_GROUP
+          Collection group of the field.
+
+          To set the collection-group attribute:
+          ▸ provide the argument field on the command line with a fully
+            specified name;
+          ▸ provide the argument --collection-group on the command line.
+
+REQUIRED FLAGS
+     Exactly one of these must be specified:
+
+       --disable-ttl
+          Set to make this field no longer the TTL for its collection group.
+
+       --enable-ttl
+          Set to enable this field as the TTL for its collection group.
+
+OPTIONAL FLAGS
+     --async
+        Return immediately, without waiting for the operation in progress to
+        complete.
+
+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 $ gcloud help for details.
+
+API REFERENCE
+    This command uses the firestore/v1 API. The full documentation for this API
+    can be found at: https://cloud.google.com/firestore
+
+NOTES
+    These variants are also available:
+
+        $ gcloud alpha firestore fields ttls update
+
+        $ gcloud beta firestore fields ttls update
+

gcloud/firestore/help

@@ -24,6 +24,9 @@ GROUPS
      databases
         Manage Creation of Cloud Firestore in Native mode Database.
 
+     fields
+        Manage field metadata for Cloud Firestore.
+
      indexes
         Manage indexes for Cloud Firestore.