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.
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
↳ description
string
Optional. Description of the storage pool
↳ labels
↳ 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.
getName
Identifier. Name of the storage pool
string
setName
Identifier. Name of the storage pool
var
string
$this
getServiceLevel
Required. Service level of the storage pool
int
setServiceLevel
Required. Service level of the storage pool
var
int
Enum of type ServiceLevel .
$this
getCapacityGib
Required. Capacity in GIB of the pool
int|string
setCapacityGib
Required. Capacity in GIB of the pool
var
int|string
$this
getVolumeCapacityGib
Output only. Allocated size of all volumes in GIB in the storage pool
int|string
setVolumeCapacityGib
Output only. Allocated size of all volumes in GIB in the storage pool
var
int|string
$this
getVolumeCount
Output only. Volume count of the storage pool
int
setVolumeCount
Output only. Volume count of the storage pool
var
int
$this
getState
Output only. State of the storage pool
int
setState
Output only. State of the storage pool
var
int
Enum of type State .
$this
getStateDetails
Output only. State details of the storage pool
string
setStateDetails
Output only. State details of the storage pool
var
string
$this
getCreateTime
Output only. Create time of the storage pool
hasCreateTime
clearCreateTime
setCreateTime
Output only. Create time of the storage pool
$this
getDescription
Optional. Description of the storage pool
string
setDescription
Optional. Description of the storage pool
var
string
$this
getLabels
Optional. Labels as key value pairs
setLabels
Optional. Labels as key value pairs
$this
getNetwork
Required. VPC Network name.
Format: projects/{project}/global/networks/{network}
string
setNetwork
Required. VPC Network name.
Format: projects/{project}/global/networks/{network}
var
string
$this
getActiveDirectory
Optional. Specifies the Active Directory to be used for creating a SMB volume.
string
setActiveDirectory
Optional. Specifies the Active Directory to be used for creating a SMB volume.
var
string
$this
getKmsConfig
Optional. Specifies the KMS config to be used for volume encryption.
string
setKmsConfig
Optional. Specifies the KMS config to be used for volume encryption.
var
string
$this
getLdapEnabled
Optional. Flag indicating if the pool is NFS LDAP enabled or not.
bool
setLdapEnabled
Optional. Flag indicating if the pool is NFS LDAP enabled or not.
var
bool
$this
getPsaRange
Optional. This field is not implemented. The values provided in this field are ignored.
string
setPsaRange
Optional. This field is not implemented. The values provided in this field are ignored.
var
string
$this
getEncryptionType
Output only. Specifies the current pool encryption key source.
int
setEncryptionType
Output only. Specifies the current pool encryption key source.
var
int
Enum of type EncryptionType .
$this
getGlobalAccessAllowed
Deprecated. Used to allow SO pool to access AD or DNS server from other regions.
bool
hasGlobalAccessAllowed
clearGlobalAccessAllowed
setGlobalAccessAllowed
Deprecated. Used to allow SO pool to access AD or DNS server from other regions.
var
bool
$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.
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.
var
bool
$this
getReplicaZone
Optional. Specifies the replica zone for regional storagePool.
string
setReplicaZone
Optional. Specifies the replica zone for regional storagePool.
var
string
$this
getZone
Optional. Specifies the active zone for regional storagePool.
string
setZone
Optional. Specifies the active zone for regional storagePool.
var
string
$this
getSatisfiesPzs
Output only. Reserved for future use
bool
setSatisfiesPzs
Output only. Reserved for future use
var
bool
$this
getSatisfiesPzi
Output only. Reserved for future use
bool
setSatisfiesPzi
Output only. Reserved for future use
var
bool
$this
getCustomPerformanceEnabled
Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false
bool
setCustomPerformanceEnabled
Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false
var
bool
$this
getTotalThroughputMibps
Optional. Custom Performance Total Throughput of the pool (in MiBps)
int|string
setTotalThroughputMibps
Optional. Custom Performance Total Throughput of the pool (in MiBps)
var
int|string
$this
getTotalIops
Optional. Custom Performance Total IOPS of the pool if not provided, it will be calculated based on the total_throughput_mibps
int|string
setTotalIops
Optional. Custom Performance Total IOPS of the pool if not provided, it will be calculated based on the total_throughput_mibps
var
int|string
$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.
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.
var
int|string
$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.
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.
var
bool
$this
getQosType
Optional. QoS (Quality of Service) Type of the storage pool
int
setQosType
Optional. QoS (Quality of Service) Type of the storage pool
var
int
Enum of type QosType .
$this
getAvailableThroughputMibps
Output only. Available throughput of the storage pool (in MiB/s).
float
setAvailableThroughputMibps
Output only. Available throughput of the storage pool (in MiB/s).
var
float
$this
getColdTierSizeUsedGib
Output only. Total cold tier data rounded down to the nearest GiB used by the storage pool.
int|string
setColdTierSizeUsedGib
Output only. Total cold tier data rounded down to the nearest GiB used by the storage pool.
var
int|string
$this
getHotTierSizeUsedGib
Output only. Total hot tier data rounded down to the nearest GiB used by the storage pool.
int|string
setHotTierSizeUsedGib
Output only. Total hot tier data rounded down to the nearest GiB used by the storage pool.
var
int|string
$this