io.envoyproxy.envoy.extensions.filters.http.admission_control.v3alpha

Class AdmissionControl

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.extensions.filters.http.admission_control.v3alpha.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: 6]
 

Protobuf type envoy.extensions.filters.http.admission_control.v3alpha.AdmissionControl

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AdmissionControl.Builder [#next-free-field: 6] Protobuf type envoy.extensions.filters.http.admission_control.v3alpha.AdmissionControl
static class	AdmissionControl.EvaluationCriteriaCase
static class	AdmissionControl.SuccessCriteria Default method of specifying what constitutes a successful request.
static interface	AdmissionControl.SuccessCriteriaOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields

Modifier and Type	Field and Description
static int	AGGRESSION_FIELD_NUMBER
static int	ENABLED_FIELD_NUMBER
static int	SAMPLING_WINDOW_FIELD_NUMBER
static int	SR_THRESHOLD_FIELD_NUMBER
static int	SUCCESS_CRITERIA_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
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.
static AdmissionControl	getDefaultInstance()
AdmissionControl	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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()
com.google.protobuf.Parser<AdmissionControl>	getParserForType()
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.
int	getSerializedSize()
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.v3alpha.AdmissionControl.SuccessCriteria success_criteria = 2;
AdmissionControl.SuccessCriteriaOrBuilder	getSuccessCriteriaOrBuilder() .envoy.extensions.filters.http.admission_control.v3alpha.AdmissionControl.SuccessCriteria success_criteria = 2;
com.google.protobuf.UnknownFieldSet	getUnknownFields()
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.
int	hashCode()
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.v3alpha.AdmissionControl.SuccessCriteria success_criteria = 2;
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static AdmissionControl.Builder	newBuilder()
static AdmissionControl.Builder	newBuilder(AdmissionControl prototype)
AdmissionControl.Builder	newBuilderForType()
protected AdmissionControl.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static AdmissionControl	parseDelimitedFrom(InputStream input)
static AdmissionControl	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AdmissionControl	parseFrom(byte[] data)
static AdmissionControl	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AdmissionControl	parseFrom(ByteBuffer data)
static AdmissionControl	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AdmissionControl	parseFrom(com.google.protobuf.ByteString data)
static AdmissionControl	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AdmissionControl	parseFrom(com.google.protobuf.CodedInputStream input)
static AdmissionControl	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AdmissionControl	parseFrom(InputStream input)
static AdmissionControl	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<AdmissionControl>	parser()
AdmissionControl.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

ENABLED_FIELD_NUMBER

public static final int ENABLED_FIELD_NUMBER

See Also:

Constant Field Values

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

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

getEvaluationCriteriaCase

public AdmissionControl.EvaluationCriteriaCase getEvaluationCriteriaCase()

Specified by:

getEvaluationCriteriaCase in interface AdmissionControlOrBuilder

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

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

getEnabledOrBuilder

public 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;

Specified by:

getEnabledOrBuilder in interface AdmissionControlOrBuilder

hasSuccessCriteria

public boolean hasSuccessCriteria()

.envoy.extensions.filters.http.admission_control.v3alpha.AdmissionControl.SuccessCriteria success_criteria = 2;

Specified by:

hasSuccessCriteria in interface AdmissionControlOrBuilder

getSuccessCriteria

public AdmissionControl.SuccessCriteria getSuccessCriteria()

.envoy.extensions.filters.http.admission_control.v3alpha.AdmissionControl.SuccessCriteria success_criteria = 2;

Specified by:

getSuccessCriteria in interface AdmissionControlOrBuilder

getSuccessCriteriaOrBuilder

public AdmissionControl.SuccessCriteriaOrBuilder getSuccessCriteriaOrBuilder()

.envoy.extensions.filters.http.admission_control.v3alpha.AdmissionControl.SuccessCriteria success_criteria = 2;

Specified by:

getSuccessCriteriaOrBuilder in interface AdmissionControlOrBuilder

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

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

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

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

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

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

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

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(InputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static AdmissionControl parseFrom(InputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static AdmissionControl parseDelimitedFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static AdmissionControl parseDelimitedFrom(InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

parseFrom

public static AdmissionControl parseFrom(com.google.protobuf.CodedInputStream input)
                                  throws IOException

Throws:

IOException

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

newBuilder

public static AdmissionControl.Builder newBuilder()

newBuilder

public static AdmissionControl.Builder newBuilder(AdmissionControl prototype)

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

getDefaultInstance

public static AdmissionControl getDefaultInstance()

parser

public static com.google.protobuf.Parser<AdmissionControl> parser()

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