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).
(::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.
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.
(::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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Filestore V1 API - Class Google::Cloud::Filestore::V1::Instance::PerformanceConfig (v2.2.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.2.0 (latest)](/ruby/docs/reference/google-cloud-filestore-v1/latest/Google-Cloud-Filestore-V1-Instance-PerformanceConfig)\n- [2.1.1](/ruby/docs/reference/google-cloud-filestore-v1/2.1.1/Google-Cloud-Filestore-V1-Instance-PerformanceConfig)\n- [2.0.0](/ruby/docs/reference/google-cloud-filestore-v1/2.0.0/Google-Cloud-Filestore-V1-Instance-PerformanceConfig)\n- [1.2.0](/ruby/docs/reference/google-cloud-filestore-v1/1.2.0/Google-Cloud-Filestore-V1-Instance-PerformanceConfig)\n- [1.1.0](/ruby/docs/reference/google-cloud-filestore-v1/1.1.0/Google-Cloud-Filestore-V1-Instance-PerformanceConfig)\n- [1.0.1](/ruby/docs/reference/google-cloud-filestore-v1/1.0.1/Google-Cloud-Filestore-V1-Instance-PerformanceConfig)\n- [0.9.0](/ruby/docs/reference/google-cloud-filestore-v1/0.9.0/Google-Cloud-Filestore-V1-Instance-PerformanceConfig)\n- [0.8.2](/ruby/docs/reference/google-cloud-filestore-v1/0.8.2/Google-Cloud-Filestore-V1-Instance-PerformanceConfig)\n- [0.7.0](/ruby/docs/reference/google-cloud-filestore-v1/0.7.0/Google-Cloud-Filestore-V1-Instance-PerformanceConfig)\n- [0.6.0](/ruby/docs/reference/google-cloud-filestore-v1/0.6.0/Google-Cloud-Filestore-V1-Instance-PerformanceConfig)\n- [0.5.0](/ruby/docs/reference/google-cloud-filestore-v1/0.5.0/Google-Cloud-Filestore-V1-Instance-PerformanceConfig)\n- [0.4.1](/ruby/docs/reference/google-cloud-filestore-v1/0.4.1/Google-Cloud-Filestore-V1-Instance-PerformanceConfig)\n- [0.3.0](/ruby/docs/reference/google-cloud-filestore-v1/0.3.0/Google-Cloud-Filestore-V1-Instance-PerformanceConfig)\n- [0.2.0](/ruby/docs/reference/google-cloud-filestore-v1/0.2.0/Google-Cloud-Filestore-V1-Instance-PerformanceConfig)\n- [0.1.3](/ruby/docs/reference/google-cloud-filestore-v1/0.1.3/Google-Cloud-Filestore-V1-Instance-PerformanceConfig) \nReference documentation and code samples for the Filestore V1 API class Google::Cloud::Filestore::V1::Instance::PerformanceConfig.\n\nUsed for setting the performance configuration.\nIf the user doesn't specify PerformanceConfig, automatically provision\nthe default performance settings as described in\n\u003chttps://cloud.google.com/filestore/docs/performance\u003e. Larger instances will\nbe linearly set to more IOPS. If the instance's capacity is increased or\ndecreased, its performance will be automatically adjusted upwards or\ndownwards accordingly (respectively). \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #fixed_iops\n\n def fixed_iops() -\u003e ::Google::Cloud::Filestore::V1::Instance::FixedIOPS\n\n**Returns**\n\n- ([::Google::Cloud::Filestore::V1::Instance::FixedIOPS](./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.\n\n\n If the chosen value is outside the supported range for the instance's\n capacity during instance creation, instance creation will fail with an\n `InvalidArgument` error. Similarly, if an instance capacity update\n would result in a value outside the supported range, the update will\n fail with an `InvalidArgument` error.\n\n 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.\n\n### #fixed_iops=\n\n def fixed_iops=(value) -\u003e ::Google::Cloud::Filestore::V1::Instance::FixedIOPS\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Filestore::V1::Instance::FixedIOPS](./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.\n\n\n If the chosen value is outside the supported range for the instance's\n capacity during instance creation, instance creation will fail with an\n `InvalidArgument` error. Similarly, if an instance capacity update\n would result in a value outside the supported range, the update will\n fail with an `InvalidArgument` error.\n\nNote: 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. \n**Returns**\n\n- ([::Google::Cloud::Filestore::V1::Instance::FixedIOPS](./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.\n\n\n If the chosen value is outside the supported range for the instance's\n capacity during instance creation, instance creation will fail with an\n `InvalidArgument` error. Similarly, if an instance capacity update\n would result in a value outside the supported range, the update will\n fail with an `InvalidArgument` error.\n\n 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.\n\n### #iops_per_tb\n\n def iops_per_tb() -\u003e ::Google::Cloud::Filestore::V1::Instance::IOPSPerTB\n\n**Returns**\n\n- ([::Google::Cloud::Filestore::V1::Instance::IOPSPerTB](./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.\n\n\n If the calculated value is outside the supported range for the\n instance's capacity during instance creation, instance creation will\n fail with an `InvalidArgument` error. Similarly, if an instance\n capacity update would result in a value outside the supported range,\n the update will fail with an `InvalidArgument` error.\n\n 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.\n\n### #iops_per_tb=\n\n def iops_per_tb=(value) -\u003e ::Google::Cloud::Filestore::V1::Instance::IOPSPerTB\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Filestore::V1::Instance::IOPSPerTB](./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.\n\n\n If the calculated value is outside the supported range for the\n instance's capacity during instance creation, instance creation will\n fail with an `InvalidArgument` error. Similarly, if an instance\n capacity update would result in a value outside the supported range,\n the update will fail with an `InvalidArgument` error.\n\nNote: 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. \n**Returns**\n\n- ([::Google::Cloud::Filestore::V1::Instance::IOPSPerTB](./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.\n\n\n If the calculated value is outside the supported range for the\n instance's capacity during instance creation, instance creation will\n fail with an `InvalidArgument` error. Similarly, if an instance\n capacity update would result in a value outside the supported range,\n the update will fail with an `InvalidArgument` error.\n\n 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."]]