Class RuntimeFilter
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.accesslog.v3.RuntimeFilter
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,RuntimeFilterOrBuilder
,Serializable
public final class RuntimeFilter
extends com.google.protobuf.GeneratedMessage
implements RuntimeFilterOrBuilder
Filters for random sampling of requests.Protobuf type
envoy.config.accesslog.v3.RuntimeFilter
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
Filters for random sampling of requests.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private static final RuntimeFilter
private byte
private static final com.google.protobuf.Parser
<RuntimeFilter> static final int
private FractionalPercent
static final int
private Object
private static final long
static final int
private boolean
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
private
RuntimeFilter
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
static RuntimeFilter
static final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.Parser
<RuntimeFilter> The default sampling percentage.The default sampling percentage.Runtime key to get an optional overridden numerator for use in the ``percent_sampled`` field.com.google.protobuf.ByteString
Runtime key to get an optional overridden numerator for use in the ``percent_sampled`` field.int
boolean
By default, sampling pivots on the header :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` being present.int
hashCode()
boolean
The default sampling percentage.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
static RuntimeFilter.Builder
static RuntimeFilter.Builder
newBuilder
(RuntimeFilter prototype) protected RuntimeFilter.Builder
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) static RuntimeFilter
parseDelimitedFrom
(InputStream input) static RuntimeFilter
parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static RuntimeFilter
parseFrom
(byte[] data) static RuntimeFilter
parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static RuntimeFilter
parseFrom
(com.google.protobuf.ByteString data) static RuntimeFilter
parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static RuntimeFilter
parseFrom
(com.google.protobuf.CodedInputStream input) static RuntimeFilter
parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static RuntimeFilter
parseFrom
(InputStream input) static RuntimeFilter
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static RuntimeFilter
parseFrom
(ByteBuffer data) static RuntimeFilter
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<RuntimeFilter> parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
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.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
bitField0_
private int bitField0_ -
RUNTIME_KEY_FIELD_NUMBER
public static final int RUNTIME_KEY_FIELD_NUMBER- See Also:
-
runtimeKey_
-
PERCENT_SAMPLED_FIELD_NUMBER
public static final int PERCENT_SAMPLED_FIELD_NUMBER- See Also:
-
percentSampled_
-
USE_INDEPENDENT_RANDOMNESS_FIELD_NUMBER
public static final int USE_INDEPENDENT_RANDOMNESS_FIELD_NUMBER- See Also:
-
useIndependentRandomness_
private boolean useIndependentRandomness_ -
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
RuntimeFilter
private RuntimeFilter(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
RuntimeFilter
private RuntimeFilter()
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage
-
getRuntimeKey
Runtime key to get an optional overridden numerator for use in the ``percent_sampled`` field. If found in runtime, this value will replace the default numerator.
string runtime_key = 1 [(.validate.rules) = { ... }
- Specified by:
getRuntimeKey
in interfaceRuntimeFilterOrBuilder
- Returns:
- The runtimeKey.
-
getRuntimeKeyBytes
public com.google.protobuf.ByteString getRuntimeKeyBytes()Runtime key to get an optional overridden numerator for use in the ``percent_sampled`` field. If found in runtime, this value will replace the default numerator.
string runtime_key = 1 [(.validate.rules) = { ... }
- Specified by:
getRuntimeKeyBytes
in interfaceRuntimeFilterOrBuilder
- Returns:
- The bytes for runtimeKey.
-
hasPercentSampled
public boolean hasPercentSampled()The default sampling percentage. If not specified, defaults to 0% with denominator of 100.
.envoy.type.v3.FractionalPercent percent_sampled = 2;
- Specified by:
hasPercentSampled
in interfaceRuntimeFilterOrBuilder
- Returns:
- Whether the percentSampled field is set.
-
getPercentSampled
The default sampling percentage. If not specified, defaults to 0% with denominator of 100.
.envoy.type.v3.FractionalPercent percent_sampled = 2;
- Specified by:
getPercentSampled
in interfaceRuntimeFilterOrBuilder
- Returns:
- The percentSampled.
-
getPercentSampledOrBuilder
The default sampling percentage. If not specified, defaults to 0% with denominator of 100.
.envoy.type.v3.FractionalPercent percent_sampled = 2;
- Specified by:
getPercentSampledOrBuilder
in interfaceRuntimeFilterOrBuilder
-
getUseIndependentRandomness
public boolean getUseIndependentRandomness()By default, sampling pivots on the header :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` being present. If :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` is present, the filter will consistently sample across multiple hosts based on the runtime key value and the value extracted from :ref:`x-request-id<config_http_conn_man_headers_x-request-id>`. If it is missing, or ``use_independent_randomness`` is set to true, the filter will randomly sample based on the runtime key value alone. ``use_independent_randomness`` can be used for logging kill switches within complex nested :ref:`AndFilter <envoy_v3_api_msg_config.accesslog.v3.AndFilter>` and :ref:`OrFilter <envoy_v3_api_msg_config.accesslog.v3.OrFilter>` blocks that are easier to reason about from a probability perspective (i.e., setting to true will cause the filter to behave like an independent random variable when composed within logical operator filters).
bool use_independent_randomness = 3;
- Specified by:
getUseIndependentRandomness
in interfaceRuntimeFilterOrBuilder
- Returns:
- The useIndependentRandomness.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static RuntimeFilter parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RuntimeFilter parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RuntimeFilter parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RuntimeFilter parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RuntimeFilter parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RuntimeFilter parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static RuntimeFilter parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static RuntimeFilter parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static RuntimeFilter parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static RuntimeFilter parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected RuntimeFilter.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-