Compute V1 Client - Class StoragePool (1.18.0)

Reference documentation and code samples for the Compute V1 Client class StoragePool.

Represents a zonal storage pool resource.

Generated from protobuf message google.cloud.compute.v1.StoragePool

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ capacity_provisioning_type string

Provisioning type of the byte capacity of the pool. Check the CapacityProvisioningType enum for the list of possible values.
↳ creation_timestamp string

[Output Only] Creation timestamp in RFC3339 text format.
↳ description string

An optional description of this resource. Provide this property when you create the resource.
↳ id int|string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.
↳ kind string

[Output Only] Type of the resource. Always compute#storagePool for storage pools.
↳ label_fingerprint string

A fingerprint for the labels being applied to this storage pool, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a storage pool.
↳ labels array|Google\Protobuf\Internal\MapField

Labels to apply to this storage pool. These can be later modified by the setLabels method.
↳ name string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
↳ performance_provisioning_type string

Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS. Check the PerformanceProvisioningType enum for the list of possible values.
↳ pool_provisioned_capacity_gb int|string

Size, in GiB, of the storage pool.
↳ pool_provisioned_iops int|string

Provisioned IOPS of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced.
↳ pool_provisioned_throughput int|string

Provisioned throughput of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced or hyperdisk-throughput.
↳ resource_status Google\Cloud\Compute\V1\StoragePoolResourceStatus

[Output Only] Status information for the storage pool resource.
↳ self_link string

[Output Only] Server-defined fully-qualified URL for this resource.
↳ self_link_with_id string

[Output Only] Server-defined URL for this resource's resource id.
↳ state string

[Output Only] The status of storage pool creation. - CREATING: Storage pool is provisioning. storagePool. - FAILED: Storage pool creation failed. - READY: Storage pool is ready for use. - DELETING: Storage pool is deleting. Check the State enum for the list of possible values.
↳ status Google\Cloud\Compute\V1\StoragePoolResourceStatus

[Output Only] Status information for the storage pool resource.
↳ storage_pool_type string

Type of the storage pool.
↳ zone string

[Output Only] URL of the zone where the storage pool resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

getCapacityProvisioningType

Provisioning type of the byte capacity of the pool.

Check the CapacityProvisioningType enum for the list of possible values.

Returns
Type Description
string

hasCapacityProvisioningType

clearCapacityProvisioningType

setCapacityProvisioningType

Provisioning type of the byte capacity of the pool.

Check the CapacityProvisioningType enum for the list of possible values.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Returns
Type Description
string

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

An optional description of this resource. Provide this property when you create the resource.

Returns
Type Description
string

hasDescription

clearDescription

setDescription

An optional description of this resource. Provide this property when you create the resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getId

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Returns
Type Description
int|string

hasId

clearId

setId

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getKind

[Output Only] Type of the resource. Always compute#storagePool for storage pools.

Returns
Type Description
string

hasKind

clearKind

setKind

[Output Only] Type of the resource. Always compute#storagePool for storage pools.

Parameter
Name Description
var string
Returns
Type Description
$this

getLabelFingerprint

A fingerprint for the labels being applied to this storage pool, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a storage pool.

Returns
Type Description
string

hasLabelFingerprint

clearLabelFingerprint

setLabelFingerprint

A fingerprint for the labels being applied to this storage pool, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a storage pool.

Parameter
Name Description
var string
Returns
Type Description
$this

getLabels

Labels to apply to this storage pool. These can be later modified by the setLabels method.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Labels to apply to this storage pool. These can be later modified by the setLabels method.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getName

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Returns
Type Description
string

hasName

clearName

setName

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Parameter
Name Description
var string
Returns
Type Description
$this

getPerformanceProvisioningType

Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS.

Check the PerformanceProvisioningType enum for the list of possible values.

Returns
Type Description
string

hasPerformanceProvisioningType

clearPerformanceProvisioningType

setPerformanceProvisioningType

Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS.

Check the PerformanceProvisioningType enum for the list of possible values.

Parameter
Name Description
var string
Returns
Type Description
$this

getPoolProvisionedCapacityGb

Size, in GiB, of the storage pool.

Returns
Type Description
int|string

hasPoolProvisionedCapacityGb

clearPoolProvisionedCapacityGb

setPoolProvisionedCapacityGb

Size, in GiB, of the storage pool.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getPoolProvisionedIops

Provisioned IOPS of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced.

Returns
Type Description
int|string

hasPoolProvisionedIops

clearPoolProvisionedIops

setPoolProvisionedIops

Provisioned IOPS of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getPoolProvisionedThroughput

Provisioned throughput of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced or hyperdisk-throughput.

Returns
Type Description
int|string

hasPoolProvisionedThroughput

clearPoolProvisionedThroughput

setPoolProvisionedThroughput

Provisioned throughput of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced or hyperdisk-throughput.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getResourceStatus

[Output Only] Status information for the storage pool resource.

Returns
Type Description
Google\Cloud\Compute\V1\StoragePoolResourceStatus|null

hasResourceStatus

clearResourceStatus

setResourceStatus

[Output Only] Status information for the storage pool resource.

Parameter
Name Description
var Google\Cloud\Compute\V1\StoragePoolResourceStatus
Returns
Type Description
$this

getSelfLink

[Output Only] Server-defined fully-qualified URL for this resource.

Returns
Type Description
string

hasSelfLink

clearSelfLink

setSelfLink

[Output Only] Server-defined fully-qualified URL for this resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getSelfLinkWithId

[Output Only] Server-defined URL for this resource's resource id.

Returns
Type Description
string

hasSelfLinkWithId

clearSelfLinkWithId

setSelfLinkWithId

[Output Only] Server-defined URL for this resource's resource id.

Parameter
Name Description
var string
Returns
Type Description
$this

getState

[Output Only] The status of storage pool creation. - CREATING: Storage pool is provisioning. storagePool. - FAILED: Storage pool creation failed. - READY: Storage pool is ready for use. - DELETING: Storage pool is deleting.

Check the State enum for the list of possible values.

Returns
Type Description
string

hasState

clearState

setState

[Output Only] The status of storage pool creation. - CREATING: Storage pool is provisioning. storagePool. - FAILED: Storage pool creation failed. - READY: Storage pool is ready for use. - DELETING: Storage pool is deleting.

Check the State enum for the list of possible values.

Parameter
Name Description
var string
Returns
Type Description
$this

getStatus

[Output Only] Status information for the storage pool resource.

Returns
Type Description
Google\Cloud\Compute\V1\StoragePoolResourceStatus|null

hasStatus

clearStatus

setStatus

[Output Only] Status information for the storage pool resource.

Parameter
Name Description
var Google\Cloud\Compute\V1\StoragePoolResourceStatus
Returns
Type Description
$this

getStoragePoolType

Type of the storage pool.

Returns
Type Description
string

hasStoragePoolType

clearStoragePoolType

setStoragePoolType

Type of the storage pool.

Parameter
Name Description
var string
Returns
Type Description
$this

getZone

[Output Only] URL of the zone where the storage pool resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Returns
Type Description
string

hasZone

clearZone

setZone

[Output Only] URL of the zone where the storage pool resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Parameter
Name Description
var string
Returns
Type Description
$this