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

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

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.

↳ 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.

↳ 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.

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

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

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.

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

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.

hasSnapshotReservationDetail

clearSnapshotReservationDetail

setSnapshotReservationDetail

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

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

setLabels

Labels as key value pairs.

Parameter
Name
Description
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
Create a Mobile Website
View Site in Mobile | Classic
Share by: