Class OutlierDetection (1.56.0)

public final class OutlierDetection extends GeneratedMessageV3 implements OutlierDetectionOrBuilder

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

Protobuf type google.cloud.compute.v1.OutlierDetection

Static Fields

BASE_EJECTION_TIME_FIELD_NUMBER

public static final int BASE_EJECTION_TIME_FIELD_NUMBER
Field Value
Type Description
int

CONSECUTIVE_ERRORS_FIELD_NUMBER

public static final int CONSECUTIVE_ERRORS_FIELD_NUMBER
Field Value
Type Description
int

CONSECUTIVE_GATEWAY_FAILURE_FIELD_NUMBER

public static final int CONSECUTIVE_GATEWAY_FAILURE_FIELD_NUMBER
Field Value
Type Description
int

ENFORCING_CONSECUTIVE_ERRORS_FIELD_NUMBER

public static final int ENFORCING_CONSECUTIVE_ERRORS_FIELD_NUMBER
Field Value
Type Description
int

ENFORCING_CONSECUTIVE_GATEWAY_FAILURE_FIELD_NUMBER

public static final int ENFORCING_CONSECUTIVE_GATEWAY_FAILURE_FIELD_NUMBER
Field Value
Type Description
int

ENFORCING_SUCCESS_RATE_FIELD_NUMBER

public static final int ENFORCING_SUCCESS_RATE_FIELD_NUMBER
Field Value
Type Description
int

INTERVAL_FIELD_NUMBER

public static final int INTERVAL_FIELD_NUMBER
Field Value
Type Description
int

MAX_EJECTION_PERCENT_FIELD_NUMBER

public static final int MAX_EJECTION_PERCENT_FIELD_NUMBER
Field Value
Type Description
int

SUCCESS_RATE_MINIMUM_HOSTS_FIELD_NUMBER

public static final int SUCCESS_RATE_MINIMUM_HOSTS_FIELD_NUMBER
Field Value
Type Description
int

SUCCESS_RATE_REQUEST_VOLUME_FIELD_NUMBER

public static final int SUCCESS_RATE_REQUEST_VOLUME_FIELD_NUMBER
Field Value
Type Description
int

SUCCESS_RATE_STDEV_FACTOR_FIELD_NUMBER

public static final int SUCCESS_RATE_STDEV_FACTOR_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static OutlierDetection getDefaultInstance()
Returns
Type Description
OutlierDetection

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static OutlierDetection.Builder newBuilder()
Returns
Type Description
OutlierDetection.Builder

newBuilder(OutlierDetection prototype)

public static OutlierDetection.Builder newBuilder(OutlierDetection prototype)
Parameter
Name Description
prototype OutlierDetection
Returns
Type Description
OutlierDetection.Builder

parseDelimitedFrom(InputStream input)

public static OutlierDetection parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
OutlierDetection
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OutlierDetection parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OutlierDetection
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static OutlierDetection parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
OutlierDetection
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static OutlierDetection parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OutlierDetection
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static OutlierDetection parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
OutlierDetection
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static OutlierDetection parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OutlierDetection
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static OutlierDetection parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
OutlierDetection
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static OutlierDetection parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OutlierDetection
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static OutlierDetection parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
OutlierDetection
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OutlierDetection parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OutlierDetection
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static OutlierDetection parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
OutlierDetection
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static OutlierDetection parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OutlierDetection
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<OutlierDetection> parser()
Returns
Type Description
Parser<OutlierDetection>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBaseEjectionTime()

public Duration getBaseEjectionTime()

The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s.

optional .google.cloud.compute.v1.Duration base_ejection_time = 80997255;

Returns
Type Description
Duration

The baseEjectionTime.

getBaseEjectionTimeOrBuilder()

public DurationOrBuilder getBaseEjectionTimeOrBuilder()

The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s.

optional .google.cloud.compute.v1.Duration base_ejection_time = 80997255;

Returns
Type Description
DurationOrBuilder

getConsecutiveErrors()

public int getConsecutiveErrors()

Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.

optional int32 consecutive_errors = 387193248;

Returns
Type Description
int

The consecutiveErrors.

getConsecutiveGatewayFailure()

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

optional int32 consecutive_gateway_failure = 417504250;

Returns
Type Description
int

The consecutiveGatewayFailure.

getDefaultInstanceForType()

public OutlierDetection getDefaultInstanceForType()
Returns
Type Description
OutlierDetection

getEnforcingConsecutiveErrors()

public int getEnforcingConsecutiveErrors()

The percentage chance that a backend endpoint will be 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.

optional int32 enforcing_consecutive_errors = 213133760;

Returns
Type Description
int

The enforcingConsecutiveErrors.

getEnforcingConsecutiveGatewayFailure()

public int getEnforcingConsecutiveGatewayFailure()

The percentage chance that a backend endpoint will be 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.

optional int32 enforcing_consecutive_gateway_failure = 394440666;

