Class FilterConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.route.v3.FilterConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, FilterConfigOrBuilder, Serializable
@Generated public final class FilterConfig extends com.google.protobuf.GeneratedMessage implements FilterConfigOrBuilder
A simple wrapper for an HTTP filter config. This is intended to be used as a wrapper for the
map value in
:ref:`VirtualHost.typed_per_filter_config<envoy_v3_api_field_config.route.v3.VirtualHost.typed_per_filter_config>`,
:ref:`Route.typed_per_filter_config<envoy_v3_api_field_config.route.v3.Route.typed_per_filter_config>`,
or :ref:`WeightedCluster.ClusterWeight.typed_per_filter_config<envoy_v3_api_field_config.route.v3.WeightedCluster.ClusterWeight.typed_per_filter_config>`
to add additional flags to the filter.
Protobuf type envoy.config.route.v3.FilterConfig
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    FilterConfig.Builder
    A simple wrapper for an HTTP filter config.

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

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT, 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

    Fields
    Modifier and Type
    Field
    Description
    private int
    bitField0_
     
    private com.google.protobuf.Any
    config_
     
    static final int
    CONFIG_FIELD_NUMBER
     
    private static final FilterConfig
    DEFAULT_INSTANCE
     
    private boolean
    disabled_
     
    static final int
    DISABLED_FIELD_NUMBER
     
    static final int
    IS_OPTIONAL_FIELD_NUMBER
     
    private boolean
    isOptional_
     
    private byte
    memoizedIsInitialized
     
    private static final com.google.protobuf.Parser<FilterConfig>
    PARSER
     
    private static final long
    serialVersionUID
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    FilterConfig()
     
    private
    FilterConfig(com.google.protobuf.GeneratedMessage.Builder<?> builder)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    com.google.protobuf.Any
    getConfig()
    The filter config.
    com.google.protobuf.AnyOrBuilder
    getConfigOrBuilder()
    The filter config.
    static FilterConfig
    getDefaultInstance()
     
    FilterConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    boolean
    getDisabled()
    If true, the filter is disabled in the route or virtual host and the ``config`` field is ignored.
    boolean
    getIsOptional()
    If true, the filter is optional, meaning that if the client does not support the specified filter, it may ignore the map entry rather than rejecting the config.
    com.google.protobuf.Parser<FilterConfig>
    getParserForType()
     
    int
    getSerializedSize()
     
    boolean
    hasConfig()
    The filter config.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static FilterConfig.Builder
    newBuilder()
     
    static FilterConfig.Builder
    newBuilder(FilterConfig prototype)
     
    FilterConfig.Builder
    newBuilderForType()
     
    protected FilterConfig.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static FilterConfig
    parseDelimitedFrom(InputStream input)
     
    static FilterConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FilterConfig
    parseFrom(byte[] data)
     
    static FilterConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FilterConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static FilterConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FilterConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static FilterConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FilterConfig
    parseFrom(InputStream input)
     
    static FilterConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FilterConfig
    parseFrom(ByteBuffer data)
     
    static FilterConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<FilterConfig>
    parser()
     
    FilterConfig.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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 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, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • bitField0_

      private int bitField0_

    • CONFIG_FIELD_NUMBER

      public static final int CONFIG_FIELD_NUMBER
      See Also:

    • config_

      private com.google.protobuf.Any config_

    • IS_OPTIONAL_FIELD_NUMBER

      public static final int IS_OPTIONAL_FIELD_NUMBER
      See Also:

    • isOptional_

      private boolean isOptional_

    • DISABLED_FIELD_NUMBER

      public static final int DISABLED_FIELD_NUMBER
      See Also:

    • disabled_

      private boolean disabled_

    • memoizedIsInitialized

      private byte memoizedIsInitialized

    • DEFAULT_INSTANCE

      private static final FilterConfig DEFAULT_INSTANCE

    • PARSER

      private static final com.google.protobuf.Parser<FilterConfig> PARSER

  • Constructor Details

    • FilterConfig

      private FilterConfig(com.google.protobuf.GeneratedMessage.Builder<?> builder)

    • FilterConfig

      private FilterConfig()

  • 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

    • hasConfig

      public boolean hasConfig()
      The filter config.
      .google.protobuf.Any config = 1;
      Specified by:
      hasConfig in interface FilterConfigOrBuilder
      Returns:
      Whether the config field is set.

    • getConfig

      public com.google.protobuf.Any getConfig()
      The filter config.
      .google.protobuf.Any config = 1;
      Specified by:
      getConfig in interface FilterConfigOrBuilder
      Returns:
      The config.

    • getConfigOrBuilder

      public com.google.protobuf.AnyOrBuilder getConfigOrBuilder()
      The filter config.
      .google.protobuf.Any config = 1;
      Specified by:
      getConfigOrBuilder in interface FilterConfigOrBuilder

    • getIsOptional

      public boolean getIsOptional()
      If true, the filter is optional, meaning that if the client does
not support the specified filter, it may ignore the map entry rather
than rejecting the config.
      bool is_optional = 2;
      Specified by:
      getIsOptional in interface FilterConfigOrBuilder
      Returns:
      The isOptional.

    • getDisabled

      public boolean getDisabled()
      If true, the filter is disabled in the route or virtual host and the ``config`` field is ignored.
See :ref:`route based filter chain <arch_overview_http_filters_route_based_filter_chain>`
for more details.

.. note::

This field will take effect when the request arrive and filter chain is created for the request.
If initial route is selected for the request and a filter is disabled in the initial route, then
the filter will not be added to the filter chain.
And if the request is mutated later and re-match to another route, the disabled filter by the
initial route will not be added back to the filter chain because the filter chain is already
created and it is too late to change the chain.

This field only make sense for the downstream HTTP filters for now.
      bool disabled = 3;
      Specified by:
      getDisabled in interface FilterConfigOrBuilder
      Returns:
      The disabled.

    • 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 FilterConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

      public static FilterConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static FilterConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static FilterConfig.Builder newBuilder()

    • newBuilder

      public static FilterConfig.Builder newBuilder(FilterConfig prototype)

    • toBuilder

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

    • newBuilderForType

      protected FilterConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static FilterConfig getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<FilterConfig> 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 FilterConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder