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
@Generated 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:

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

      private volatile Object runtimeKey_

    • PERCENT_SAMPLED_FIELD_NUMBER

      public static final int PERCENT_SAMPLED_FIELD_NUMBER
      See Also:

    • percentSampled_

      private FractionalPercent 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

      private static final RuntimeFilter DEFAULT_INSTANCE

    • PARSER

      private static final com.google.protobuf.Parser<RuntimeFilter> 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()

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

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

    • getRuntimeKey

      public 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 interface RuntimeFilterOrBuilder
      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 interface RuntimeFilterOrBuilder
      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 interface RuntimeFilterOrBuilder
      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 interface RuntimeFilterOrBuilder
      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 interface RuntimeFilterOrBuilder

    • 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 interface RuntimeFilterOrBuilder
      Returns:
      The useIndependentRandomness.

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

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

      public static RuntimeFilter parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static RuntimeFilter parseDelimitedFrom(InputStream input) throws IOException
      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

      public RuntimeFilter.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.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 interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected RuntimeFilter.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.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 interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

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