Compute V1 Client - Class BackendServiceCustomMetric (1.35.0)

Reference documentation and code samples for the Compute V1 Client class BackendServiceCustomMetric.

Custom Metrics are used for WEIGHTED_ROUND_ROBIN locality_lb_policy.

Generated from protobuf message google.cloud.compute.v1.BackendServiceCustomMetric

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 not used for load balancing.
↳ 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 not used for load balancing.

Returns
Type Description
bool

hasDryRun

clearDryRun

setDryRun

If true, the metric data is not used for load balancing.

Parameter
Name Description
var bool
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.

Parameter
Name Description
var string
Returns
Type Description
$this