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

Class AdmissionControl

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, AdmissionControlOrBuilder, Serializable
    public final class AdmissionControl
extends com.google.protobuf.GeneratedMessageV3
implements AdmissionControlOrBuilder
     [#next-free-field: 8]
    Protobuf type envoy.extensions.filters.http.admission_control.v3.AdmissionControl
    See Also:
    Serialized Form

    • Field Detail

      • SUCCESS_CRITERIA_FIELD_NUMBER

        public static final int SUCCESS_CRITERIA_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SAMPLING_WINDOW_FIELD_NUMBER

        public static final int SAMPLING_WINDOW_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AGGRESSION_FIELD_NUMBER

        public static final int AGGRESSION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SR_THRESHOLD_FIELD_NUMBER

        public static final int SR_THRESHOLD_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RPS_THRESHOLD_FIELD_NUMBER

        public static final int RPS_THRESHOLD_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MAX_REJECTION_PROBABILITY_FIELD_NUMBER

        public static final int MAX_REJECTION_PROBABILITY_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasEnabled

        public 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;
        Specified by:
        hasEnabled in interface AdmissionControlOrBuilder
        Returns:
        Whether the enabled field is set.

      • getEnabled

        public 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;
        Specified by:
        getEnabled in interface AdmissionControlOrBuilder
        Returns:
        The enabled.

      • hasSuccessCriteria

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

      • hasSamplingWindow

        public 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;
        Specified by:
        hasSamplingWindow in interface AdmissionControlOrBuilder
        Returns:
        Whether the samplingWindow field is set.

      • getSamplingWindow

        public 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;
        Specified by:
        getSamplingWindow in interface AdmissionControlOrBuilder
        Returns:
        The samplingWindow.

      • getSamplingWindowOrBuilder

        public 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;
        Specified by:
        getSamplingWindowOrBuilder in interface AdmissionControlOrBuilder

      • hasAggression

        public 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;
        Specified by:
        hasAggression in interface AdmissionControlOrBuilder
        Returns:
        Whether the aggression field is set.

      • getAggression

        public 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;
        Specified by:
        getAggression in interface AdmissionControlOrBuilder
        Returns:
        The aggression.

      • getAggressionOrBuilder

        public 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;
        Specified by:
        getAggressionOrBuilder in interface AdmissionControlOrBuilder

      • hasSrThreshold

        public 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;
        Specified by:
        hasSrThreshold in interface AdmissionControlOrBuilder
        Returns:
        Whether the srThreshold field is set.

      • getSrThreshold

        public 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;
        Specified by:
        getSrThreshold in interface AdmissionControlOrBuilder
        Returns:
        The srThreshold.

      • getSrThresholdOrBuilder

        public 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;
        Specified by:
        getSrThresholdOrBuilder in interface AdmissionControlOrBuilder

      • hasRpsThreshold

        public 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;
        Specified by:
        hasRpsThreshold in interface AdmissionControlOrBuilder
        Returns:
        Whether the rpsThreshold field is set.

      • getRpsThreshold

        public 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;
        Specified by:
        getRpsThreshold in interface AdmissionControlOrBuilder
        Returns:
        The rpsThreshold.

      • getRpsThresholdOrBuilder

        public 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;
        Specified by:
        getRpsThresholdOrBuilder in interface AdmissionControlOrBuilder

      • hasMaxRejectionProbability

        public 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;
        Specified by:
        hasMaxRejectionProbability in interface AdmissionControlOrBuilder
        Returns:
        Whether the maxRejectionProbability field is set.

      • getMaxRejectionProbability

        public 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;
        Specified by:
        getMaxRejectionProbability in interface AdmissionControlOrBuilder
        Returns:
        The maxRejectionProbability.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static AdmissionControl parseFrom​(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AdmissionControl parseFrom​(ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AdmissionControl parseFrom​(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AdmissionControl parseFrom​(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AdmissionControl parseFrom​(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AdmissionControl parseFrom​(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AdmissionControl parseFrom​(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException
        Throws:
        IOException

      • newBuilderForType

        public AdmissionControl.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public AdmissionControl.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected AdmissionControl.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<AdmissionControl> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public AdmissionControl getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder