gcloud: Wed Mar 12 10:54:38 UTC 2025

gcloud/storage/buckets/anywhere-caches/create

@@ -0,0 +1,64 @@
+NAME
+    gcloud storage buckets anywhere-caches create - create Anywhere Cache
+        instances for a bucket
+
+SYNOPSIS
+    gcloud storage buckets anywhere-caches create URL ZONE [ZONE ...]
+        [--admission-policy=ADMISSION_POLICY] [--ttl=TTL]
+        [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    Create Anywhere Cache instances. Only one cache instance per zone can be
+    created for each bucket.
+
+EXAMPLES
+    The following command creates an anywhere cache instance for bucket in
+    asia-south2-b zone:
+
+        $ gcloud storage buckets anywhere-caches create gs://my-bucket \
+            asia-south2-b
+
+    The following command creates anywhere cache instances for bucket in
+    asia-south2-b, and asia-east1-a zone:
+
+        $ gcloud storage buckets anywhere-caches create gs://my-bucket \
+            asia-south2-b asia-east1-a
+
+    The following command creates an anywhere cache instance for bucket in
+    asia-south2-b zone, with ttl for cache entry as 6 hours, and admission
+    policy as ADMIT_ON_SECOND_MISS:
+
+        $ gcloud storage buckets anywhere-caches create gs://my-bucket \
+            asia-south2-b --ttl=6h --admission-policy='ADMIT_ON_SECOND_MISS'
+
+POSITIONAL ARGUMENTS
+     URL
+        Specifies the URL of the bucket where the Anywhere Cache should be
+        created.
+
+     ZONE [ZONE ...]
+        Specifies the name of the zonal locations where the Anywhere Cache
+        should be created.
+
+FLAGS
+     --admission-policy=ADMISSION_POLICY
+        The cache admission policy decides for each cache miss, whether to
+        insert the missed block or not. ADMISSION_POLICY must be one of:
+        ADMIT_ON_FIRST_MISS, ADMIT_ON_SECOND_MISS.
+
+     --ttl=TTL
+        Cache entry time-to-live. Default to 24h if not provided.
+
+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.
+
+NOTES
+    This variant is also available:
+
+        $ gcloud alpha storage buckets anywhere-caches create
+

gcloud/storage/buckets/anywhere-caches/describe

@@ -0,0 +1,41 @@
+NAME
+    gcloud storage buckets anywhere-caches describe - returns details of
+        Anywhere Cache instance of a bucket
+
+SYNOPSIS
+    gcloud storage buckets anywhere-caches describe ID [--raw]
+        [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    Desribes a single Anywhere Cache instance if it exists.
+
+EXAMPLES
+    The following command describes the anywhere cache instance of bucket
+    my-bucket having anywhere_cache_id my-cache-id:
+
+        $ gcloud storage buckets anywhere-caches describe \
+            my-bucket/my-cache-id
+
+POSITIONAL ARGUMENTS
+     ID
+        Identifier for a Anywhere Cache instance. It is a combination of
+        bucket_name/anywhere_cache_id, For example : test-bucket/my-cache-id.
+
+FLAGS
+     --raw
+        Shows metadata in the format returned by the API instead of
+        standardizing it.
+
+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.
+
+NOTES
+    This variant is also available:
+
+        $ gcloud alpha storage buckets anywhere-caches describe
+

gcloud/storage/buckets/anywhere-caches/disable

@@ -0,0 +1,44 @@
+NAME
+    gcloud storage buckets anywhere-caches disable - disable Anywhere Cache
+        instances
+
+SYNOPSIS
+    gcloud storage buckets anywhere-caches disable ID [ID ...]
+        [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    Disables one or more Anywhere Cache instances.
+
+    The cache instance will be set to DISABLED state. The existing entries can
+    be read from the cache but new entries will not be written to the cache.
+    The L4 SSD cache would not be deleted by the cache manager until the min
+    TTL (1h) has been reached (cache instance is kept for at least 1h). Google
+    Cloud Storage defines the min TTL which is applied to all cache instances.
+    Cach disablement could be canceled by using anywhere-caches resume command
+    before the instance is deleted.
+
+EXAMPLES
+    The following command disables the anywhere cache instance of bucket
+    my-bucket having anywhere_cache_id my-cache-id:
+
+        $ gcloud storage buckets anywhere-caches disable \
+            my-bucket/my-cache-id
+
+POSITIONAL ARGUMENTS
+     ID [ID ...]
+        Identifiers for a Anywhere Cache instance. They are combination of
+        bucket_name/anywhere_cache_id. For example : test-bucket/my-cache-id.
+
+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.
+
+NOTES
+    This variant is also available:
+
+        $ gcloud alpha storage buckets anywhere-caches disable
+

gcloud/storage/buckets/anywhere-caches/help

@@ -0,0 +1,44 @@
+NAME
+    gcloud storage buckets anywhere-caches - manage Cloud Storage Anywhere
+        Caches
+
+SYNOPSIS
+    gcloud storage buckets anywhere-caches COMMAND [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    Manage Cloud Storage Anywhere Caches.
+
+GCLOUD WIDE FLAGS
+    These flags are available to all commands: --help.
+
+    Run $ gcloud help for details.
+
+COMMANDS
+    COMMAND is one of the following:
+
+     create
+        Create Anywhere Cache instances for a bucket.
+
+     describe
+        Returns details of Anywhere Cache instance of a bucket.
+
+     disable
+        Disable Anywhere Cache instances.
+
+     list
+        List all Anywhere Cache instances of a bucket.
+
+     pause
+        Pause Anywhere Cache instances.
+
+     resume
+        Resume Anywhere Cache instances.
+
+     update
+        Update Anywhere Cache instances.
+
+NOTES
+    This variant is also available:
+
+        $ gcloud alpha storage buckets anywhere-caches
+

gcloud/storage/buckets/anywhere-caches/list

@@ -0,0 +1,73 @@
+NAME
+    gcloud storage buckets anywhere-caches list - list all Anywhere Cache
+        instances of a bucket
+
+SYNOPSIS
+    gcloud storage buckets anywhere-caches list URL [--raw]
+        [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
+        [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    List all cache instances of this bucket.
+
+EXAMPLES
+    The following command lists all anywhere cache instances of bucket
+    gs://my-bucket:
+
+        $ gcloud storage buckets anywhere-caches list gs://my-bucket
+
+POSITIONAL ARGUMENTS
+     URL
+        Specifies the URL of the bucket for which anywhere cache instances
+        should be listed.
+
+FLAGS
+     --raw
+        Shows metadata in the format returned by the API instead of
+        standardizing it.
+
+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.
+
+NOTES
+    This variant is also available:
+
+        $ gcloud alpha storage buckets anywhere-caches list
+

gcloud/storage/buckets/anywhere-caches/pause

@@ -0,0 +1,36 @@
+NAME
+    gcloud storage buckets anywhere-caches pause - pause Anywhere Cache
+        instances
+
+SYNOPSIS
+    gcloud storage buckets anywhere-caches pause ID [ID ...]
+        [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    The pause operation can be used to stop the data ingestion of a cache
+    instance in RUNNING state (read-only cache) until the Resume is invoked.
+
+EXAMPLES
+    The following command pause the anywhere cache instance of bucket my-bucket
+    having anywhere_cache_id my-cache-id:
+
+        $ gcloud storage buckets anywhere-caches pause my-bucket/my-cache-id
+
+POSITIONAL ARGUMENTS
+     ID [ID ...]
+        Identifiers for a Anywhere Cache instance. They are combination of
+        bucket_name/anywhere_cache_id. For example : test-bucket/my-cache-id.
+
+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.
+
+NOTES
+    This variant is also available:
+
+        $ gcloud alpha storage buckets anywhere-caches pause
+

gcloud/storage/buckets/anywhere-caches/resume

@@ -0,0 +1,38 @@
+NAME
+    gcloud storage buckets anywhere-caches resume - resume Anywhere Cache
+        instances
+
+SYNOPSIS
+    gcloud storage buckets anywhere-caches resume ID [ID ...]
+        [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    Resume operation could be used to revert the Paused and Disabled state.
+    Once a paused/disabled cache is resumed, the cache will be set to
+    RUNNING/CREATING state: 1. RUNNING if the cache is active. 2. CREATING if
+    the cache is pending creation.
+
+EXAMPLES
+    The following command resume the anywhere cache instance of bucket
+    my-bucket having anywhere_cache_id my-cache-id:
+
+        $ gcloud storage buckets anywhere-caches resume my-bucket/my-cache-id
+
+POSITIONAL ARGUMENTS
+     ID [ID ...]
+        Identifiers for a Anywhere Cache instance. They are combination of
+        bucket_name/anywhere_cache_id. For example : test-bucket/my-cache-id.
+
+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.
+
+NOTES
+    This variant is also available:
+
+        $ gcloud alpha storage buckets anywhere-caches resume
+

gcloud/storage/buckets/anywhere-caches/update

@@ -0,0 +1,56 @@
+NAME
+    gcloud storage buckets anywhere-caches update - update Anywhere Cache
+        instances
+
+SYNOPSIS
+    gcloud storage buckets anywhere-caches update ID [ID ...]
+        [--admission-policy=ADMISSION_POLICY] [--ttl=TTL]
+        [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    Update one or more Anywhere Cache instances. A cache instance can be
+    updated if its state is created or pending creation.
+
+EXAMPLES
+    The following command updates cache entry's ttl, and admisson policy of
+    anywhere cache instance in bucket my-bucket having anywhere_cache_id
+    my-cache-id:
+
+        $ gcloud storage buckets anywhere-caches update \
+            my-bucket/my-cache-id --ttl=6h \
+            --admission-policy='ADMIT_ON_SECOND_MISS'
+
+    The following command updates cache entry's ttl of anywhere cache instances
+    in bucket bucket-1 and bucket-2 having anywhere_cache_id my-cache-id-1, and
+    my-cache-id-2 respectively:
+
+        $ gcloud storage buckets anywhere-caches update \
+            bucket-1/my-cache-id-1 bucket-2/my-cache-id-2 --ttl=6h
+
+POSITIONAL ARGUMENTS
+     ID [ID ...]
+        Identifiers for a Anywhere Cache Instance.They are combination of
+        bucket_name/anywhere_cache_id. For example : test-bucket/my-cache-id.
+
+FLAGS
+     --admission-policy=ADMISSION_POLICY
+        The cache admission policy decides for each cache miss, whether to
+        insert the missed block or not. ADMISSION_POLICY must be one of:
+        ADMIT_ON_FIRST_MISS, ADMIT_ON_SECOND_MISS.
+
+     --ttl=TTL
+        Cache entry time-to-live. Default to 24h if not provided.
+
+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.
+
+NOTES
+    This variant is also available:
+
+        $ gcloud alpha storage buckets anywhere-caches update
+

gcloud/storage/buckets/help

@@ -15,6 +15,9 @@ GCLOUD WIDE FLAGS
 GROUPS
     GROUP is one of the following:
 
+     anywhere-caches
+        Manage Cloud Storage Anywhere Caches.
+
      notifications
         Manage Cloud Storage bucket notifications.