Reference documentation and code samples for the Compute V1 Client class BackendCustomMetric.
Custom Metrics are used for CUSTOM_METRICS balancing_mode.
Generated from protobuf message google.cloud.compute.v1.BackendCustomMetric
Namespace
Google \ Cloud \ Compute \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ dry_run
bool
If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing.
↳ max_utilization
float
Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0].
↳ name
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.
getDryRun
If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing.
Returns
Type
Description
bool
hasDryRun
clearDryRun
setDryRun
If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getMaxUtilization
Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0].
Returns
Type
Description
float
hasMaxUtilization
clearMaxUtilization
setMaxUtilization
Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0].
Parameter
Name
Description
var
float
Returns
Type
Description
$this
getName
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
Type
Description
string
hasName
clearName
setName
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-28 UTC."],[],[],null,["# Compute V1 Client - Class BackendCustomMetric (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-compute/latest/V1.BackendCustomMetric)\n- [1.34.0](/php/docs/reference/cloud-compute/1.34.0/V1.BackendCustomMetric)\n- [1.33.0](/php/docs/reference/cloud-compute/1.33.0/V1.BackendCustomMetric)\n- [1.32.0](/php/docs/reference/cloud-compute/1.32.0/V1.BackendCustomMetric)\n- [1.31.0](/php/docs/reference/cloud-compute/1.31.0/V1.BackendCustomMetric)\n- [1.30.0](/php/docs/reference/cloud-compute/1.30.0/V1.BackendCustomMetric)\n- [1.29.0](/php/docs/reference/cloud-compute/1.29.0/V1.BackendCustomMetric)\n- [1.28.0](/php/docs/reference/cloud-compute/1.28.0/V1.BackendCustomMetric)\n- [1.27.0](/php/docs/reference/cloud-compute/1.27.0/V1.BackendCustomMetric)\n- [1.26.0](/php/docs/reference/cloud-compute/1.26.0/V1.BackendCustomMetric)\n- [1.25.0](/php/docs/reference/cloud-compute/1.25.0/V1.BackendCustomMetric)\n- [1.24.0](/php/docs/reference/cloud-compute/1.24.0/V1.BackendCustomMetric)\n- [1.23.0](/php/docs/reference/cloud-compute/1.23.0/V1.BackendCustomMetric)\n- [1.22.1](/php/docs/reference/cloud-compute/1.22.1/V1.BackendCustomMetric)\n- [1.21.0](/php/docs/reference/cloud-compute/1.21.0/V1.BackendCustomMetric)\n- [1.20.0](/php/docs/reference/cloud-compute/1.20.0/V1.BackendCustomMetric)\n- [1.19.0](/php/docs/reference/cloud-compute/1.19.0/V1.BackendCustomMetric)\n- [1.18.1](/php/docs/reference/cloud-compute/1.18.1/V1.BackendCustomMetric)\n- [1.17.0](/php/docs/reference/cloud-compute/1.17.0/V1.BackendCustomMetric)\n- [1.16.2](/php/docs/reference/cloud-compute/1.16.2/V1.BackendCustomMetric)\n- [1.14.0](/php/docs/reference/cloud-compute/1.14.0/V1.BackendCustomMetric)\n- [1.13.0](/php/docs/reference/cloud-compute/1.13.0/V1.BackendCustomMetric)\n- [1.12.1](/php/docs/reference/cloud-compute/1.12.1/V1.BackendCustomMetric)\n- [1.11.1](/php/docs/reference/cloud-compute/1.11.1/V1.BackendCustomMetric)\n- [1.10.1](/php/docs/reference/cloud-compute/1.10.1/V1.BackendCustomMetric)\n- [1.9.1](/php/docs/reference/cloud-compute/1.9.1/V1.BackendCustomMetric)\n- [1.8.3](/php/docs/reference/cloud-compute/1.8.3/V1.BackendCustomMetric)\n- [1.7.1](/php/docs/reference/cloud-compute/1.7.1/V1.BackendCustomMetric)\n- [1.6.1](/php/docs/reference/cloud-compute/1.6.1/V1.BackendCustomMetric)\n- [1.5.0](/php/docs/reference/cloud-compute/1.5.0/V1.BackendCustomMetric) \nReference documentation and code samples for the Compute V1 Client class BackendCustomMetric.\n\nCustom Metrics are used for CUSTOM_METRICS balancing_mode.\n\nGenerated from protobuf message `google.cloud.compute.v1.BackendCustomMetric`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Compute \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getDryRun\n\nIf true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing.\n\n### hasDryRun\n\n### clearDryRun\n\n### setDryRun\n\nIf true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing.\n\n### getMaxUtilization\n\nOptional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is \\[0.0, 1.0\\].\n\n### hasMaxUtilization\n\n### clearMaxUtilization\n\n### setMaxUtilization\n\nOptional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is \\[0.0, 1.0\\].\n\n### getName\n\nName of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z](/php/docs/reference/cloud-compute/latest/[-_.a-z0-9]*[a-z0-9])? 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### hasName\n\n### clearName\n\n### setName\n\nName of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z](/php/docs/reference/cloud-compute/latest/[-_.a-z0-9]*[a-z0-9])? 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."]]
