# NetApp V1 API - Class Google::Cloud::NetApp::V1::StoragePool (v2.11.0)

2.11.0 (latest) 2.10.0 2.9.0 2.8.0 2.7.0 2.6.1 2.5.0 2.4.0 2.3.0 2.2.0 2.1.0 2.0.2 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.1 1.0.0 0.6.0 0.5.2 0.4.2 0.3.0 0.2.0 0.1.0 Reference documentation and code samples for the NetApp V1 API class Google::Cloud::NetApp::V1::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.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #active_directory

    def active_directory() -> ::String

**Returns**

- (::String) --- Optional. Specifies the Active Directory to be used for creating a SMB volume.

### #active_directory=

    def active_directory=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. Specifies the Active Directory to be used for creating a SMB volume.
**Returns**

- (::String) --- Optional. Specifies the Active Directory to be used for creating a SMB volume.

### #allow_auto_tiering

    def allow_auto_tiering() -> ::Boolean

**Returns**

- (::Boolean) --- 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.

### #allow_auto_tiering=

    def allow_auto_tiering=(value) -> ::Boolean

**Parameter**

- **value** (::Boolean) --- 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**

- (::Boolean) --- 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.

### #available_throughput_mibps

    def available_throughput_mibps() -> ::Float

**Returns**

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

### #capacity_gib

    def capacity_gib() -> ::Integer

**Returns**

- (::Integer) --- Required. Capacity in GIB of the pool

### #capacity_gib=

    def capacity_gib=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- Required. Capacity in GIB of the pool
**Returns**

- (::Integer) --- Required. Capacity in GIB of the pool

### #cold_tier_size_used_gib

    def cold_tier_size_used_gib() -> ::Integer

**Returns**

- (::Integer) --- Output only. Total cold tier data rounded down to the nearest GiB used by the storage pool.

### #create_time

    def create_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Protobuf-Timestamp)) --- Output only. Create time of the storage pool

### #custom_performance_enabled

    def custom_performance_enabled() -> ::Boolean

**Returns**

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

### #custom_performance_enabled=

    def custom_performance_enabled=(value) -> ::Boolean

**Parameter**

- **value** (::Boolean) --- Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false
**Returns**

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

### #description

    def description() -> ::String

**Returns**

- (::String) --- Optional. Description of the storage pool

### #description=

    def description=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. Description of the storage pool
**Returns**

- (::String) --- Optional. Description of the storage pool

### #enable_hot_tier_auto_resize

    def enable_hot_tier_auto_resize() -> ::Boolean

**Returns**

- (::Boolean) --- 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.

### #enable_hot_tier_auto_resize=

    def enable_hot_tier_auto_resize=(value) -> ::Boolean

**Parameter**

- **value** (::Boolean) --- 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**

- (::Boolean) --- 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.

### #encryption_type

    def encryption_type() -> ::Google::Cloud::NetApp::V1::EncryptionType

**Returns**

- ([::Google::Cloud::NetApp::V1::EncryptionType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Cloud-NetApp-V1-EncryptionType)) --- Output only. Specifies the current pool encryption key source.

### #global_access_allowed

    def global_access_allowed() -> ::Boolean

**Returns**

- (::Boolean) --- Deprecated. Used to allow SO pool to access AD or DNS server from other regions.

### #global_access_allowed=

    def global_access_allowed=(value) -> ::Boolean

**Parameter**

- **value** (::Boolean) --- Deprecated. Used to allow SO pool to access AD or DNS server from other regions.
**Returns**

- (::Boolean) --- Deprecated. Used to allow SO pool to access AD or DNS server from other regions.

### #hot_tier_size_gib

    def hot_tier_size_gib() -> ::Integer

**Returns**

- (::Integer) --- 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.

### #hot_tier_size_gib=

    def hot_tier_size_gib=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- 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**

- (::Integer) --- 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.

### #hot_tier_size_used_gib

    def hot_tier_size_used_gib() -> ::Integer

**Returns**

- (::Integer) --- Output only. Total hot tier data rounded down to the nearest GiB used by the storage pool.

