Filestore V1 API - Class Google::Cloud::Filestore::V1::Instance::PerformanceConfig (v2.1.0)

Reference documentation and code samples for the Filestore V1 API class Google::Cloud::Filestore::V1::Instance::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).

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#fixed_iops

def fixed_iops() -> ::Google::Cloud::Filestore::V1::Instance::FixedIOPS
Returns
  • (::Google::Cloud::Filestore::V1::Instance::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.

    Note: The following fields are mutually exclusive: fixed_iops, iops_per_tb. If a field in that set is populated, all other fields in the set will automatically be cleared.

#fixed_iops=

def fixed_iops=(value) -> ::Google::Cloud::Filestore::V1::Instance::FixedIOPS
Parameter
  • value (::Google::Cloud::Filestore::V1::Instance::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.

    Note: The following fields are mutually exclusive: fixed_iops, iops_per_tb. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Filestore::V1::Instance::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.

    Note: The following fields are mutually exclusive: fixed_iops, iops_per_tb. If a field in that set is populated, all other fields in the set will automatically be cleared.

#iops_per_tb

def iops_per_tb() -> ::Google::Cloud::Filestore::V1::Instance::IOPSPerTB
Returns
  • (::Google::Cloud::Filestore::V1::Instance::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.

    Note: The following fields are mutually exclusive: iops_per_tb, fixed_iops. If a field in that set is populated, all other fields in the set will automatically be cleared.

#iops_per_tb=

def iops_per_tb=(value) -> ::Google::Cloud::Filestore::V1::Instance::IOPSPerTB
Parameter
  • value (::Google::Cloud::Filestore::V1::Instance::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.

    Note: The following fields are mutually exclusive: iops_per_tb, fixed_iops. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Filestore::V1::Instance::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.

    Note: The following fields are mutually exclusive: iops_per_tb, fixed_iops. If a field in that set is populated, all other fields in the set will automatically be cleared.