1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-16 20:36:39 +00:00

gcloud: Wed Jan 10 10:17:49 UTC 2024

This commit is contained in:
Automated 2024-01-10 10:17:49 +00:00
parent 08ad88258a
commit 5fec13c692
262 changed files with 3211 additions and 4501 deletions

View file

@ -0,0 +1,66 @@
NAME
gcloud alpha storage buckets anywhere-caches create - create Anywhere Cache
instances for a bucket
SYNOPSIS
gcloud alpha storage buckets anywhere-caches create URL ZONE [ZONE ...]
[--admission-policy=ADMISSION_POLICY] [--ttl=TTL]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) 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 alpha 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 alpha 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 alpha 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 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.

View file

@ -0,0 +1,42 @@
NAME
gcloud alpha storage buckets anywhere-caches describe - returns details of
Anywhere Cache instance of a bucket
SYNOPSIS
gcloud alpha storage buckets anywhere-caches describe ID [--raw]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) 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 alpha 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 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.

View file

@ -0,0 +1,45 @@
NAME
gcloud alpha storage buckets anywhere-caches disable - disable Anywhere
Cache instances
SYNOPSIS
gcloud alpha storage buckets anywhere-caches disable ID [ID ...]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) 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 alpha 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 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.

View file

@ -0,0 +1,45 @@
NAME
gcloud alpha storage buckets anywhere-caches - manage Cloud Storage
Anywhere Caches
SYNOPSIS
gcloud alpha storage buckets anywhere-caches COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) 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
(ALPHA) Create Anywhere Cache instances for a bucket.
describe
(ALPHA) Returns details of Anywhere Cache instance of a bucket.
disable
(ALPHA) Disable Anywhere Cache instances.
list
(ALPHA) List all Anywhere Cache instances of a bucket.
pause
(ALPHA) Pause Anywhere Cache instances.
resume
(ALPHA) Resume Anywhere Cache instances.
update
(ALPHA) Update Anywhere Cache instances.
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.

View file

@ -0,0 +1,74 @@
NAME
gcloud alpha storage buckets anywhere-caches list - list all Anywhere Cache
instances of a bucket
SYNOPSIS
gcloud alpha storage buckets anywhere-caches list URL [--raw]
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) List all cache instances of this bucket.
EXAMPLES
The following command lists all anywhere cache instances of bucket
gs://my-bucket:
$ gcloud alpha 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 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.

View file

@ -0,0 +1,39 @@
NAME
gcloud alpha storage buckets anywhere-caches pause - pause Anywhere Cache
instances
SYNOPSIS
gcloud alpha storage buckets anywhere-caches pause ID [ID ...]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) 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 alpha 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 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.

View file

@ -0,0 +1,40 @@
NAME
gcloud alpha storage buckets anywhere-caches resume - resume Anywhere Cache
instances
SYNOPSIS
gcloud alpha storage buckets anywhere-caches resume ID [ID ...]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) 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 alpha 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 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.

View file

@ -0,0 +1,57 @@
NAME
gcloud alpha storage buckets anywhere-caches update - update Anywhere Cache
instances
SYNOPSIS
gcloud alpha storage buckets anywhere-caches update ID [ID ...]
[--admission-policy=ADMISSION_POLICY] [--ttl=TTL]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) 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 alpha 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 alpha 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 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.

View file

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