### #kms_config

    def kms_config() -> ::String

**Returns**

- (::String) --- Optional. Specifies the KMS config to be used for volume encryption.

### #kms_config=

    def kms_config=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. Specifies the KMS config to be used for volume encryption.
**Returns**

- (::String) --- Optional. Specifies the KMS config to be used for volume encryption.

### #labels

    def labels() -> ::Google::Protobuf::Map{::String => ::String}

**Returns**

- (::Google::Protobuf::Map{::String =\> ::String}) --- Optional. Labels as key value pairs

### #labels=

    def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

**Parameter**

- **value** (::Google::Protobuf::Map{::String =\> ::String}) --- Optional. Labels as key value pairs
**Returns**

- (::Google::Protobuf::Map{::String =\> ::String}) --- Optional. Labels as key value pairs

### #ldap_enabled

    def ldap_enabled() -> ::Boolean

**Returns**

- (::Boolean) --- Optional. Flag indicating if the pool is NFS LDAP enabled or not.

### #ldap_enabled=

    def ldap_enabled=(value) -> ::Boolean

**Parameter**

- **value** (::Boolean) --- Optional. Flag indicating if the pool is NFS LDAP enabled or not.
**Returns**

- (::Boolean) --- Optional. Flag indicating if the pool is NFS LDAP enabled or not.

### #mode

    def mode() -> ::Google::Cloud::NetApp::V1::Mode

**Returns**

