Skip to main content

volumes

Overview

Namevolumes
TypeResource
Idgoogle.baremetalsolution.volumes

Fields

NameDatatypeDescription
idstringAn identifier for the Volume, generated by the backend.
namestringOutput 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}
statestringThe state of this storage volume.
autoGrownSizeGibstringThe 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.
snapshotEnabledbooleanWhether snapshots are enabled.
expireTimestringOutput only. Time after which volume will be fully deleted. It is filled only for volumes in COOLOFF state.
requestedSizeGibstringThe requested size of this storage volume, in GiB.
snapshotAutoDeleteBehaviorstringThe behavior to use when snapshot reserved space is full.
instancesarrayOutput only. Instances this Volume is attached to. This field is set only in Get requests.
bootVolumebooleanOutput only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN.
labelsobjectLabels as key value pairs.
storageTypestringThe storage type for this volume.
attachedbooleanOutput 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.
podstringImmutable. Pod name.
emergencySizeGibstringAdditional emergency size that was requested for this Volume, in GiB. current_size_gib includes this value.
workloadProfilestringThe workload profile for the volume.
maxSizeGibstringMaximum size volume can be expanded to in case of evergency, in GiB.
protocolstringOutput only. Storage protocol for the Volume.
snapshotReservationDetailobjectDetails about snapshot space reservation and usage on the storage volume.
notesstringInput only. User-specified notes for new Volume. Used to provision Volumes that require manual intervention.
currentSizeGibstringThe 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.
performanceTierstringImmutable. Performance tier of the Volume. Default is SHARED.
remainingSpaceGibstringThe space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots.
originallyRequestedSizeGibstringOriginally requested size, in GiB.

Methods

NameAccessible byRequired ParamsDescription
getSELECTlocationsId, projectsId, volumesIdGet details of a single storage volume.
listSELECTlocationsId, projectsIdList storage volumes in a given project and location.
_listEXEClocationsId, projectsIdList storage volumes in a given project and location.
evictEXEClocationsId, projectsId, volumesIdSkips volume's cooloff and deletes it now. Volume must be in cooloff state.
patchEXEClocationsId, projectsId, volumesIdUpdate details of a single storage volume.
renameEXEClocationsId, projectsId, volumesIdRenameVolume sets a new name for a volume. Use with caution, previous names become immediately invalidated.
resizeEXEClocationsId, projectsId, volumesIdEmergency Volume resize.