Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::BackendCustomMetric.
Custom Metrics are used for CUSTOM_METRICS balancing_mode.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#dry_run
defdry_run()->::Boolean
Returns
(::Boolean) — If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing.
#dry_run=
defdry_run=(value)->::Boolean
Parameter
value (::Boolean) — If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing.
Returns
(::Boolean) — If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing.
#max_utilization
defmax_utilization()->::Float
Returns
(::Float) — Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0].
#max_utilization=
defmax_utilization=(value)->::Float
Parameter
value (::Float) — Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0].
Returns
(::Float) — Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0].
#name
defname()->::String
Returns
(::String) — Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression a-z? which means that the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
#name=
defname=(value)->::String
Parameter
value (::String) — Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression a-z? which means that the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
Returns
(::String) — Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression a-z? which means that the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
[[["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-08-29 UTC."],[],[],null,["# Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::BackendCustomMetric (v3.0.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.0.0 (latest)](/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [2.22.0](/ruby/docs/reference/google-cloud-compute-v1/2.22.0/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [2.21.1](/ruby/docs/reference/google-cloud-compute-v1/2.21.1/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [2.20.0](/ruby/docs/reference/google-cloud-compute-v1/2.20.0/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [2.19.1](/ruby/docs/reference/google-cloud-compute-v1/2.19.1/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [2.18.0](/ruby/docs/reference/google-cloud-compute-v1/2.18.0/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [2.17.0](/ruby/docs/reference/google-cloud-compute-v1/2.17.0/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [2.16.0](/ruby/docs/reference/google-cloud-compute-v1/2.16.0/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [2.15.0](/ruby/docs/reference/google-cloud-compute-v1/2.15.0/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [2.14.0](/ruby/docs/reference/google-cloud-compute-v1/2.14.0/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [2.13.0](/ruby/docs/reference/google-cloud-compute-v1/2.13.0/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [2.12.0](/ruby/docs/reference/google-cloud-compute-v1/2.12.0/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [2.11.0](/ruby/docs/reference/google-cloud-compute-v1/2.11.0/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [2.10.0](/ruby/docs/reference/google-cloud-compute-v1/2.10.0/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [2.9.0](/ruby/docs/reference/google-cloud-compute-v1/2.9.0/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [2.8.0](/ruby/docs/reference/google-cloud-compute-v1/2.8.0/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [2.7.2](/ruby/docs/reference/google-cloud-compute-v1/2.7.2/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [2.6.0](/ruby/docs/reference/google-cloud-compute-v1/2.6.0/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [2.5.0](/ruby/docs/reference/google-cloud-compute-v1/2.5.0/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [2.4.0](/ruby/docs/reference/google-cloud-compute-v1/2.4.0/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [2.3.0](/ruby/docs/reference/google-cloud-compute-v1/2.3.0/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [2.2.0](/ruby/docs/reference/google-cloud-compute-v1/2.2.0/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [2.1.0](/ruby/docs/reference/google-cloud-compute-v1/2.1.0/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [2.0.0](/ruby/docs/reference/google-cloud-compute-v1/2.0.0/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [1.10.0](/ruby/docs/reference/google-cloud-compute-v1/1.10.0/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [1.9.0](/ruby/docs/reference/google-cloud-compute-v1/1.9.0/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [1.8.0](/ruby/docs/reference/google-cloud-compute-v1/1.8.0/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [1.7.1](/ruby/docs/reference/google-cloud-compute-v1/1.7.1/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [1.6.0](/ruby/docs/reference/google-cloud-compute-v1/1.6.0/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [1.5.0](/ruby/docs/reference/google-cloud-compute-v1/1.5.0/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [1.4.0](/ruby/docs/reference/google-cloud-compute-v1/1.4.0/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [1.3.0](/ruby/docs/reference/google-cloud-compute-v1/1.3.0/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [1.2.0](/ruby/docs/reference/google-cloud-compute-v1/1.2.0/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [1.1.0](/ruby/docs/reference/google-cloud-compute-v1/1.1.0/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [1.0.0](/ruby/docs/reference/google-cloud-compute-v1/1.0.0/Google-Cloud-Compute-V1-BackendCustomMetric)\n- [0.5.0](/ruby/docs/reference/google-cloud-compute-v1/0.5.0/Google-Cloud-Compute-V1-BackendCustomMetric) \nReference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::BackendCustomMetric.\n\nCustom Metrics are used for CUSTOM_METRICS balancing_mode. \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### #dry_run\n\n def dry_run() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing.\n\n### #dry_run=\n\n def dry_run=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing. \n**Returns**\n\n- (::Boolean) --- If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing.\n\n### #max_utilization\n\n def max_utilization() -\u003e ::Float\n\n**Returns**\n\n- (::Float) --- Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is \\[0.0, 1.0\\].\n\n### #max_utilization=\n\n def max_utilization=(value) -\u003e ::Float\n\n**Parameter**\n\n- **value** (::Float) --- Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is \\[0.0, 1.0\\]. \n**Returns**\n\n- (::Float) --- Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is \\[0.0, 1.0\\].\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z](/ruby/docs/reference/google-cloud-compute-v1/latest/%5B-_.a-z0-9%5D*%5Ba-z0-9%5D)? which means that the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z](/ruby/docs/reference/google-cloud-compute-v1/latest/%5B-_.a-z0-9%5D*%5Ba-z0-9%5D)? which means that the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. \n**Returns**\n\n- (::String) --- Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z](/ruby/docs/reference/google-cloud-compute-v1/latest/%5B-_.a-z0-9%5D*%5Ba-z0-9%5D)? which means that the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED."]]