- ([::Google::Cloud::NetApp::V1::Mode](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Cloud-NetApp-V1-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`.

### #mode=

    def mode=(value) -> ::Google::Cloud::NetApp::V1::Mode

**Parameter**

- **value** ([::Google::Cloud::NetApp::V1::Mode](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Cloud-NetApp-V1-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`.
**Returns**

- ([::Google::Cloud::NetApp::V1::Mode](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Cloud-NetApp-V1-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`.

### #name

    def name() -> ::String

**Returns**

- (::String) --- Identifier. Name of the storage pool

### #name=

    def name=(value) -> ::String

**Parameter**

- **value** (::String) --- Identifier. Name of the storage pool
**Returns**

- (::String) --- Identifier. Name of the storage pool

### #network

    def network() -> ::String

**Returns**

- (::String) --- Required. VPC Network name. Format: projects/{project}/global/networks/{network}

### #network=

    def network=(value) -> ::String

**Parameter**

- **value** (::String) --- Required. VPC Network name. Format: projects/{project}/global/networks/{network}
**Returns**

- (::String) --- Required. VPC Network name. Format: projects/{project}/global/networks/{network}

### #psa_range

    def psa_range() -> ::String

**Returns**

- (::String) --- Optional. This field is not implemented. The values provided in this field are ignored.

### #psa_range=

    def psa_range=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. This field is not implemented. The values provided in this field are ignored.
**Returns**

- (::String) --- Optional. This field is not implemented. The values provided in this field are ignored.

### #qos_type

    def qos_type() -> ::Google::Cloud::NetApp::V1::QosType

**Returns**

- ([::Google::Cloud::NetApp::V1::QosType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Cloud-NetApp-V1-QosType)) --- Optional. QoS (Quality of Service) Type of the storage pool

### #qos_type=

    def qos_type=(value) -> ::Google::Cloud::NetApp::V1::QosType

**Parameter**

- **value** ([::Google::Cloud::NetApp::V1::QosType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Cloud-NetApp-V1-QosType)) --- Optional. QoS (Quality of Service) Type of the storage pool
**Returns**

- ([::Google::Cloud::NetApp::V1::QosType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Cloud-NetApp-V1-QosType)) --- Optional. QoS (Quality of Service) Type of the storage pool

### #replica_zone

    def replica_zone() -> ::String

**Returns**

- (::String) --- Optional. Specifies the replica zone for regional storagePool.

### #replica_zone=

    def replica_zone=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. Specifies the replica zone for regional storagePool.
**Returns**

- (::String) --- Optional. Specifies the replica zone for regional storagePool.

### #satisfies_pzi

    def satisfies_pzi() -> ::Boolean

**Returns**

- (::Boolean) --- Output only. Reserved for future use

### #satisfies_pzs

    def satisfies_pzs() -> ::Boolean

**Returns**

- (::Boolean) --- Output only. Reserved for future use

### #scale_type

    def scale_type() -> ::Google::Cloud::NetApp::V1::ScaleType

**Returns**

- ([::Google::Cloud::NetApp::V1::ScaleType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Cloud-NetApp-V1-ScaleType)) --- Optional. The scale type of the storage pool. Defaults to `SCALE_TYPE_DEFAULT` if not specified.

### #scale_type=

    def scale_type=(value) -> ::Google::Cloud::NetApp::V1::ScaleType

**Parameter**

- **value** ([::Google::Cloud::NetApp::V1::ScaleType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Cloud-NetApp-V1-ScaleType)) --- Optional. The scale type of the storage pool. Defaults to `SCALE_TYPE_DEFAULT` if not specified.
**Returns**

- ([::Google::Cloud::NetApp::V1::ScaleType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Cloud-NetApp-V1-ScaleType)) --- Optional. The scale type of the storage pool. Defaults to `SCALE_TYPE_DEFAULT` if not specified.

### #service_level

    def service_level() -> ::Google::Cloud::NetApp::V1::ServiceLevel

**Returns**

- ([::Google::Cloud::NetApp::V1::ServiceLevel](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Cloud-NetApp-V1-ServiceLevel)) --- Required. Service level of the storage pool

### #service_level=

    def service_level=(value) -> ::Google::Cloud::NetApp::V1::ServiceLevel

**Parameter**

- **value** ([::Google::Cloud::NetApp::V1::ServiceLevel](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Cloud-NetApp-V1-ServiceLevel)) --- Required. Service level of the storage pool
**Returns**

- ([::Google::Cloud::NetApp::V1::ServiceLevel](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Cloud-NetApp-V1-ServiceLevel)) --- Required. Service level of the storage pool

### #state

    def state() -> ::Google::Cloud::NetApp::V1::StoragePool::State

**Returns**

- ([::Google::Cloud::NetApp::V1::StoragePool::State](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Cloud-NetApp-V1-StoragePool-State)) --- Output only. State of the storage pool

### #state_details

    def state_details() -> ::String

**Returns**

- (::String) --- Output only. State details of the storage pool

### #total_iops

    def total_iops() -> ::Integer

**Returns**

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

### #total_iops=

    def total_iops=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- Optional. Custom Performance Total IOPS of the pool if not provided, it will be calculated based on the total_throughput_mibps
**Returns**

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

### #total_throughput_mibps

    def total_throughput_mibps() -> ::Integer

**Returns**

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

### #total_throughput_mibps=

    def total_throughput_mibps=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- Optional. Custom Performance Total Throughput of the pool (in MiBps)
**Returns**

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

### #type

    def type() -> ::Google::Cloud::NetApp::V1::StoragePoolType

**Returns**

- ([::Google::Cloud::NetApp::V1::StoragePoolType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Cloud-NetApp-V1-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`.

### #type=

    def type=(value) -> ::Google::Cloud::NetApp::V1::StoragePoolType

**Parameter**

- **value** ([::Google::Cloud::NetApp::V1::StoragePoolType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Cloud-NetApp-V1-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`.
**Returns**

- ([::Google::Cloud::NetApp::V1::StoragePoolType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-netapp-v1/latest/Google-Cloud-NetApp-V1-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`.

### #volume_capacity_gib

    def volume_capacity_gib() -> ::Integer

**Returns**

- (::Integer) --- Output only. Allocated size of all volumes in GIB in the storage pool

### #volume_count

    def volume_count() -> ::Integer

**Returns**

- (::Integer) --- Output only. Volume count of the storage pool

### #zone

    def zone() -> ::String

**Returns**

- (::String) --- Optional. Specifies the active zone for regional storagePool.

### #zone=

    def zone=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. Specifies the active zone for regional storagePool.
**Returns**

- (::String) --- Optional. Specifies the active zone for regional storagePool.