imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-18 14:56:05 +00:00
Code Activity

gcloud: Wed Aug 3 09:18:38 UTC 2022

Browse source
This commit is contained in:
Automated 2022-08-03 09:18:38 +00:00
parent 3513fd1c11
commit 3b2f526372
Failed to extract signature
151 changed files with 4150 additions and 308 deletions
Download patch file Download diff file Expand all files Collapse all files

82
gcloud/alpha/storage/buckets/create Normal file
View file

@ -0,0 +1,82 @@
NAME
gcloud alpha storage buckets create - create buckets for storing objects
SYNOPSIS
gcloud alpha storage buckets create URL
[--default-encryption-key=DEFAULT_ENCRYPTION_KEY,
-k DEFAULT_ENCRYPTION_KEY]
[--default-storage-class=DEFAULT_STORAGE_CLASS,
-c DEFAULT_STORAGE_CLASS, -s DEFAULT_STORAGE_CLASS]
[--location=LOCATION, -l LOCATION] [--pap, --public-access-prevention]
[--retention-period=RETENTION_PERIOD]
[--[no-]uniform-bucket-level-access, -b] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Create a new bucket.
EXAMPLES
The following command creates a Cloud Storage bucket named my-bucket:
$ gcloud alpha storage buckets create gs://my-bucket
The following command creates a bucket with the nearline default storage
class (https://cloud.google.com/storage/docs/storage-classes) in the asia
location (https://cloud.google.com/storage/docs/locations):
$ gcloud alpha storage buckets create gs://my-bucket \
--default-storage-class=nearline --location=asia
POSITIONAL ARGUMENTS
URL
The URL of the bucket to create.
FLAGS
--default-encryption-key=DEFAULT_ENCRYPTION_KEY, -k DEFAULT_ENCRYPTION_KEY
Set the default KMS key using the full path to the key, which has the
following form:
projects/[project-id]/locations/[location]/keyRings/[key-ring]/cryptoKeys/[my-key].
--default-storage-class=DEFAULT_STORAGE_CLASS, -c DEFAULT_STORAGE_CLASS, -s DEFAULT_STORAGE_CLASS
Default storage class
(https://cloud.google.com/storage/docs/storage-classes) for the bucket.
If not specified, the default storage class used by Cloud Storage is
"Standard".
--location=LOCATION, -l LOCATION
Location (https://cloud.google.com/storage/docs/locations) for the
bucket. If not specified, the location used by Cloud Storage is us. A
bucket's location cannot be changed after creation.
--pap, --public-access-prevention
Sets public access prevention to "enforced". For details on how exactly
public access is blocked, see:
http://cloud/storage/docs/public-access-prevention
--retention-period=RETENTION_PERIOD
Minimum retention period
(https://cloud.google.com/storage/docs/bucket-lock#retention-periods)
for objects stored in the bucket, for example
--retention-period=1Y1M1D5S. Objects added to the bucket cannot be
deleted until they've been stored for the specified length of time.
Default is no retention period. Only available for Cloud Storage using
the JSON API.
--[no-]uniform-bucket-level-access, -b
Turns on uniform bucket-level access setting. Default is False. Use
--uniform-bucket-level-access to enable and
--no-uniform-bucket-level-access to disable.
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.

45
gcloud/alpha/storage/buckets/delete Normal file
View file

@ -0,0 +1,45 @@
NAME
gcloud alpha storage buckets delete - deletes Cloud Storage buckets
SYNOPSIS
gcloud alpha storage buckets delete URLS [URLS ...]
[--continue-on-error, -c] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Deletes one or more Cloud Storage buckets.
EXAMPLES
Delete a Google Cloud Storage bucket named "my-bucket":
$ *gcloud alpha storage buckets delete* gs://my-bucket
Delete two buckets:
$ *gcloud alpha storage buckets delete* gs://my-bucket \
gs://my-other-bucket
POSITIONAL ARGUMENTS
URLS [URLS ...]
Specifies the URLs of the buckets to delete.
FLAGS
--continue-on-error, -c
If any operations are unsuccessful, the command will exit with a
non-zero exit status after completing the remaining operations. This
flag takes effect only in sequential execution mode (i.e. processor and
thread count are set to 1). Parallelism is default.
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.

37
gcloud/alpha/storage/buckets/describe Normal file
View file

@ -0,0 +1,37 @@
NAME
gcloud alpha storage buckets describe - describes Cloud Storage buckets
SYNOPSIS
gcloud alpha storage buckets describe URL [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Describe a Cloud Storage bucket.
EXAMPLES
Describe a Google Cloud Storage bucket named "my-bucket":
$ gcloud alpha storage buckets describe gs://my-bucket
Desribe bucket with JSON formatting, only returning the "name" key:
$ gcloud alpha storage buckets describe gs://my-bucket \
--format=json(name)
POSITIONAL ARGUMENTS
URL
Specifies URL of bucket to describe.
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.

38
gcloud/alpha/storage/buckets/help Normal file
View file

@ -0,0 +1,38 @@
NAME
gcloud alpha storage buckets - manage Cloud Storage buckets
SYNOPSIS
gcloud alpha storage buckets GROUP | COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Manage Cloud Storage buckets.
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 buckets for storing objects.
delete
(ALPHA) Deletes Cloud Storage buckets.
describe
(ALPHA) Describes Cloud Storage buckets.
list
(ALPHA) Lists Cloud Storage buckets.
update
(ALPHA) Update bucket settings.
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.

74
gcloud/alpha/storage/buckets/list Normal file
View file

@ -0,0 +1,74 @@
NAME
gcloud alpha storage buckets list - lists Cloud Storage buckets
SYNOPSIS
gcloud alpha storage buckets list [URLS ...] [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) List Cloud Storage buckets.
EXAMPLES
List all Google Cloud Storage buckets in default project:
$ gcloud alpha storage buckets list
List buckets beginning with "b":
$ gcloud alpha storage buckets list gs://b*
List buckets with JSON formatting, only returning the "name" key:
$ gcloud alpha storage buckets list --format="json(name)"
POSITIONAL ARGUMENTS
[URLS ...]
Specifies URL of buckets to List.
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.

223
gcloud/alpha/storage/buckets/update Normal file
View file

@ -0,0 +1,223 @@
NAME
gcloud alpha storage buckets update - update bucket settings
SYNOPSIS
gcloud alpha storage buckets update URL [URL ...] [--clear-cors]
[--clear-default-encryption-key] [--clear-lifecycle]
[--clear-log-bucket] [--clear-log-object-prefix]
[--clear-pap, --clear-public-access-prevention]
[--clear-retention-period] [--clear-web-error-page]
[--clear-web-main-page-suffix] [--continue-on-error, -c]
[--cors-file=CORS_FILE]
[--default-encryption-key=DEFAULT_ENCRYPTION_KEY]
[--[no-]default-event-based-hold]
[--default-storage-class=DEFAULT_STORAGE_CLASS]
[--lifecycle-file=LIFECYCLE_FILE] [--[no-]lock-retention-period]
[--log-bucket=LOG_BUCKET] [--log-object-prefix=LOG_OBJECT_PREFIX]
[--[no-]pap, --[no-]public-access-prevention] [--[no-]requester-pays]
[--retention-period=RETENTION_PERIOD]
[--[no-]uniform-bucket-level-access] [--[no-]versioning]
[--web-error-page=WEB_ERROR_PAGE]
[--web-main-page-suffix=WEB_MAIN_PAGE_SUFFIX]
[--clear-labels | --labels-file=LABELS_FILE
| --remove-labels=[LABEL_KEYS,...]
--update-labels=[LABEL_KEYS_AND_VALUES,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Update a bucket.
EXAMPLES
The following command updates the retention period of a Cloud Storage
bucket named "my-bucket" to one year and thirty-six minutes:
$ gcloud alpha storage buckets update gs://my-bucket \
--retention-period=1y36m
The following command clears the retention period of a bucket:
$ gcloud alpha storage buckets update gs://my-bucket \
--clear-retention-period
POSITIONAL ARGUMENTS
URL [URL ...]
The URLs of the buckets to update.
FLAGS
--clear-cors
Clears the bucket's CORS settings.
--clear-default-encryption-key
Clears the bucket's default encryption key.
--clear-lifecycle
Removes all lifecycle configuration for the bucket.
--clear-log-bucket
Clears logging bucket receiving the usage current bucket's data.
--clear-log-object-prefix
Clears prefix used to determine what usage data to send to logging
bucket.
--clear-pap, --clear-public-access-prevention
Unsets the public access prevention setting on a bucket.
--clear-retention-period
Clears the object retention period for a bucket.
--clear-web-error-page
Clear website error page if bucket is hosting website.
--clear-web-main-page-suffix
Clear website main page suffix if bucket is hosting website.
--continue-on-error, -c
If any operations are unsuccessful, the command will exit with a
non-zero exit status after completing the remaining operations. This
flag takes effect only in sequential execution mode (i.e. processor and
thread count are set to 1). Parallelism is default.
--cors-file=CORS_FILE
Sets the Cross-Origin Resource Sharing (CORS) configuration on a
bucket. An example CORS JSON document looks like the following:
[
{
"origin": ["http://origin1.example.com"],
"responseHeader": ["Content-Type"],
"method": ["GET"],
"maxAgeSeconds": 3600
}
]
For more information about supported endpoints for CORS, see [Cloud
Storage CORS support]
(https://cloud.google.com/storage/docs/cross-origin#server-side-support).
--default-encryption-key=DEFAULT_ENCRYPTION_KEY
Set the default KMS key for the bucket.
--[no-]default-event-based-hold
Sets the default value for an event-based hold on the bucket. By
setting the default event-based hold on a bucket, newly-created objects
inherit that value as their event-based hold (it is not applied
retroactively). Use --default-event-based-hold to enable and
--no-default-event-based-hold to disable.
--default-storage-class=DEFAULT_STORAGE_CLASS
Sets the default storage class for the bucket.
--lifecycle-file=LIFECYCLE_FILE
Sets the lifecycle management configuration on a bucket. For example,
The following lifecycle management configuration JSON document
specifies that all objects in this bucket that are more than 365 days
old are deleted automatically:
{
"rule":
[
{
"action": {"type": "Delete"},
"condition": {"age": 365}
}
]
}
--[no-]lock-retention-period
Locks an unlocked retention policy on the buckets. Caution: A locked
retention policy cannot be removed from a bucket or reduced in
duration. Once locked, deleting the bucket is the only way to "remove"
a retention policy. Use --lock-retention-period to enable and
--no-lock-retention-period to disable.
--log-bucket=LOG_BUCKET
Enables usage logging of the bucket, outputting log files to the
specified logging_bucket in this flag. Cloud Storage doesn't validate
the existence of the bucket receiving logs. In addition to enabling
logging on your bucket, you will also need to grant
cloud-storage-analytics@google.com write access to the log bucket.
--log-object-prefix=LOG_OBJECT_PREFIX
Specifies the object prefix for logging activity to the log bucket. The
default prefix is the bucket name. All read and write activity to
objects in the bucket will be logged for objects matching the prefix.
--[no-]pap, --[no-]public-access-prevention
If True, sets public access prevention to "enforced". If False, sets
public access prevention to "inherited". For details on how exactly
public access is blocked, see:
http://cloud/storage/docs/public-access-prevention. Use
--public-access-prevention to enable and --no-public-access-prevention
to disable.
--[no-]requester-pays
Allows you to configure a Cloud Storage bucket so that the requester
pays all costs related to accessing the bucket and its objects. Use
--requester-pays to enable and --no-requester-pays to disable.
--retention-period=RETENTION_PERIOD
Minimum retention period
(https://cloud.google.com/storage/docs/bucket-lock#retention-periods)
for objects stored in the bucket, for example
--retention-period=1Y1M1D5S. Objects added to the bucket cannot be
deleted until they've been stored for the specified length of time.
Default is no retention period. Only available for Cloud Storage using
the JSON API.
--[no-]uniform-bucket-level-access
Enables or disables uniform bucket-level access
(https://cloud.google.com/storage/docs/bucket-policy-only) for the
buckets. Use --uniform-bucket-level-access to enable and
--no-uniform-bucket-level-access to disable.
--[no-]versioning
Allows you to configure a Cloud Storage bucket to keep old versions of
objects. Use --versioning to enable and --no-versioning to disable.
--web-error-page=WEB_ERROR_PAGE
Cloud Storage allows you to configure a bucket to behave like a static
website. A subsequent GET bucket request through a custom domain for a
non-existent object serves the specified error page instead of the
standard Cloud Storage error.
--web-main-page-suffix=WEB_MAIN_PAGE_SUFFIX
Cloud Storage allows you to configure a bucket to behave like a static
website. A subsequent GET bucket request through a custom domain serves
the specified "main" page instead of performing the usual bucket
listing.
At most one of these can be specified:
--clear-labels
Clear all labels associated with a bucket.
--labels-file=LABELS_FILE
Sets the label configuration for the bucket. An example label JSON
document looks like the following:
{
"your_label_key": "your_label_value",
"your_other_label_key": "your_other_label_value"
}
--remove-labels=[LABEL_KEYS,...]
Remove labels by their key names.
--update-labels=[LABEL_KEYS_AND_VALUES,...]
Add or update labels. Example:
--update-labels=key1=value1,key2=value2
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.

69
gcloud/alpha/storage/cat Normal file
View file

@ -0,0 +1,69 @@
NAME
gcloud alpha storage cat - outputs the contents of one or more URLs to
stdout
SYNOPSIS
gcloud alpha storage cat URL [URL ...] [--display-url, -d]
[--range=RANGE, -r RANGE] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) The cat command outputs the contents of one or more URLs to stdout.
While the cat command does not compute a checksum, it is otherwise
equivalent to doing:
$ gcloud alpha storage cp url... -
(The final '-' causes gcloud to stream the output to stdout.)
EXAMPLES
The following command writes all text files in a bucket to stdout:
$ gcloud alpha storage cat gs://bucket/*.txt
The following command outputs a short header describing file.txt, along
with its contents:
$ gcloud alpha storage cat -d gs://my-bucket/file.txt
The following command outputs bytes 256-939 of file.txt:
$ gcloud alpha storage cat -r 256-939 gs://my-bucket/file.txt
The following command outputs the last 5 bytes of file.txt:
$ gcloud alpha storage cat -r -5 gs://my-bucket/file.txt
POSITIONAL ARGUMENTS
URL [URL ...]
The url of objects to list.
FLAGS
--display-url, -d
Prints the header before each object.
--range=RANGE, -r RANGE
Causes gcloud storage to output just the specified byte range of the
object. In a case where "start" = 'x', and "end" = 'y', ranges take the
form: x-y (e.g., -r 256-5939), x- (e.g., -r 256-), -y (e.g., -r -5)
When offsets start at 0, x-y means to return bytes x through y
(inclusive), x- means to return bytes x through the end of the object,
and -y changes the role of y. If -y is present, then it returns the
last y bytes of the object.
If the bytes are out of range of the object, then nothing is printed
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.

12
gcloud/alpha/storage/cp
View file

@ -8,7 +8,7 @@ SYNOPSIS
[--content-encoding=CONTENT_ENCODING]
[--content-language=CONTENT_LANGUAGE] [--content-md5=MD5_DIGEST]
[--content-type=CONTENT_TYPE] [--continue-on-error, -c]
[--custom-time=CUSTOM_TIME] [--do-not-decompress]
[--custom-time=CUSTOM_TIME] [--daisy-chain, -D] [--do-not-decompress]
[--if-generation-match=GENERATION]
[--if-metageneration-match=METAGENERATION] [--ignore-symlinks]
[--manifest-path=MANIFEST_PATH, -L MANIFEST_PATH]
@ -104,6 +104,16 @@ FLAGS
--custom-time=CUSTOM_TIME
Custom time for Google Cloud Storage objects in RFC 3339 format.
--daisy-chain, -D
Copy in "daisy chain" mode, which means copying an object by first
downloading it to the machine where the command is run, then uploading
it to the destination bucket. The default mode is a "copy in the
cloud," where data is copied without uploading or downloading. During a
copy in the cloud, a source composite object remains composite at its
destination. However, you can use daisy chain mode to change a
composite object into a non-composite object. Note: Daisy chain mode is
automatically used when copying between providers.
--do-not-decompress
Do not automatically decompress downloaded gzip files.

16
gcloud/alpha/storage/help
View file

@ -17,9 +17,21 @@ GCLOUD WIDE FLAGS
Run $ gcloud help for details.
GROUPS
GROUP is one of the following:
buckets
(ALPHA) Manage Cloud Storage buckets.
objects
(ALPHA) Manage Cloud Storage objects.
COMMANDS
COMMAND is one of the following:
cat
(ALPHA) Outputs the contents of one or more URLs to stdout.
cp
(ALPHA) Upload, download, and copy Cloud Storage objects.
@ -29,6 +41,10 @@ COMMANDS
rm
(ALPHA) Delete objects and buckets.
service-agent
(ALPHA) Manage a project's Cloud Storage service agent, which is used
to perform Cloud KMS operations.
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct

55
gcloud/alpha/storage/objects/describe Normal file
View file

@ -0,0 +1,55 @@
NAME
gcloud alpha storage objects describe - describe a Cloud Storage object
SYNOPSIS
gcloud alpha storage objects describe URL
[--decryption-keys=[DECRYPTION_KEY,...]]
[--encryption-key=ENCRYPTION_KEY] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Describe a Cloud Storage object.
EXAMPLES
Describe a Google Cloud Storage object with the url
"gs://bucket/my-object":
$ gcloud alpha storage objects describe gs://bucket/my-object
Desribe object with JSON formatting, only returning the "name" key:
$ gcloud alpha storage objects describe gs://bucket/my-object \
--format=json(name)
POSITIONAL ARGUMENTS
URL
Specifies URL of object to describe.
FLAGS
--decryption-keys=[DECRYPTION_KEY,...]
A comma separated list of customer-supplied encryption keys (RFC 4648
section 4 base64-encoded AES256 strings) that will be used to decrypt
Google Cloud Storage objects. Data encrypted with a customer-managed
encryption key (CMEK) is decrypted automatically, so CMEKs do not need
to be listed here.
--encryption-key=ENCRYPTION_KEY
A customer-supplied encryption key (An RFC 4648 section 4
base64-encoded AES256 string), or customer-managed encryption key of
the form
projects/{project}/locations/{location}/keyRings/{key-ring}/cryptoKeys/{crypto-key}.
This key will be used for all data written to Google Cloud Storage.
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.

32
gcloud/alpha/storage/objects/help Normal file
View file

@ -0,0 +1,32 @@
NAME
gcloud alpha storage objects - manage Cloud Storage objects
SYNOPSIS
gcloud alpha storage objects COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Manage Cloud Storage objects.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
describe
(ALPHA) Describe a Cloud Storage object.
list
(ALPHA) Lists Cloud Storage objects.
update
(ALPHA) Update Cloud Storage objects.
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.

96
gcloud/alpha/storage/objects/list Normal file
View file

@ -0,0 +1,96 @@
NAME
gcloud alpha storage objects list - lists Cloud Storage objects
SYNOPSIS
gcloud alpha storage objects list URLS [URLS ...]
[--decryption-keys=[DECRYPTION_KEY,...]]
[--encryption-key=ENCRYPTION_KEY] [--filter=EXPRESSION] [--limit=LIMIT]
[--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) List Cloud Storage objects.
Bucket URLs like "gs://bucket" will match all the objects inside a bucket,
but "gs://b" will error because it matches a list of buckets.
EXAMPLES
List all objects in bucket "my-bucket":
$ gcloud alpha storage objects list gs://my-bucket
List all objects in bucket beginning with "o":
$ gcloud alpha storage objects list gs://my-bucket/o*
List all objects in bucket with JSON formatting, only returning the value
of the "name" metadata field:
$ gcloud alpha storage objects list gs://my-bucket \
--format="json(name)"
POSITIONAL ARGUMENTS
URLS [URLS ...]
Specifies URL of objects to list.
FLAGS
--decryption-keys=[DECRYPTION_KEY,...]
A comma separated list of customer-supplied encryption keys (RFC 4648
section 4 base64-encoded AES256 strings) that will be used to decrypt
Google Cloud Storage objects. Data encrypted with a customer-managed
encryption key (CMEK) is decrypted automatically, so CMEKs do not need
to be listed here.
--encryption-key=ENCRYPTION_KEY
A customer-supplied encryption key (An RFC 4648 section 4
base64-encoded AES256 string), or customer-managed encryption key of
the form
projects/{project}/locations/{location}/keyRings/{key-ring}/cryptoKeys/{crypto-key}.
This key will be used for all data written to Google Cloud Storage.
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.

196
gcloud/alpha/storage/objects/update Normal file
View file

@ -0,0 +1,196 @@
NAME
gcloud alpha storage objects update - update Cloud Storage objects
SYNOPSIS
gcloud alpha storage objects update [URL ...]
[--cache-control=CACHE_CONTROL] [--clear-cache-control]
[--clear-content-disposition] [--clear-content-encoding]
[--clear-content-language] [--clear-content-md5] [--clear-content-type]
[--clear-custom-time] [--clear-encryption-key]
[--content-disposition=CONTENT_DISPOSITION]
[--content-encoding=CONTENT_ENCODING]
[--content-language=CONTENT_LANGUAGE] [--content-md5=MD5_DIGEST]
[--content-type=CONTENT_TYPE] [--continue-on-error, -c]
[--custom-time=CUSTOM_TIME] [--decryption-keys=[DECRYPTION_KEY,...]]
[--encryption-key=ENCRYPTION_KEY] [--[no-]event-based-hold]
[--if-generation-match=GENERATION]
[--if-metageneration-match=METAGENERATION] [--preserve-acl, -p]
[--read-paths-from-stdin, -I] [--recursive, -R, -r]
[--storage-class=STORAGE_CLASS, -s STORAGE_CLASS]
[--[no-]temporary-hold]
[--clear-custom-metadata
| --custom-metadata=[CUSTOM_METADATA_KEYS_AND_VALUES,...]
| --remove-custom-metadata=[METADATA_KEYS,...]
--update-custom-metadata=[CUSTOM_METADATA_KEYS_AND_VALUES,...]]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Update Cloud Storage objects.
EXAMPLES
Update a Google Cloud Storage object's custom-metadata:
$ *gcloud alpha storage objects update* gs://bucket/my-object \
--custom-metadata=key1=value1,key2=value2
Set a temporary hold on JPG images:
$ *gcloud alpha storage objects update* gs://bucket/*.jpg \
--temporary-hold
You can also provide a precondition on an object's metageneration in
order to avoid potential race conditions:
$ *gcloud alpha storage objects update* gs://bucket/*.jpg \
--temporary-hold --if-metageneration-match=123456789
POSITIONAL ARGUMENTS
[URL ...]
Specifies URLs of objects to update.
FLAGS
--cache-control=CACHE_CONTROL
How caches should handle requests and responses.
--clear-cache-control
Clears object cache control.
--clear-content-disposition
Clears object content disposition.
--clear-content-encoding
Clears content encoding.
--clear-content-language
Clears object content language.
--clear-content-md5
Clears object content MD5.
--clear-content-type
Clears object content type.
--clear-custom-time
Clears object custom time.
--clear-encryption-key
Clears encryption key associated with an object.
--content-disposition=CONTENT_DISPOSITION
How content should be displayed.
--content-encoding=CONTENT_ENCODING
How content is encoded (e.g. gzip).
--content-language=CONTENT_LANGUAGE
Content's language (e.g. en signifies "English").
--content-md5=MD5_DIGEST
Manually specified MD5 hash digest for the contents of an uploaded
file. This flag cannot be used when uploading multiple files. The
custom digest is used by the cloud provider for validation.
--content-type=CONTENT_TYPE
Type of data contained in the object (e.g. text/html).
--continue-on-error, -c
If any operations are unsuccessful, the command will exit with a
non-zero exit status after completing the remaining operations. This
flag takes effect only in sequential execution mode (i.e. processor and
thread count are set to 1). Parallelism is default.
--custom-time=CUSTOM_TIME
Custom time for Google Cloud Storage objects in RFC 3339 format.
--decryption-keys=[DECRYPTION_KEY,...]
A comma separated list of customer-supplied encryption keys (RFC 4648
section 4 base64-encoded AES256 strings) that will be used to decrypt
Google Cloud Storage objects. Data encrypted with a customer-managed
encryption key (CMEK) is decrypted automatically, so CMEKs do not need
to be listed here.
--encryption-key=ENCRYPTION_KEY
A customer-supplied encryption key (An RFC 4648 section 4
base64-encoded AES256 string), or customer-managed encryption key of
the form
projects/{project}/locations/{location}/keyRings/{key-ring}/cryptoKeys/{crypto-key}.
This key will be used for all data written to Google Cloud Storage.
--[no-]event-based-hold
Enables or disables an event-based hold on objects. Use
--event-based-hold to enable and --no-event-based-hold to disable.
--if-generation-match=GENERATION
Execute only if the generation matches the generation of the requested
object.
--if-metageneration-match=METAGENERATION
Execute only if the metageneration matches the metageneration of the
requested object.
--preserve-acl, -p
Preserves ACLs when copying in the cloud. This feature is supported for
only Google Cloud Storage and requires OWNER access to all copied
objects. To use the destination bucket's default policy (necessary for
uniform bucket-level access), use --no-preserve-acl. Enabled by
default, use -p to disable.
--read-paths-from-stdin, -I
Read the list of objects to update from stdin. No need to enter a
source argument if this flag is present. Example: "storage objects
update -I --content-type=new-type"
--recursive, -R, -r
Recursively update objects under any buckets or directories that match
the URL expression.
--storage-class=STORAGE_CLASS, -s STORAGE_CLASS
Specify the storage class of the object. Triggers a rewrite
ofunderlying object data.
--[no-]temporary-hold
Enables or disables a temporary hold on objects. Use --temporary-hold
to enable and --no-temporary-hold to disable.
At most one of these can be specified:
--clear-custom-metadata
Clears all custom metadata on objects. When used with
--preserve-posix, POSIX attributes will still be stored in custom
metadata.
--custom-metadata=[CUSTOM_METADATA_KEYS_AND_VALUES,...]
Sets custom metadata on objects. When used with --preserve-posix,
POSIX attributes are also stored in custom metadata.
Flags that preserve unspecified existing metadata cannot be used with
--custom-metadata or --clear-custom-metadata, but can be specified
together:
--remove-custom-metadata=[METADATA_KEYS,...]
Removes individual custom metadata keys from objects. This flag can
be used with --update-custom-metadata. When used with
--preserve-posix, POSIX attributes specified by this flag are not
preserved.
--update-custom-metadata=[CUSTOM_METADATA_KEYS_AND_VALUES,...]
Adds or sets individual custom metadata key value pairs on objects.
Existing custom metadata not specified with this flag is not
changed. This flag can be used with --remove-custom-metadata. When
keys overlap with those provided by --preserve-posix, values
specified by this flag are used.
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.

50
gcloud/alpha/storage/service-agent Normal file
View file

@ -0,0 +1,50 @@
NAME
gcloud alpha storage service-agent - manage a project's Cloud Storage
service agent, which is used to perform Cloud KMS operations
SYNOPSIS
gcloud alpha storage service-agent [--authorize-cmek=AUTHORIZE_CMEK]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) gcloud alpha storage service-agent displays the Cloud Storage
service agent, which is used to perform Cloud KMS operations against your a
default or supplied project. If the project does not yet have a service
agent, gcloud alpha storage service-agent creates one.
EXAMPLES
To show the service agent for your default project:
$ gcloud alpha storage service-agent
To show the service account for my-project:
$ gcloud alpha storage service-agent --project=my-project
To authorize your default project to use a Cloud KMS key:
$ gcloud alpha storage service-agent \
--authorize-cmek=projects/key-project/locations/us-east1/\
keyRings/key-ring/cryptoKeys/my-key
FLAGS
--authorize-cmek=AUTHORIZE_CMEK
Adds appropriate encrypt/decrypt permissions to the specified Cloud KMS
key. This allows the Cloud Storage service agent to write and read
Cloud KMS-encrypted objects in buckets associated with the service
agent's project.
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.