Google Cloud Bare Metal Solution V2 Client - Class Volume (0.5.2)

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 \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
`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`	`Google\Cloud\BareMetalSolution\V2\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`	`array\|Google\Protobuf\Internal\MapField` Labels as key value pairs.
`↳ 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}

Returns
Type	Description
`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}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getId

An identifier for the Volume, generated by the backend.

Returns
Type	Description
`string`

setId

An identifier for the Volume, generated by the backend.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getStorageType

The storage type for this volume.

Returns
Type	Description
`int`

setStorageType

The storage type for this volume.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getState

The state of this storage volume.

Returns
Type	Description
`int`

setState

The state of this storage volume.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getRequestedSizeGib

The requested size of this storage volume, in GiB.

Returns
Type	Description
`int\|string`

setRequestedSizeGib

The requested size of this storage volume, in GiB.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getOriginallyRequestedSizeGib

Originally requested size, in GiB.

Returns
Type	Description
`int\|string`

setOriginallyRequestedSizeGib

Originally requested size, in GiB.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$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.

Returns
Type	Description
`int\|string`

setCurrentSizeGib

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getEmergencySizeGib

Additional emergency size that was requested for this Volume, in GiB.

current_size_gib includes this value.

Returns
Type	Description
`int\|string`

setEmergencySizeGib

Additional emergency size that was requested for this Volume, in GiB.

current_size_gib includes this value.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getMaxSizeGib

Maximum size volume can be expanded to in case of evergency, in GiB.

Returns
Type	Description
`int\|string`

setMaxSizeGib

Maximum size volume can be expanded to in case of evergency, in GiB.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$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.

Returns
Type	Description
`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.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getRemainingSpaceGib

The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots.

Returns
Type	Description
`int\|string`

setRemainingSpaceGib

The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getSnapshotReservationDetail

Details about snapshot space reservation and usage on the storage volume.

Returns
Type	Description
`Google\Cloud\BareMetalSolution\V2\Volume\SnapshotReservationDetail\|null`

hasSnapshotReservationDetail

clearSnapshotReservationDetail

setSnapshotReservationDetail

Details about snapshot space reservation and usage on the storage volume.

Parameter
Name	Description
`var`	`Google\Cloud\BareMetalSolution\V2\Volume\SnapshotReservationDetail`

Returns
Type	Description
`$this`

getSnapshotAutoDeleteBehavior

The behavior to use when snapshot reserved space is full.

Returns
Type	Description
`int`

setSnapshotAutoDeleteBehavior

The behavior to use when snapshot reserved space is full.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getLabels

Labels as key value pairs.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

Labels as key value pairs.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getSnapshotEnabled

Whether snapshots are enabled.

Returns
Type	Description
`bool`

setSnapshotEnabled

Whether snapshots are enabled.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getPod

Immutable. Pod name.

Returns
Type	Description
`string`

setPod

Immutable. Pod name.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getProtocol

Output only. Storage protocol for the Volume.

Returns
Type	Description
`int`

setProtocol

Output only. Storage protocol for the Volume.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getBootVolume

Output only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN.

Returns
Type	Description
`bool`

setBootVolume

Output only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getPerformanceTier

Immutable. Performance tier of the Volume.

Default is SHARED.

Returns
Type	Description
`int`

setPerformanceTier

Immutable. Performance tier of the Volume.

Default is SHARED.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getNotes

Input only. User-specified notes for new Volume.

Used to provision Volumes that require manual intervention.

Returns
Type	Description
`string`

setNotes

Input only. User-specified notes for new Volume.

Used to provision Volumes that require manual intervention.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getWorkloadProfile

The workload profile for the volume.

Returns
Type	Description
`int`

setWorkloadProfile

The workload profile for the volume.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getExpireTime

Output only. Time after which volume will be fully deleted.

It is filled only for volumes in COOLOFF state.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasExpireTime

clearExpireTime

setExpireTime

Output only. Time after which volume will be fully deleted.

It is filled only for volumes in COOLOFF state.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getInstances

Output only. Instances this Volume is attached to.

This field is set only in Get requests.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setInstances

Output only. Instances this Volume is attached to.

This field is set only in Get requests.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$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.

Returns
Type	Description
`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.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`