Reference documentation and code samples for the Google Cloud Bare Metal Solution V2 Client class Volume.
A storage volume.
Generated from protobuf message google.cloud.baremetalsolution.v2.Volume
Namespace
Google \ Cloud \ BareMetalSolution \ V2Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ 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}
↳ id
string
An identifier for the Volume
, generated by the backend.
↳ storage_type
int
The storage type for this volume.
↳ state
int
The state of this storage volume.
↳ requested_size_gib
int|string
The requested size of this storage volume, in GiB.
↳ originally_requested_size_gib
int|string
Originally requested size, in GiB.
↳ current_size_gib
int|string
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
int|string
Additional emergency size that was requested for this Volume, in GiB. current_size_gib includes this value.
↳ max_size_gib
int|string
Maximum size volume can be expanded to in case of evergency, in GiB.
↳ auto_grown_size_gib
int|string
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.
↳ remaining_space_gib
int|string
The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots.
↳ snapshot_reservation_detail
Volume\SnapshotReservationDetail
Details about snapshot space reservation and usage on the storage volume.
↳ snapshot_auto_delete_behavior
int
The behavior to use when snapshot reserved space is full.
↳ labels
↳ snapshot_enabled
bool
Whether snapshots are enabled.
↳ pod
string
Immutable. Pod name.
↳ protocol
int
Output only. Storage protocol for the Volume.
↳ boot_volume
bool
Output only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN.
↳ performance_tier
int
Immutable. Performance tier of the Volume. Default is SHARED.
↳ notes
string
Input only. User-specified notes for new Volume. Used to provision Volumes that require manual intervention.
↳ workload_profile
int
The workload profile for the volume.
↳ expire_time
Google\Protobuf\Timestamp
Output only. Time after which volume will be fully deleted. It is filled only for volumes in COOLOFF state.
↳ instances
array
Output only. Instances this Volume is attached to. This field is set only in Get requests.
↳ attached
bool
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.
getName
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}
string
setName
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}
var
string
$this
getId
An identifier for the Volume
, generated by the backend.
string
setId
An identifier for the Volume
, generated by the backend.
var
string
$this
getStorageType
The storage type for this volume.
int
setStorageType
The storage type for this volume.
var
int
$this
getState
The state of this storage volume.
int
setState
The state of this storage volume.
var
int
$this
getRequestedSizeGib
The requested size of this storage volume, in GiB.
int|string
setRequestedSizeGib
The requested size of this storage volume, in GiB.
var
int|string
$this
getOriginallyRequestedSizeGib
Originally requested size, in GiB.
int|string
setOriginallyRequestedSizeGib
Originally requested size, in GiB.
var
int|string
$this
getCurrentSizeGib
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.
int|string
setCurrentSizeGib
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.
var
int|string
$this
getEmergencySizeGib
Additional emergency size that was requested for this Volume, in GiB.
current_size_gib includes this value.
int|string
setEmergencySizeGib
Additional emergency size that was requested for this Volume, in GiB.
current_size_gib includes this value.
var
int|string
$this
getMaxSizeGib
Maximum size volume can be expanded to in case of evergency, in GiB.
int|string
setMaxSizeGib
Maximum size volume can be expanded to in case of evergency, in GiB.
var
int|string
$this
getAutoGrownSizeGib
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.
int|string
setAutoGrownSizeGib
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.
var
int|string
$this
getRemainingSpaceGib
The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots.
int|string
setRemainingSpaceGib
The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots.
var
int|string
$this
getSnapshotReservationDetail
Details about snapshot space reservation and usage on the storage volume.
hasSnapshotReservationDetail
clearSnapshotReservationDetail
setSnapshotReservationDetail
Details about snapshot space reservation and usage on the storage volume.
$this
getSnapshotAutoDeleteBehavior
The behavior to use when snapshot reserved space is full.
int
setSnapshotAutoDeleteBehavior
The behavior to use when snapshot reserved space is full.
var
int
$this
getLabels
Labels as key value pairs.
setLabels
Labels as key value pairs.
$this
getSnapshotEnabled
Whether snapshots are enabled.
bool
setSnapshotEnabled
Whether snapshots are enabled.
var
bool
$this
getPod
Immutable. Pod name.
string
setPod
Immutable. Pod name.
var
string
$this
getProtocol
Output only. Storage protocol for the Volume.
int
setProtocol
Output only. Storage protocol for the Volume.
var
int
$this
getBootVolume
Output only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN.
bool
setBootVolume
Output only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN.
var
bool
$this
getPerformanceTier
Immutable. Performance tier of the Volume.
Default is SHARED.
int
setPerformanceTier
Immutable. Performance tier of the Volume.
Default is SHARED.
var
int
$this
getNotes
Input only. User-specified notes for new Volume.
Used to provision Volumes that require manual intervention.
string
setNotes
Input only. User-specified notes for new Volume.
Used to provision Volumes that require manual intervention.
var
string
$this
getWorkloadProfile
The workload profile for the volume.
int
setWorkloadProfile
The workload profile for the volume.
var
int
$this
getExpireTime
Output only. Time after which volume will be fully deleted.
It is filled only for volumes in COOLOFF state.
hasExpireTime
clearExpireTime
setExpireTime
Output only. Time after which volume will be fully deleted.
It is filled only for volumes in COOLOFF state.
$this
getInstances
Output only. Instances this Volume is attached to.
This field is set only in Get requests.
setInstances
Output only. Instances this Volume is attached to.
This field is set only in Get requests.
var
string[]
$this
getAttached
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.
bool
setAttached
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.
var
bool
$this
