Reference documentation and code samples for the Google Cloud Net App V1 Client class StoragePool.
StoragePool is a container for volumes with a service level and capacity.
Volumes can be created in a pool of sufficient available capacity. StoragePool capacity is what you are billed for.
Generated from protobuf message google.cloud.netapp.v1.StoragePool
Namespace
Google \ Cloud \ NetApp \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. Name of the storage pool |
↳ service_level |
int
Required. Service level of the storage pool |
↳ capacity_gib |
int|string
Required. Capacity in GIB of the pool |
↳ volume_capacity_gib |
int|string
Output only. Allocated size of all volumes in GIB in the storage pool |
↳ volume_count |
int
Output only. Volume count of the storage pool |
↳ state |
int
Output only. State of the storage pool |
↳ state_details |
string
Output only. State details of the storage pool |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Create time of the storage pool |
↳ description |
string
Description of the storage pool |
↳ labels |
array|Google\Protobuf\Internal\MapField
Labels as key value pairs |
↳ network |
string
Required. VPC Network name. Format: projects/{project}/global/networks/{network} |
↳ active_directory |
string
Specifies the Active Directory to be used for creating a SMB volume. |
↳ kms_config |
string
Specifies the KMS config to be used for volume encryption. |
↳ ldap_enabled |
bool
Flag indicating if the pool is NFS LDAP enabled or not. |
↳ psa_range |
string
Name of the Private Service Access allocated range. If not provided, any available range will be chosen. |
↳ encryption_type |
int
Output only. Specifies the current pool encryption key source. |
↳ global_access_allowed |
bool
Optional. Allows SO pool to access AD or DNS server from other regions. |
getName
Output only. Name of the storage pool
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. Name of the storage pool
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getServiceLevel
Required. Service level of the storage pool
| Returns | |
|---|---|
| Type | Description |
int | |
setServiceLevel
Required. Service level of the storage pool
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCapacityGib
Required. Capacity in GIB of the pool
| Returns | |
|---|---|
| Type | Description |
int|string | |
setCapacityGib
Required. Capacity in GIB of the pool
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getVolumeCapacityGib
Output only. Allocated size of all volumes in GIB in the storage pool
| Returns | |
|---|---|
| Type | Description |
int|string | |
setVolumeCapacityGib
Output only. Allocated size of all volumes in GIB in the storage pool
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getVolumeCount
Output only. Volume count of the storage pool
| Returns | |
|---|---|
| Type | Description |
int | |
setVolumeCount
Output only. Volume count of the storage pool
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. State of the storage pool
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. State of the storage pool
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStateDetails
Output only. State details of the storage pool
| Returns | |
|---|---|
| Type | Description |
string | |
setStateDetails
Output only. State details of the storage pool
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Create time of the storage pool
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Create time of the storage pool
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Description of the storage pool
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Description of the storage pool
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| 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 | |
getNetwork
Required. VPC Network name.
Format: projects/{project}/global/networks/{network}
| Returns | |
|---|---|
| Type | Description |
string | |
setNetwork
Required. VPC Network name.
Format: projects/{project}/global/networks/{network}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getActiveDirectory
Specifies the Active Directory to be used for creating a SMB volume.
| Returns | |
|---|---|
| Type | Description |
string | |
setActiveDirectory
Specifies the Active Directory to be used for creating a SMB volume.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getKmsConfig
Specifies the KMS config to be used for volume encryption.
| Returns | |
|---|---|
| Type | Description |
string | |
setKmsConfig
Specifies the KMS config to be used for volume encryption.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLdapEnabled
Flag indicating if the pool is NFS LDAP enabled or not.
| Returns | |
|---|---|
| Type | Description |
bool | |
setLdapEnabled
Flag indicating if the pool is NFS LDAP enabled or not.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPsaRange
Name of the Private Service Access allocated range. If not provided, any available range will be chosen.
| Returns | |
|---|---|
| Type | Description |
string | |
setPsaRange
Name of the Private Service Access allocated range. If not provided, any available range will be chosen.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEncryptionType
Output only. Specifies the current pool encryption key source.
| Returns | |
|---|---|
| Type | Description |
int | |
setEncryptionType
Output only. Specifies the current pool encryption key source.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getGlobalAccessAllowed
Optional. Allows SO pool to access AD or DNS server from other regions.
| Returns | |
|---|---|
| Type | Description |
bool | |
hasGlobalAccessAllowed
clearGlobalAccessAllowed
setGlobalAccessAllowed
Optional. Allows SO pool to access AD or DNS server from other regions.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |