Package io.envoyproxy.envoy.extensions.filters.http.admission_control.v3

Interface AdmissionControlOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    AdmissionControl, AdmissionControl.Builder
    public interface AdmissionControlOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      RuntimeDouble getAggression()
      Rejection probability is defined by the formula:: max(0, (rq_count - rq_success_count / sr_threshold) / (rq_count + 1)) ^ (1 / aggression) The aggression dictates how heavily the admission controller will throttle requests upon SR dropping at or below the threshold.
      RuntimeDoubleOrBuilder getAggressionOrBuilder()
      Rejection probability is defined by the formula:: max(0, (rq_count - rq_success_count / sr_threshold) / (rq_count + 1)) ^ (1 / aggression) The aggression dictates how heavily the admission controller will throttle requests upon SR dropping at or below the threshold.
      RuntimeFeatureFlag getEnabled()
      If set to false, the admission control filter will operate as a pass-through filter.
      RuntimeFeatureFlagOrBuilder getEnabledOrBuilder()
      If set to false, the admission control filter will operate as a pass-through filter.
      AdmissionControl.EvaluationCriteriaCase getEvaluationCriteriaCase()  
      RuntimePercent getMaxRejectionProbability()
      The probability of rejection will never exceed this value, even if the failure rate is rising.
      RuntimePercentOrBuilder getMaxRejectionProbabilityOrBuilder()
      The probability of rejection will never exceed this value, even if the failure rate is rising.
      RuntimeUInt32 getRpsThreshold()
      If the average RPS of the sampling window is below this threshold, the request will not be rejected, even if the success rate is lower than sr_threshold.
      RuntimeUInt32OrBuilder getRpsThresholdOrBuilder()
      If the average RPS of the sampling window is below this threshold, the request will not be rejected, even if the success rate is lower than sr_threshold.
      com.google.protobuf.Duration getSamplingWindow()
      The sliding time window over which the success rate is calculated.
      com.google.protobuf.DurationOrBuilder getSamplingWindowOrBuilder()
      The sliding time window over which the success rate is calculated.
      RuntimePercent getSrThreshold()
      Dictates the success rate at which the rejection probability is non-zero.
      RuntimePercentOrBuilder getSrThresholdOrBuilder()
      Dictates the success rate at which the rejection probability is non-zero.
      AdmissionControl.SuccessCriteria getSuccessCriteria()
      .envoy.extensions.filters.http.admission_control.v3.AdmissionControl.SuccessCriteria success_criteria = 2;
      AdmissionControl.SuccessCriteriaOrBuilder getSuccessCriteriaOrBuilder()
      .envoy.extensions.filters.http.admission_control.v3.AdmissionControl.SuccessCriteria success_criteria = 2;
      boolean hasAggression()
      Rejection probability is defined by the formula:: max(0, (rq_count - rq_success_count / sr_threshold) / (rq_count + 1)) ^ (1 / aggression) The aggression dictates how heavily the admission controller will throttle requests upon SR dropping at or below the threshold.
      boolean hasEnabled()
      If set to false, the admission control filter will operate as a pass-through filter.
      boolean hasMaxRejectionProbability()
      The probability of rejection will never exceed this value, even if the failure rate is rising.
      boolean hasRpsThreshold()
      If the average RPS of the sampling window is below this threshold, the request will not be rejected, even if the success rate is lower than sr_threshold.
      boolean hasSamplingWindow()
      The sliding time window over which the success rate is calculated.
      boolean hasSrThreshold()
      Dictates the success rate at which the rejection probability is non-zero.
      boolean hasSuccessCriteria()
      .envoy.extensions.filters.http.admission_control.v3.AdmissionControl.SuccessCriteria success_criteria = 2;

      • 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 Detail

      • hasEnabled

        boolean hasEnabled()
         If set to false, the admission control filter will operate as a pass-through filter. If the
 message is unspecified, the filter will be enabled.
        .envoy.config.core.v3.RuntimeFeatureFlag enabled = 1;
        Returns:
        Whether the enabled field is set.

      • getEnabled

        RuntimeFeatureFlag getEnabled()
         If set to false, the admission control filter will operate as a pass-through filter. If the
 message is unspecified, the filter will be enabled.
        .envoy.config.core.v3.RuntimeFeatureFlag enabled = 1;
        Returns:
        The enabled.

      • getEnabledOrBuilder

        RuntimeFeatureFlagOrBuilder getEnabledOrBuilder()
         If set to false, the admission control filter will operate as a pass-through filter. If the
 message is unspecified, the filter will be enabled.
        .envoy.config.core.v3.RuntimeFeatureFlag enabled = 1;

      • hasSuccessCriteria

        boolean hasSuccessCriteria()
        .envoy.extensions.filters.http.admission_control.v3.AdmissionControl.SuccessCriteria success_criteria = 2;
        Returns:
        Whether the successCriteria field is set.

      • getSuccessCriteria

        AdmissionControl.SuccessCriteria getSuccessCriteria()
        .envoy.extensions.filters.http.admission_control.v3.AdmissionControl.SuccessCriteria success_criteria = 2;
        Returns:
        The successCriteria.

      • getSuccessCriteriaOrBuilder

        AdmissionControl.SuccessCriteriaOrBuilder getSuccessCriteriaOrBuilder()
        .envoy.extensions.filters.http.admission_control.v3.AdmissionControl.SuccessCriteria success_criteria = 2;

      • hasSamplingWindow

        boolean hasSamplingWindow()
         The sliding time window over which the success rate is calculated. The window is rounded to the
 nearest second. Defaults to 30s.
        .google.protobuf.Duration sampling_window = 3;
        Returns:
        Whether the samplingWindow field is set.

      • getSamplingWindow

        com.google.protobuf.Duration getSamplingWindow()
         The sliding time window over which the success rate is calculated. The window is rounded to the
 nearest second. Defaults to 30s.
        .google.protobuf.Duration sampling_window = 3;
        Returns:
        The samplingWindow.

      • getSamplingWindowOrBuilder

        com.google.protobuf.DurationOrBuilder getSamplingWindowOrBuilder()
         The sliding time window over which the success rate is calculated. The window is rounded to the
 nearest second. Defaults to 30s.
        .google.protobuf.Duration sampling_window = 3;

      • hasAggression

        boolean hasAggression()
         Rejection probability is defined by the formula::
     max(0, (rq_count -  rq_success_count / sr_threshold) / (rq_count + 1)) ^ (1 / aggression)
 The aggression dictates how heavily the admission controller will throttle requests upon SR
 dropping at or below the threshold. A value of 1 will result in a linear increase in
 rejection probability as SR drops. Any values less than 1.0, will be set to 1.0. If the
 message is unspecified, the aggression is 1.0. See `the admission control documentation
 <https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/admission_control_filter.html>`_
 for a diagram illustrating this.
        .envoy.config.core.v3.RuntimeDouble aggression = 4;
        Returns:
        Whether the aggression field is set.

      • getAggression

        RuntimeDouble getAggression()
         Rejection probability is defined by the formula::
     max(0, (rq_count -  rq_success_count / sr_threshold) / (rq_count + 1)) ^ (1 / aggression)
 The aggression dictates how heavily the admission controller will throttle requests upon SR
 dropping at or below the threshold. A value of 1 will result in a linear increase in
 rejection probability as SR drops. Any values less than 1.0, will be set to 1.0. If the
 message is unspecified, the aggression is 1.0. See `the admission control documentation
 <https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/admission_control_filter.html>`_
 for a diagram illustrating this.
        .envoy.config.core.v3.RuntimeDouble aggression = 4;
        Returns:
        The aggression.

      • getAggressionOrBuilder

        RuntimeDoubleOrBuilder getAggressionOrBuilder()
         Rejection probability is defined by the formula::
     max(0, (rq_count -  rq_success_count / sr_threshold) / (rq_count + 1)) ^ (1 / aggression)
 The aggression dictates how heavily the admission controller will throttle requests upon SR
 dropping at or below the threshold. A value of 1 will result in a linear increase in
 rejection probability as SR drops. Any values less than 1.0, will be set to 1.0. If the
 message is unspecified, the aggression is 1.0. See `the admission control documentation
 <https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/admission_control_filter.html>`_
 for a diagram illustrating this.
        .envoy.config.core.v3.RuntimeDouble aggression = 4;

      • hasSrThreshold

        boolean hasSrThreshold()
         Dictates the success rate at which the rejection probability is non-zero. As success rate drops
 below this threshold, rejection probability will increase. Any success rate above the threshold
 results in a rejection probability of 0. Defaults to 95%.
        .envoy.config.core.v3.RuntimePercent sr_threshold = 5;
        Returns:
        Whether the srThreshold field is set.

      • getSrThreshold

        RuntimePercent getSrThreshold()
         Dictates the success rate at which the rejection probability is non-zero. As success rate drops
 below this threshold, rejection probability will increase. Any success rate above the threshold
 results in a rejection probability of 0. Defaults to 95%.
        .envoy.config.core.v3.RuntimePercent sr_threshold = 5;
        Returns:
        The srThreshold.

      • getSrThresholdOrBuilder

        RuntimePercentOrBuilder getSrThresholdOrBuilder()
         Dictates the success rate at which the rejection probability is non-zero. As success rate drops
 below this threshold, rejection probability will increase. Any success rate above the threshold
 results in a rejection probability of 0. Defaults to 95%.
        .envoy.config.core.v3.RuntimePercent sr_threshold = 5;

      • hasRpsThreshold

        boolean hasRpsThreshold()
         If the average RPS of the sampling window is below this threshold, the request
 will not be rejected, even if the success rate is lower than sr_threshold.
 Defaults to 0.
        .envoy.config.core.v3.RuntimeUInt32 rps_threshold = 6;
        Returns:
        Whether the rpsThreshold field is set.

      • getRpsThreshold

        RuntimeUInt32 getRpsThreshold()
         If the average RPS of the sampling window is below this threshold, the request
 will not be rejected, even if the success rate is lower than sr_threshold.
 Defaults to 0.
        .envoy.config.core.v3.RuntimeUInt32 rps_threshold = 6;
        Returns:
        The rpsThreshold.

      • getRpsThresholdOrBuilder

        RuntimeUInt32OrBuilder getRpsThresholdOrBuilder()
         If the average RPS of the sampling window is below this threshold, the request
 will not be rejected, even if the success rate is lower than sr_threshold.
 Defaults to 0.
        .envoy.config.core.v3.RuntimeUInt32 rps_threshold = 6;

      • hasMaxRejectionProbability

        boolean hasMaxRejectionProbability()
         The probability of rejection will never exceed this value, even if the failure rate is rising.
 Defaults to 80%.
        .envoy.config.core.v3.RuntimePercent max_rejection_probability = 7;
        Returns:
        Whether the maxRejectionProbability field is set.

      • getMaxRejectionProbability

        RuntimePercent getMaxRejectionProbability()
         The probability of rejection will never exceed this value, even if the failure rate is rising.
 Defaults to 80%.
        .envoy.config.core.v3.RuntimePercent max_rejection_probability = 7;
        Returns:
        The maxRejectionProbability.

      • getMaxRejectionProbabilityOrBuilder

        RuntimePercentOrBuilder getMaxRejectionProbabilityOrBuilder()
         The probability of rejection will never exceed this value, even if the failure rate is rising.
 Defaults to 80%.
        .envoy.config.core.v3.RuntimePercent max_rejection_probability = 7;