# Google Cloud Net App V1 Client - Class StoragePool (1.12.0)

1.12.0 (latest) 1.11.0 1.10.2 1.9.0 1.8.1 1.7.0 1.6.1 1.4.0 1.3.1 1.2.1 1.1.1 1.0.1 0.3.1 0.2.6 0.1.1 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 \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ name` | `string` Identifier. 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` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` Output only. Create time of the storage pool |
| `↳ description` | `string` Optional. Description of the storage pool |
| `↳ labels` | `array|https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/MapField` Optional. Labels as key value pairs |
| `↳ network` | `string` Required. VPC Network name. Format: projects/{project}/global/networks/{network} |
| `↳ active_directory` | `string` Optional. Specifies the Active Directory to be used for creating a SMB volume. |
| `↳ kms_config` | `string` Optional. Specifies the KMS config to be used for volume encryption. |
| `↳ ldap_enabled` | `bool` Optional. Flag indicating if the pool is NFS LDAP enabled or not. |
| `↳ psa_range` | `string` Optional. This field is not implemented. The values provided in this field are ignored. |
| `↳ encryption_type` | `int` Output only. Specifies the current pool encryption key source. |
| `↳ global_access_allowed` | `bool` Deprecated. Used to allow SO pool to access AD or DNS server from other regions. |
| `↳ allow_auto_tiering` | `bool` Optional. True if the storage pool supports Auto Tiering enabled volumes. Default is false. Auto-tiering can be enabled after storage pool creation but it can't be disabled once enabled. |
| `↳ replica_zone` | `string` Optional. Specifies the replica zone for regional storagePool. |
| `↳ zone` | `string` Optional. Specifies the active zone for regional storagePool. |
| `↳ satisfies_pzs` | `bool` Output only. Reserved for future use |
| `↳ satisfies_pzi` | `bool` Output only. Reserved for future use |
| `↳ custom_performance_enabled` | `bool` Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false |
| `↳ total_throughput_mibps` | `int|string` Optional. Custom Performance Total Throughput of the pool (in MiBps) |
| `↳ total_iops` | `int|string` Optional. Custom Performance Total IOPS of the pool if not provided, it will be calculated based on the total_throughput_mibps |
| `↳ hot_tier_size_gib` | `int|string` Optional. Total hot tier capacity for the Storage Pool. It is applicable only to Flex service level. It should be less than the minimum storage pool size and cannot be more than the current storage pool size. It cannot be decreased once set. |
| `↳ enable_hot_tier_auto_resize` | `bool` Optional. Flag indicating that the hot-tier threshold will be auto-increased by 10% of the hot-tier when it hits 100%. Default is true. The increment will kick in only if the new size after increment is still less than or equal to storage pool size. |
| `↳ qos_type` | `int` Optional. QoS (Quality of Service) Type of the storage pool |
| `↳ available_throughput_mibps` | `float` Output only. Available throughput of the storage pool (in MiB/s). |
| `↳ cold_tier_size_used_gib` | `int|string` Output only. Total cold tier data rounded down to the nearest GiB used by the storage pool. |
| `↳ hot_tier_size_used_gib` | `int|string` Output only. Total hot tier data rounded down to the nearest GiB used by the storage pool. |
| `↳ type` | `int` Optional. Type of the storage pool. This field is used to control whether the pool supports `FILE` based volumes only or `UNIFIED` (both `FILE` and `BLOCK`) volumes. If not specified during creation, it defaults to `FILE`. |
| `↳ mode` | `int` Optional. Mode of the storage pool. This field is used to control whether the user can perform the ONTAP operations on the storage pool using the GCNV ONTAP Mode APIs. If not specified during creation, it defaults to `DEFAULT`. |
| `↳ scale_type` | `int` Optional. The scale type of the storage pool. Defaults to `SCALE_TYPE_DEFAULT` if not specified. |

### getName

Identifier. Name of the storage pool

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setName

Identifier. 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` | Enum of type [ServiceLevel](https://docs.cloud.google.com/php/docs/reference/cloud-netapp/latest/V1.ServiceLevel). |

### setServiceLevel

Required. Service level of the storage pool

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [ServiceLevel](https://docs.cloud.google.com/php/docs/reference/cloud-netapp/latest/V1.ServiceLevel). |

| **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` | Enum of type [State](https://docs.cloud.google.com/php/docs/reference/cloud-netapp/latest/V1.StoragePool.State). |

### setState

Output only. State of the storage pool

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [State](https://docs.cloud.google.com/php/docs/reference/cloud-netapp/latest/V1.StoragePool.State). |

| **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** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasCreateTime

### clearCreateTime

### setCreateTime

Output only. Create time of the storage pool

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getDescription

Optional. Description of the storage pool

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setDescription

Optional. Description of the storage pool

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getLabels

Optional. Labels as key value pairs

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/MapField` |   |

### setLabels

Optional. Labels as key value pairs

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array|https://protobuf.dev/reference/php/api-docs/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

Optional. Specifies the Active Directory to be used for creating a SMB
volume.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setActiveDirectory

Optional. Specifies the Active Directory to be used for creating a SMB
volume.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getKmsConfig

Optional. Specifies the KMS config to be used for volume encryption.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setKmsConfig

Optional. Specifies the KMS config to be used for volume encryption.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getLdapEnabled

Optional. Flag indicating if the pool is NFS LDAP enabled or not.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### setLdapEnabled

Optional. Flag indicating if the pool is NFS LDAP enabled or not.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `bool` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getPsaRange

Optional. This field is not implemented. The values provided in this field
are ignored.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setPsaRange

Optional. This field is not implemented. The values provided in this field
are ignored.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getEncryptionType

Output only. Specifies the current pool encryption key source.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [EncryptionType](https://docs.cloud.google.com/php/docs/reference/cloud-netapp/latest/V1.EncryptionType). |

### setEncryptionType

Output only. Specifies the current pool encryption key source.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [EncryptionType](https://docs.cloud.google.com/php/docs/reference/cloud-netapp/latest/V1.EncryptionType). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getGlobalAccessAllowed

Deprecated. Used to allow SO pool to access AD or DNS server from other
regions.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### hasGlobalAccessAllowed

### clearGlobalAccessAllowed

### setGlobalAccessAllowed

Deprecated. Used to allow SO pool to access AD or DNS server from other
regions.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `bool` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getAllowAutoTiering

Optional. True if the storage pool supports Auto Tiering enabled volumes.

Default is false. Auto-tiering can be enabled after storage pool creation
but it can't be disabled once enabled.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### setAllowAutoTiering

Optional. True if the storage pool supports Auto Tiering enabled volumes.

Default is false. Auto-tiering can be enabled after storage pool creation
but it can't be disabled once enabled.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `bool` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getReplicaZone

Optional. Specifies the replica zone for regional storagePool.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setReplicaZone

Optional. Specifies the replica zone for regional storagePool.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getZone

Optional. Specifies the active zone for regional storagePool.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setZone

Optional. Specifies the active zone for regional storagePool.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getSatisfiesPzs

Output only. Reserved for future use

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### setSatisfiesPzs

Output only. Reserved for future use

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `bool` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getSatisfiesPzi

Output only. Reserved for future use

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### setSatisfiesPzi

Output only. Reserved for future use

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `bool` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getCustomPerformanceEnabled

Optional. True if using Independent Scaling of capacity and performance
(Hyperdisk) By default set to false

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### setCustomPerformanceEnabled

Optional. True if using Independent Scaling of capacity and performance
(Hyperdisk) By default set to false

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `bool` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getTotalThroughputMibps

Optional. Custom Performance Total Throughput of the pool (in MiBps)

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int|string` |   |

### setTotalThroughputMibps

Optional. Custom Performance Total Throughput of the pool (in MiBps)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int|string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getTotalIops

Optional. Custom Performance Total IOPS of the pool
if not provided, it will be calculated based on the total_throughput_mibps

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int|string` |   |

### setTotalIops

Optional. Custom Performance Total IOPS of the pool
if not provided, it will be calculated based on the total_throughput_mibps

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int|string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getHotTierSizeGib

Optional. Total hot tier capacity for the Storage Pool. It is applicable
only to Flex service level. It should be less than the minimum storage pool
size and cannot be more than the current storage pool size. It cannot be
decreased once set.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int|string` |   |

### setHotTierSizeGib

Optional. Total hot tier capacity for the Storage Pool. It is applicable
only to Flex service level. It should be less than the minimum storage pool
size and cannot be more than the current storage pool size. It cannot be
decreased once set.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int|string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getEnableHotTierAutoResize

Optional. Flag indicating that the hot-tier threshold will be
auto-increased by 10% of the hot-tier when it hits 100%. Default is true.

The increment will kick in only if the new size after increment is
still less than or equal to storage pool size.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### hasEnableHotTierAutoResize

### clearEnableHotTierAutoResize

### setEnableHotTierAutoResize

Optional. Flag indicating that the hot-tier threshold will be
auto-increased by 10% of the hot-tier when it hits 100%. Default is true.

The increment will kick in only if the new size after increment is
still less than or equal to storage pool size.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `bool` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getQosType

Optional. QoS (Quality of Service) Type of the storage pool

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [QosType](https://docs.cloud.google.com/php/docs/reference/cloud-netapp/latest/V1.QosType). |

### setQosType

Optional. QoS (Quality of Service) Type of the storage pool

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [QosType](https://docs.cloud.google.com/php/docs/reference/cloud-netapp/latest/V1.QosType). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getAvailableThroughputMibps

Output only. Available throughput of the storage pool (in MiB/s).

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `float` |   |

### setAvailableThroughputMibps

Output only. Available throughput of the storage pool (in MiB/s).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `float` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getColdTierSizeUsedGib

Output only. Total cold tier data rounded down to the nearest GiB used by
the storage pool.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int|string` |   |

### setColdTierSizeUsedGib

Output only. Total cold tier data rounded down to the nearest GiB used by
the storage pool.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int|string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getHotTierSizeUsedGib

Output only. Total hot tier data rounded down to the nearest GiB used by
the storage pool.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int|string` |   |

### setHotTierSizeUsedGib

Output only. Total hot tier data rounded down to the nearest GiB used by
the storage pool.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int|string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getType

Optional. Type of the storage pool. This field is used to control whether
the pool supports `FILE` based volumes only or `UNIFIED` (both `FILE` and
`BLOCK`) volumes. If not specified during creation, it defaults to `FILE`.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` |   |

### hasType

### clearType

### setType

Optional. Type of the storage pool. This field is used to control whether
the pool supports `FILE` based volumes only or `UNIFIED` (both `FILE` and
`BLOCK`) volumes. If not specified during creation, it defaults to `FILE`.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getMode

Optional. Mode of the storage pool. This field is used to control whether
the user can perform the ONTAP operations on the storage pool using the
GCNV ONTAP Mode APIs. If not specified during creation, it defaults to
`DEFAULT`.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` |   |

### hasMode

### clearMode

### setMode

Optional. Mode of the storage pool. This field is used to control whether
the user can perform the ONTAP operations on the storage pool using the
GCNV ONTAP Mode APIs. If not specified during creation, it defaults to
`DEFAULT`.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getScaleType

Optional. The scale type of the storage pool. Defaults to
`SCALE_TYPE_DEFAULT` if not specified.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [ScaleType](https://docs.cloud.google.com/php/docs/reference/cloud-netapp/latest/V1.ScaleType). |

### setScaleType

Optional. The scale type of the storage pool. Defaults to
`SCALE_TYPE_DEFAULT` if not specified.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [ScaleType](https://docs.cloud.google.com/php/docs/reference/cloud-netapp/latest/V1.ScaleType). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |