Package com.google.cloud.compute.v1

Interface OutlierDetectionOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
OutlierDetection, OutlierDetection.Builder
@Generated public interface OutlierDetectionOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    Duration
    getBaseEjectionTime()
    The base time that a backend endpoint is ejected for.
    DurationOrBuilder
    getBaseEjectionTimeOrBuilder()
    The base time that a backend endpoint is ejected for.
    int
    getConsecutiveErrors()
    Number of consecutive errors before a backend endpoint is ejected from the load balancing pool.
    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.
    int
    getEnforcingConsecutiveErrors()
    The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx.
    int
    getEnforcingConsecutiveGatewayFailure()
    The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures.
    int
    getEnforcingSuccessRate()
    The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics.
    Duration
    getInterval()
    Time interval between ejection analysis sweeps.
    DurationOrBuilder
    getIntervalOrBuilder()
    Time interval between ejection analysis sweeps.
    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.
    int
    getSuccessRateMinimumHosts()
    The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers.
    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.
    int
    getSuccessRateStdevFactor()
    This factor is used to determine the ejection threshold for success rate outlier ejection.
    boolean
    hasBaseEjectionTime()
    The base time that a backend endpoint is ejected for.
    boolean
    hasConsecutiveErrors()
    Number of consecutive errors before a backend endpoint is ejected from the load balancing pool.
    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.
    boolean
    hasEnforcingConsecutiveErrors()
    The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx.
    boolean
    hasEnforcingConsecutiveGatewayFailure()
    The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures.
    boolean
    hasEnforcingSuccessRate()
    The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics.
    boolean
    hasInterval()
    Time interval between ejection analysis sweeps.
    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.
    boolean
    hasSuccessRateMinimumHosts()
    The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers.
    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.
    boolean
    hasSuccessRateStdevFactor()
    This factor is used to determine the ejection threshold for success rate outlier ejection.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasBaseEjectionTime

      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:
      Whether the baseEjectionTime field is set.

    • getBaseEjectionTime

      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:
      The baseEjectionTime.

    • getBaseEjectionTimeOrBuilder

      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;

    • hasConsecutiveErrors

      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:
      Whether the consecutiveErrors field is set.

    • getConsecutiveErrors

      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:
      The consecutiveErrors.

    • hasConsecutiveGatewayFailure

      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:
      Whether the consecutiveGatewayFailure field is set.

    • getConsecutiveGatewayFailure

      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:
      The consecutiveGatewayFailure.

    • hasEnforcingConsecutiveErrors

      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:
      Whether the enforcingConsecutiveErrors field is set.

    • getEnforcingConsecutiveErrors

      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:
      The enforcingConsecutiveErrors.

    • hasEnforcingConsecutiveGatewayFailure

      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:
      Whether the enforcingConsecutiveGatewayFailure field is set.

    • getEnforcingConsecutiveGatewayFailure

      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:
      The enforcingConsecutiveGatewayFailure.

    • hasEnforcingSuccessRate

      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:
      Whether the enforcingSuccessRate field is set.

    • getEnforcingSuccessRate

      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:
      The enforcingSuccessRate.

    • hasInterval

      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:
      Whether the interval field is set.

    • getInterval

      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:
      The interval.

    • getIntervalOrBuilder

      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;

    • hasMaxEjectionPercent

      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:
      Whether the maxEjectionPercent field is set.

    • getMaxEjectionPercent

      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:
      The maxEjectionPercent.

    • hasSuccessRateMinimumHosts

      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:
      Whether the successRateMinimumHosts field is set.

    • getSuccessRateMinimumHosts

      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:
      The successRateMinimumHosts.

    • hasSuccessRateRequestVolume

      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:
      Whether the successRateRequestVolume field is set.

    • getSuccessRateRequestVolume

      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:
      The successRateRequestVolume.

    • hasSuccessRateStdevFactor

      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:
      Whether the successRateStdevFactor field is set.

    • getSuccessRateStdevFactor

      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:
      The successRateStdevFactor.