Update details of a single storage volume.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: baremetalsolution2 --scope <scope> projects locations-volumes-patch ...

Required Scalar Argument

<name> (string)
- Output only. The resource name of this Volume. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: projects/{project}/locations/{location}/volumes/{volume}

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

Volume:
  attached: boolean
  auto-grown-size-gib: string
  boot-volume: boolean
  current-size-gib: string
  emergency-size-gib: string
  expire-time: string
  id: string
  instances: [string]
  labels: { string: string }
  max-size-gib: string
  name: string
  notes: string
  originally-requested-size-gib: string
  performance-tier: string
  pod: string
  protocol: string
  remaining-space-gib: string
  requested-size-gib: string
  snapshot-auto-delete-behavior: string
  snapshot-enabled: boolean
  snapshot-reservation-detail:
    reserved-space-gib: string
    reserved-space-percent: integer
    reserved-space-remaining-gib: string
    reserved-space-used-percent: integer
  state: string
  storage-type: string
  workload-profile: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

-r . attached=true
- Output only. Is the Volume attached at at least one instance. This field is a lightweight counterpart of instances field. It is filled in List responses as well.
auto-grown-size-gib=aliquyam
- The size, in GiB, that this storage volume has expanded as a result of an auto grow policy. In the absence of auto-grow, the value is 0.
boot-volume=true
- Output only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN.
current-size-gib=est
- The current size of this storage volume, in GiB, including space reserved for snapshots. This size might be different than the requested size if the storage volume has been configured with auto grow or auto shrink.
emergency-size-gib=sed
- Additional emergency size that was requested for this Volume, in GiB. current_size_gib includes this value.
expire-time=diam
- Output only. Time after which volume will be fully deleted. It is filled only for volumes in COOLOFF state.
id=dolores
- An identifier for the Volume, generated by the backend.
instances=dolores
- Output only. Instances this Volume is attached to. This field is set only in Get requests.
- Each invocation of this argument appends the given value to the array.
labels=key=et
- Labels as key value pairs.
- the value will be associated with the given key
max-size-gib=sed
- Maximum size volume can be expanded to in case of evergency, in GiB.
name=no
- Output only. The resource name of this Volume. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: projects/{project}/locations/{location}/volumes/{volume}
notes=et
- Input only. User-specified notes for new Volume. Used to provision Volumes that require manual intervention.
originally-requested-size-gib=elitr
- Originally requested size, in GiB.
performance-tier=sed
- Immutable. Performance tier of the Volume. Default is SHARED.
pod=no
- Immutable. Pod name. Pod is an independent part of infrastructure. Volume can only be connected to the instances allocated in the same pod.
protocol=nonumy
- Output only. Storage protocol for the Volume.
remaining-space-gib=at
- The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots.
requested-size-gib=sadipscing
- The requested size of this storage volume, in GiB.
snapshot-auto-delete-behavior=aliquyam
- The behavior to use when snapshot reserved space is full.
snapshot-enabled=true
- Whether snapshots are enabled.
snapshot-reservation-detail reserved-space-gib=sadipscing
- The space on this storage volume reserved for snapshots, shown in GiB.
reserved-space-percent=70
- Percent of the total Volume size reserved for snapshot copies. Enabling snapshots requires reserving 20% or more of the storage volume space for snapshots. Maximum reserved space for snapshots is 40%. Setting this field will effectively set snapshot_enabled to true.
reserved-space-remaining-gib=aliquyam
- The amount, in GiB, of available space in this storage volume's reserved snapshot space.
reserved-space-used-percent=54
- The percent of snapshot space on this storage volume actually being used by the snapshot copies. This value might be higher than 100% if the snapshot copies have overflowed into the data portion of the storage volume.
.. state=est
- The state of this storage volume.
storage-type=et
- The storage type for this volume.
workload-profile=sea
- The workload profile for the volume.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

-o out
- out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

-p update-mask=string
- The list of fields to update. The only currently supported fields are: 'labels'

Optional General Properties

The following properties can configure any call, and are not specific to this method.

-p $-xgafv=string
- V1 error format.
-p access-token=string
- OAuth access token.
-p alt=string
- Data format for response.
-p callback=string
- JSONP
-p fields=string
- Selector specifying which fields to include in a partial response.
-p key=string
- API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
-p oauth-token=string
- OAuth 2.0 token for the current user.
-p pretty-print=boolean
- Returns response with indentations and line breaks.
-p quota-user=string
- Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
-p upload-type=string
- Legacy upload protocol for media (e.g. "media", "multipart").
-p upload-protocol=string
- Upload protocol for media (e.g. "raw", "multipart").