Compute V1 Client - Class OutlierDetection (1.7.1)

Version 1.7.1

• 1.22.0 (latest)
• 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 OutlierDetection.

Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service.

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

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ base_ejection_time	Google\Cloud\Compute\V1\Duration The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.
↳ consecutive_errors	int Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
↳ consecutive_gateway_failure	int The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
↳ enforcing_consecutive_errors	int The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
↳ enforcing_consecutive_gateway_failure	int The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
↳ enforcing_success_rate	int The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
↳ interval	Google\Cloud\Compute\V1\Duration Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second.
↳ max_ejection_percent	int Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%.
↳ success_rate_minimum_hosts	int The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.
↳ success_rate_request_volume	int The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.
↳ success_rate_stdev_factor	int This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.

getBaseEjectionTime

The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.

Returns
Type	Description
Google\Cloud\Compute\V1\Duration|null

hasBaseEjectionTime

clearBaseEjectionTime

setBaseEjectionTime

The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.

Parameter
Name	Description
var	Google\Cloud\Compute\V1\Duration

Returns
Type	Description
$this

getConsecutiveErrors

Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

Returns
Type	Description
int

hasConsecutiveErrors

clearConsecutiveErrors

setConsecutiveErrors

Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getConsecutiveGatewayFailure

The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

Returns
Type	Description
int

hasConsecutiveGatewayFailure

clearConsecutiveGatewayFailure

setConsecutiveGatewayFailure

The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getEnforcingConsecutiveErrors

The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

Returns
Type	Description
int

hasEnforcingConsecutiveErrors

clearEnforcingConsecutiveErrors

setEnforcingConsecutiveErrors

The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getEnforcingConsecutiveGatewayFailure

The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

Returns
Type	Description
int

hasEnforcingConsecutiveGatewayFailure

clearEnforcingConsecutiveGatewayFailure

setEnforcingConsecutiveGatewayFailure

The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getEnforcingSuccessRate

The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

Returns
Type	Description
int

hasEnforcingSuccessRate

clearEnforcingSuccessRate

setEnforcingSuccessRate

The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getInterval

Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second.

Returns
Type	Description
Google\Cloud\Compute\V1\Duration|null

hasInterval

clearInterval

setInterval

Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second.

Parameter
Name	Description
var	Google\Cloud\Compute\V1\Duration

Returns
Type	Description
$this

getMaxEjectionPercent

Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%.

Returns
Type	Description
int

hasMaxEjectionPercent

clearMaxEjectionPercent

setMaxEjectionPercent

Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getSuccessRateMinimumHosts

The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.

Returns
Type	Description
int

hasSuccessRateMinimumHosts

clearSuccessRateMinimumHosts

setSuccessRateMinimumHosts

The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getSuccessRateRequestVolume

The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.

Returns
Type	Description
int

hasSuccessRateRequestVolume

clearSuccessRateRequestVolume

setSuccessRateRequestVolume

The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getSuccessRateStdevFactor

This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.

Returns
Type	Description
int

hasSuccessRateStdevFactor

clearSuccessRateStdevFactor

setSuccessRateStdevFactor

This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.

Parameter
Name	Description
var	int

Returns
Type	Description
$this