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
,java.io.Serializable
public final class RuntimeFilter extends com.google.protobuf.GeneratedMessage implements RuntimeFilterOrBuilder
Filters for random sampling of requests.
Protobuf typeenvoy.config.accesslog.v3.RuntimeFilter
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RuntimeFilter.Builder
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 extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description private int
bitField0_
private static RuntimeFilter
DEFAULT_INSTANCE
private byte
memoizedIsInitialized
private static com.google.protobuf.Parser<RuntimeFilter>
PARSER
static int
PERCENT_SAMPLED_FIELD_NUMBER
private FractionalPercent
percentSampled_
static int
RUNTIME_KEY_FIELD_NUMBER
private java.lang.Object
runtimeKey_
private static long
serialVersionUID
static int
USE_INDEPENDENT_RANDOMNESS_FIELD_NUMBER
private boolean
useIndependentRandomness_
-
Constructor Summary
Constructors Modifier Constructor Description private
RuntimeFilter()
private
RuntimeFilter(com.google.protobuf.GeneratedMessage.Builder<?> builder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
static RuntimeFilter
getDefaultInstance()
RuntimeFilter
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
com.google.protobuf.Parser<RuntimeFilter>
getParserForType()
FractionalPercent
getPercentSampled()
The default sampling percentage.FractionalPercentOrBuilder
getPercentSampledOrBuilder()
The default sampling percentage.java.lang.String
getRuntimeKey()
Runtime key to get an optional overridden numerator for use in the ``percent_sampled`` field.com.google.protobuf.ByteString
getRuntimeKeyBytes()
Runtime key to get an optional overridden numerator for use in the ``percent_sampled`` field.int
getSerializedSize()
boolean
getUseIndependentRandomness()
By default, sampling pivots on the header :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` being present.int
hashCode()
boolean
hasPercentSampled()
The default sampling percentage.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static RuntimeFilter.Builder
newBuilder()
static RuntimeFilter.Builder
newBuilder(RuntimeFilter prototype)
RuntimeFilter.Builder
newBuilderForType()
protected RuntimeFilter.Builder
newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static RuntimeFilter
parseDelimitedFrom(java.io.InputStream input)
static RuntimeFilter
parseDelimitedFrom(java.io.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(java.io.InputStream input)
static RuntimeFilter
parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RuntimeFilter
parseFrom(java.nio.ByteBuffer data)
static RuntimeFilter
parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RuntimeFilter>
parser()
RuntimeFilter.Builder
toBuilder()
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
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
bitField0_
private int bitField0_
-
RUNTIME_KEY_FIELD_NUMBER
public static final int RUNTIME_KEY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
runtimeKey_
private volatile java.lang.Object runtimeKey_
-
PERCENT_SAMPLED_FIELD_NUMBER
public static final int PERCENT_SAMPLED_FIELD_NUMBER
- See Also:
- Constant Field Values
-
percentSampled_
private FractionalPercent percentSampled_
-
USE_INDEPENDENT_RANDOMNESS_FIELD_NUMBER
public static final int USE_INDEPENDENT_RANDOMNESS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
useIndependentRandomness_
private boolean useIndependentRandomness_
-
memoizedIsInitialized
private byte memoizedIsInitialized
-
DEFAULT_INSTANCE
private static final RuntimeFilter DEFAULT_INSTANCE
-
PARSER
private static final com.google.protobuf.Parser<RuntimeFilter> PARSER
-
-
Method Detail
-
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
public java.lang.String 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
public FractionalPercent 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
public FractionalPercentOrBuilder 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
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
java.io.IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
public boolean equals(java.lang.Object obj)
- 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(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RuntimeFilter parseFrom(java.nio.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
public static RuntimeFilter parseFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static RuntimeFilter parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static RuntimeFilter parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static RuntimeFilter parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static RuntimeFilter parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static RuntimeFilter parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilderForType
public RuntimeFilter.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static RuntimeFilter.Builder newBuilder()
-
newBuilder
public static RuntimeFilter.Builder newBuilder(RuntimeFilter prototype)
-
toBuilder
public RuntimeFilter.Builder 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
public static RuntimeFilter getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<RuntimeFilter> parser()
-
getParserForType
public com.google.protobuf.Parser<RuntimeFilter> 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
public RuntimeFilter getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-