Returns
Type Description
int

The enforcingConsecutiveGatewayFailure.

getEnforcingSuccessRate()

public int getEnforcingSuccessRate()

The percentage chance that a backend endpoint will be 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. Not supported when the backend service uses Serverless NEG.

optional int32 enforcing_success_rate = 194508732;

Returns
Type Description
int

The enforcingSuccessRate.

getInterval()

public Duration getInterval()

Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second.

optional .google.cloud.compute.v1.Duration interval = 33547461;

Returns
Type Description
Duration

The interval.

getIntervalOrBuilder()

public DurationOrBuilder getIntervalOrBuilder()

Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second.

optional .google.cloud.compute.v1.Duration interval = 33547461;

Returns
Type Description
DurationOrBuilder

getMaxEjectionPercent()

public int getMaxEjectionPercent()

Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%.

optional int32 max_ejection_percent = 18436888;

Returns
Type Description
int

The maxEjectionPercent.

getParserForType()

public Parser<OutlierDetection> getParserForType()
Returns
Type Description
Parser<OutlierDetection>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSuccessRateMinimumHosts()

public int getSuccessRateMinimumHosts()

The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG.

optional int32 success_rate_minimum_hosts = 525766903;

Returns
Type Description
int

The successRateMinimumHosts.

getSuccessRateRequestVolume()

public int getSuccessRateRequestVolume()

The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint 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 backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG.

optional int32 success_rate_request_volume = 281425357;

Returns
Type Description
int

The successRateRequestVolume.

getSuccessRateStdevFactor()

public int 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 * successRateStdevFactor). 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. Not supported when the backend service uses Serverless NEG.

optional int32 success_rate_stdev_factor = 174735773;

Returns
Type Description
int

The successRateStdevFactor.

hasBaseEjectionTime()

public boolean hasBaseEjectionTime()

The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s.

optional .google.cloud.compute.v1.Duration base_ejection_time = 80997255;

Returns
Type Description
boolean

Whether the baseEjectionTime field is set.

hasConsecutiveErrors()

public boolean hasConsecutiveErrors()

Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.

optional int32 consecutive_errors = 387193248;

Returns
Type Description
boolean

Whether the consecutiveErrors field is set.

hasConsecutiveGatewayFailure()

public boolean hasConsecutiveGatewayFailure()

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.

optional int32 consecutive_gateway_failure = 417504250;

Returns
Type Description
boolean

Whether the consecutiveGatewayFailure field is set.

hasEnforcingConsecutiveErrors()

public boolean hasEnforcingConsecutiveErrors()

The percentage chance that a backend endpoint will be 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.

optional int32 enforcing_consecutive_errors = 213133760;

Returns
Type Description
boolean

Whether the enforcingConsecutiveErrors field is set.

hasEnforcingConsecutiveGatewayFailure()

public boolean hasEnforcingConsecutiveGatewayFailure()

The percentage chance that a backend endpoint will be 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.

optional int32 enforcing_consecutive_gateway_failure = 394440666;

Returns
Type Description
boolean

Whether the enforcingConsecutiveGatewayFailure field is set.

hasEnforcingSuccessRate()

public boolean hasEnforcingSuccessRate()

The percentage chance that a backend endpoint will be 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. Not supported when the backend service uses Serverless NEG.

optional int32 enforcing_success_rate = 194508732;

Returns
Type Description
boolean

Whether the enforcingSuccessRate field is set.

hasInterval()

public boolean hasInterval()

Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second.

optional .google.cloud.compute.v1.Duration interval = 33547461;

Returns
Type Description
boolean

Whether the interval field is set.

hasMaxEjectionPercent()

public boolean hasMaxEjectionPercent()

Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%.

optional int32 max_ejection_percent = 18436888;

Returns
Type Description
boolean

Whether the maxEjectionPercent field is set.

hasSuccessRateMinimumHosts()

public boolean hasSuccessRateMinimumHosts()

The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG.

optional int32 success_rate_minimum_hosts = 525766903;

Returns
Type Description
boolean

Whether the successRateMinimumHosts field is set.

hasSuccessRateRequestVolume()

public boolean hasSuccessRateRequestVolume()

The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint 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 backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG.

optional int32 success_rate_request_volume = 281425357;

Returns
Type Description
boolean

Whether the successRateRequestVolume field is set.

hasSuccessRateStdevFactor()

public boolean hasSuccessRateStdevFactor()

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 * successRateStdevFactor). 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. Not supported when the backend service uses Serverless NEG.

optional int32 success_rate_stdev_factor = 174735773;

Returns
Type Description
boolean

Whether the successRateStdevFactor field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public OutlierDetection.Builder newBuilderForType()
Returns
Type Description
OutlierDetection.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected OutlierDetection.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
OutlierDetection.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public OutlierDetection.Builder toBuilder()
Returns
Type Description
OutlierDetection.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException