# Class StoragePool (0.10.1)

0.10.1 (latest) 0.10.0 0.9.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.24 0.2.0 0.1.0

    StoragePool(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

.. _oneof: <https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields>

| ## Attributes ||
|---|---|
| **Name** | **Description** |
| `name` | `str` Identifier. Name of the storage pool |
| `service_level` | `https://docs.cloud.google.com/python/docs/reference/netapp/latest/google.cloud.netapp_v1.types.ServiceLevel` Required. Service level of the storage pool |
| `capacity_gib` | `int` Required. Capacity in GIB of the pool |
| `volume_capacity_gib` | `int` 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` | `https://docs.cloud.google.com/python/docs/reference/netapp/latest/google.cloud.netapp_v1.types.StoragePool.State` Output only. State of the storage pool |
| `state_details` | `str` Output only. State details of the storage pool |
| `create_time` | `google.protobuf.timestamp_pb2.Timestamp` Output only. Create time of the storage pool |
| `description` | `str` Optional. Description of the storage pool |
| `labels` | `MutableMapping[str, str]` Optional. Labels as key value pairs |
| `network` | `str` Required. VPC Network name. Format: projects/{project}/global/networks/{network} |
| `active_directory` | `str` Optional. Specifies the Active Directory to be used for creating a SMB volume. |
| `kms_config` | `str` 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` | `str` Optional. This field is not implemented. The values provided in this field are ignored. |
| `encryption_type` | `https://docs.cloud.google.com/python/docs/reference/netapp/latest/google.cloud.netapp_v1.types.EncryptionType` 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. This field is a member of `oneof`_ `_global_access_allowed`. |
| `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` | `str` Optional. Specifies the replica zone for regional storagePool. |
| `zone` | `str` 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` Optional. Custom Performance Total Throughput of the pool (in MiBps) |
| `total_iops` | `int` 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` 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. This field is a member of `oneof`_ `_enable_hot_tier_auto_resize`. |
| `qos_type` | `https://docs.cloud.google.com/python/docs/reference/netapp/latest/google.cloud.netapp_v1.types.QosType` 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` Output only. Total cold tier data rounded down to the nearest GiB used by the storage pool. |
| `hot_tier_size_used_gib` | `int` Output only. Total hot tier data rounded down to the nearest GiB used by the storage pool. |
| `type_` | `https://docs.cloud.google.com/python/docs/reference/netapp/latest/google.cloud.netapp_v1.types.StoragePoolType` 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`. This field is a member of `oneof`_ `_type`. |
| `mode` | `https://docs.cloud.google.com/python/docs/reference/netapp/latest/google.cloud.netapp_v1.types.Mode` 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`. This field is a member of `oneof`_ `_mode`. |
| `scale_type` | `https://docs.cloud.google.com/python/docs/reference/netapp/latest/google.cloud.netapp_v1.types.ScaleType` Optional. The scale type of the storage pool. Defaults to `SCALE_TYPE_DEFAULT` if not specified. |

## Classes

### LabelsEntry

    LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `kwargs` | `dict` Keys and values corresponding to the fields of the message. |
| `mapping` | ``Union[dict, `.Message`]`` A dictionary or message to be used to determine the values for this message. |
| `ignore_unknown_fields` | `Optional(bool)` If True, do not raise errors for unknown fields. Only applied if `mapping` is a mapping type or there are keyword parameters. |

### State

    State(value)

The Storage Pool States