Package io.envoyproxy.envoy.extensions.filters.http.composite.v3

Class Composite

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.composite.v3.Composite
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CompositeOrBuilder, Serializable
public final class Composite extends com.google.protobuf.GeneratedMessageV3 implements CompositeOrBuilder
 :ref:`Composite filter <config_http_filters_composite>` config. The composite filter config
 allows delegating filter handling to another filter as determined by matching on the request
 headers. This makes it possible to use different filters or filter configurations based on the
 incoming request.

 This is intended to be used with
 :ref:`ExtensionWithMatcher <envoy_v3_api_msg_extensions.common.matching.v3.ExtensionWithMatcher>`
 where a match tree is specified that indicates (via
 :ref:`ExecuteFilterAction <envoy_v3_api_msg_extensions.filters.http.composite.v3.ExecuteFilterAction>`)
 which filter configuration to create and delegate to.
Protobuf type envoy.extensions.filters.http.composite.v3.Composite
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Composite.Builder
    :ref:`Composite filter <config_http_filters_composite>` config.

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

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    NAMED_FILTER_CHAINS_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
    Description
    boolean
    containsNamedFilterChains(String key)
    Named filter chain definitions that can be referenced from :ref:`ExecuteFilterAction.filter_chain_name <envoy_v3_api_field_extensions.filters.http.composite.v3.ExecuteFilterAction.filter_chain_name>`.
    boolean
    equals(Object obj)
     
    static Composite
    getDefaultInstance()
     
    Composite
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    Map<String,FilterChainConfiguration>
    getNamedFilterChains()
    Deprecated.
    int
    getNamedFilterChainsCount()
    Named filter chain definitions that can be referenced from :ref:`ExecuteFilterAction.filter_chain_name <envoy_v3_api_field_extensions.filters.http.composite.v3.ExecuteFilterAction.filter_chain_name>`.
    Map<String,FilterChainConfiguration>
    getNamedFilterChainsMap()
    Named filter chain definitions that can be referenced from :ref:`ExecuteFilterAction.filter_chain_name <envoy_v3_api_field_extensions.filters.http.composite.v3.ExecuteFilterAction.filter_chain_name>`.
    FilterChainConfiguration
    getNamedFilterChainsOrDefault(String key, FilterChainConfiguration defaultValue)
    Named filter chain definitions that can be referenced from :ref:`ExecuteFilterAction.filter_chain_name <envoy_v3_api_field_extensions.filters.http.composite.v3.ExecuteFilterAction.filter_chain_name>`.
    FilterChainConfiguration
    getNamedFilterChainsOrThrow(String key)
    Named filter chain definitions that can be referenced from :ref:`ExecuteFilterAction.filter_chain_name <envoy_v3_api_field_extensions.filters.http.composite.v3.ExecuteFilterAction.filter_chain_name>`.
    com.google.protobuf.Parser<Composite>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMapFieldReflection(int number)
     
    final boolean
    isInitialized()
     
    static Composite.Builder
    newBuilder()
     
    static Composite.Builder
    newBuilder(Composite prototype)
     
    Composite.Builder
    newBuilderForType()
     
    protected Composite.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Composite
    parseDelimitedFrom(InputStream input)
     
    static Composite
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Composite
    parseFrom(byte[] data)
     
    static Composite
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Composite
    parseFrom(com.google.protobuf.ByteString data)
     
    static Composite
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Composite
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Composite
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Composite
    parseFrom(InputStream input)
     
    static Composite
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Composite
    parseFrom(ByteBuffer data)
     
    static Composite
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Composite>
    parser()
     
    Composite.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

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

    • NAMED_FILTER_CHAINS_FIELD_NUMBER

      public static final int NAMED_FILTER_CHAINS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

    • internalGetFieldAccessorTable

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

    • getNamedFilterChainsCount

      public int getNamedFilterChainsCount()
      Description copied from interface: CompositeOrBuilder
       Named filter chain definitions that can be referenced from
 :ref:`ExecuteFilterAction.filter_chain_name
 <envoy_v3_api_field_extensions.filters.http.composite.v3.ExecuteFilterAction.filter_chain_name>`.
 The filter chains are compiled at configuration time and can be referenced by name.
 This is useful when the same filter chain needs to be applied across many routes,
 as it avoids duplicating the filter chain configuration.
      map<string, .envoy.extensions.filters.http.composite.v3.FilterChainConfiguration> named_filter_chains = 1;
      Specified by:
      getNamedFilterChainsCount in interface CompositeOrBuilder

    • containsNamedFilterChains

      public boolean containsNamedFilterChains(String key)
       Named filter chain definitions that can be referenced from
 :ref:`ExecuteFilterAction.filter_chain_name
 <envoy_v3_api_field_extensions.filters.http.composite.v3.ExecuteFilterAction.filter_chain_name>`.
 The filter chains are compiled at configuration time and can be referenced by name.
 This is useful when the same filter chain needs to be applied across many routes,
 as it avoids duplicating the filter chain configuration.
      map<string, .envoy.extensions.filters.http.composite.v3.FilterChainConfiguration> named_filter_chains = 1;
      Specified by:
      containsNamedFilterChains in interface CompositeOrBuilder

    • getNamedFilterChains

      @Deprecated public Map<String,FilterChainConfiguration> getNamedFilterChains()
      Deprecated.
      Use getNamedFilterChainsMap() instead.
      Specified by:
      getNamedFilterChains in interface CompositeOrBuilder

    • getNamedFilterChainsMap

      public Map<String,FilterChainConfiguration> getNamedFilterChainsMap()
       Named filter chain definitions that can be referenced from
 :ref:`ExecuteFilterAction.filter_chain_name
 <envoy_v3_api_field_extensions.filters.http.composite.v3.ExecuteFilterAction.filter_chain_name>`.
 The filter chains are compiled at configuration time and can be referenced by name.
 This is useful when the same filter chain needs to be applied across many routes,
 as it avoids duplicating the filter chain configuration.
      map<string, .envoy.extensions.filters.http.composite.v3.FilterChainConfiguration> named_filter_chains = 1;
      Specified by:
      getNamedFilterChainsMap in interface CompositeOrBuilder

    • getNamedFilterChainsOrDefault

      public FilterChainConfiguration getNamedFilterChainsOrDefault(String key, FilterChainConfiguration defaultValue)
       Named filter chain definitions that can be referenced from
 :ref:`ExecuteFilterAction.filter_chain_name
 <envoy_v3_api_field_extensions.filters.http.composite.v3.ExecuteFilterAction.filter_chain_name>`.
 The filter chains are compiled at configuration time and can be referenced by name.
 This is useful when the same filter chain needs to be applied across many routes,
 as it avoids duplicating the filter chain configuration.
      map<string, .envoy.extensions.filters.http.composite.v3.FilterChainConfiguration> named_filter_chains = 1;
      Specified by:
      getNamedFilterChainsOrDefault in interface CompositeOrBuilder

    • getNamedFilterChainsOrThrow

      public FilterChainConfiguration getNamedFilterChainsOrThrow(String key)
       Named filter chain definitions that can be referenced from
 :ref:`ExecuteFilterAction.filter_chain_name
 <envoy_v3_api_field_extensions.filters.http.composite.v3.ExecuteFilterAction.filter_chain_name>`.
 The filter chains are compiled at configuration time and can be referenced by name.
 This is useful when the same filter chain needs to be applied across many routes,
 as it avoids duplicating the filter chain configuration.
      map<string, .envoy.extensions.filters.http.composite.v3.FilterChainConfiguration> named_filter_chains = 1;
      Specified by:
      getNamedFilterChainsOrThrow in interface CompositeOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Composite.Builder newBuilder()

    • newBuilder

      public static Composite.Builder newBuilder(Composite prototype)

    • toBuilder

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

    • newBuilderForType

      protected Composite.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Composite getDefaultInstance()

    • parser

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

    • getParserForType

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