Google Cloud Filestore V1 Client - Class PerformanceConfig (2.1.0)

Reference documentation and code samples for the Google Cloud Filestore V1 Client class PerformanceConfig.

Used for setting the performance configuration.

If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively).

Generated from protobuf message google.cloud.filestore.v1.Instance.PerformanceConfig

Namespace

Google \ Cloud \ Filestore \ V1 \ Instance

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ iops_per_tb IOPSPerTB

Provision IOPS dynamically based on the capacity of the instance. Provisioned IOPS will be calculated by multiplying the capacity of the instance in TiB by the iops_per_tb value. For example, for a 2 TiB instance with an iops_per_tb value of 17000 the provisioned IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an InvalidArgument error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an InvalidArgument error.
↳ fixed_iops FixedIOPS

Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an InvalidArgument error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an InvalidArgument error.

getIopsPerTb

Provision IOPS dynamically based on the capacity of the instance.

Provisioned IOPS will be calculated by multiplying the capacity of the instance in TiB by the iops_per_tb value. For example, for a 2 TiB instance with an iops_per_tb value of 17000 the provisioned IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an InvalidArgument error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an InvalidArgument error.

Returns
Type Description
IOPSPerTB|null

hasIopsPerTb

setIopsPerTb

Provision IOPS dynamically based on the capacity of the instance.

Provisioned IOPS will be calculated by multiplying the capacity of the instance in TiB by the iops_per_tb value. For example, for a 2 TiB instance with an iops_per_tb value of 17000 the provisioned IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an InvalidArgument error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an InvalidArgument error.

Parameter
Name Description
var IOPSPerTB
Returns
Type Description
$this

getFixedIops

Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000.

If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an InvalidArgument error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an InvalidArgument error.

Returns
Type Description
FixedIOPS|null

hasFixedIops

setFixedIops

Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000.

If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an InvalidArgument error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an InvalidArgument error.

Parameter
Name Description
var FixedIOPS
Returns
Type Description
$this

getMode

Returns
Type Description
string