File: //snap/google-cloud-cli/current/lib/surface/filestore/snapshots/update.yaml
- help_text:
brief: |
Update a Filestore snapshot.
description: |
Update the metadata of a Filestore snapshot.
This command can fail for the following reasons:
* The snapshot specified does not exist.
* The active account does not have permission to update the given
snapshot.
examples: |
The following command updates the Filestore Snapshot named 'my-snapshot' in region
us-central1 to change the description to 'A new description.'
$ {command} my-snapshot --region=us-central1 --description="A new description."
arguments:
params:
- arg_name: snapshot
is_positional: true
help_text: |
Arguments and flags that specify the Filestore snapshot you want to
update.
- group:
mutex: true
required: true
params:
- arg_name: zone
help_text: |
Compute zone (e.g. us-central1-c) for the snapshot.
- arg_name: region
help_text: |
Compute region (e.g. us-central1) for the snapshot.
- arg_name: description
api_field: snapshot.description
help_text: |
Description of the snapshot.
additional_arguments_hook: googlecloudsdk.command_lib.filestore.update_util:UpdateLabelsFlags
response:
modify_response_hooks:
- googlecloudsdk.command_lib.filestore.snapshots.update_util:FormatSnapshotUpdateResponse
async:
collection: file.projects.locations.operations
request:
api_version: v1p1alpha1
display_resource_type: snapshot
collection: file.projects.locations.snapshots
modify_request_hooks:
- googlecloudsdk.command_lib.filestore.snapshots.util:FormatSnapshotAccessRequest
- googlecloudsdk.command_lib.filestore.snapshots.update_util:GetExistingSnapshot
- googlecloudsdk.command_lib.filestore.snapshots.update_util:AddDescription
- googlecloudsdk.command_lib.filestore.snapshots.update_util:UpdateLabels