Compute V1 Client - Class BackendCustomMetric (1.27.0)

Version latest

• 1.27.0 (latest)
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.1
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.1
• 1.17.0
• 1.16.2
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.1
• 1.10.1
• 1.9.1
• 1.8.3
• 1.7.1
• 1.6.1
• 1.5.0

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 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 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 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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this