Package io.envoyproxy.envoy.api.v2.listener

Interface FilterChainOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
FilterChain, FilterChain.Builder
public interface FilterChainOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    FilterChainMatch
    getFilterChainMatch()
    The criteria to use when matching a connection to this filter chain.
    FilterChainMatchOrBuilder
    getFilterChainMatchOrBuilder()
    The criteria to use when matching a connection to this filter chain.
    Filter
    getFilters(int index)
    A list of individual network filters that make up the filter chain for connections established with the listener.
    int
    getFiltersCount()
    A list of individual network filters that make up the filter chain for connections established with the listener.
    List<Filter>
    getFiltersList()
    A list of individual network filters that make up the filter chain for connections established with the listener.
    FilterOrBuilder
    getFiltersOrBuilder(int index)
    A list of individual network filters that make up the filter chain for connections established with the listener.
    List<? extends FilterOrBuilder>
    getFiltersOrBuilderList()
    A list of individual network filters that make up the filter chain for connections established with the listener.
    Metadata
    getMetadata()
    [#not-implemented-hide:] filter chain metadata.
    MetadataOrBuilder
    getMetadataOrBuilder()
    [#not-implemented-hide:] filter chain metadata.
    String
    getName()
    [#not-implemented-hide:] The unique name (or empty) by which this filter chain is known.
    com.google.protobuf.ByteString
    getNameBytes()
    [#not-implemented-hide:] The unique name (or empty) by which this filter chain is known.
    DownstreamTlsContext
    getTlsContext()
    Deprecated.
    envoy.api.v2.listener.FilterChain.tls_context is deprecated.
    DownstreamTlsContextOrBuilder
    getTlsContextOrBuilder()
    Deprecated.
    TransportSocket
    getTransportSocket()
    Optional custom transport socket implementation to use for downstream connections.
    TransportSocketOrBuilder
    getTransportSocketOrBuilder()
    Optional custom transport socket implementation to use for downstream connections.
    com.google.protobuf.BoolValue
    getUseProxyProto()
    Whether the listener should expect a PROXY protocol V1 header on new connections.
    com.google.protobuf.BoolValueOrBuilder
    getUseProxyProtoOrBuilder()
    Whether the listener should expect a PROXY protocol V1 header on new connections.
    boolean
    hasFilterChainMatch()
    The criteria to use when matching a connection to this filter chain.
    boolean
    hasMetadata()
    [#not-implemented-hide:] filter chain metadata.
    boolean
    hasTlsContext()
    Deprecated.
    envoy.api.v2.listener.FilterChain.tls_context is deprecated.
    boolean
    hasTransportSocket()
    Optional custom transport socket implementation to use for downstream connections.
    boolean
    hasUseProxyProto()
    Whether the listener should expect a PROXY protocol V1 header on new connections.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasFilterChainMatch

      boolean hasFilterChainMatch()
       The criteria to use when matching a connection to this filter chain.
      .envoy.api.v2.listener.FilterChainMatch filter_chain_match = 1;
      Returns:
      Whether the filterChainMatch field is set.

    • getFilterChainMatch

      FilterChainMatch getFilterChainMatch()
       The criteria to use when matching a connection to this filter chain.
      .envoy.api.v2.listener.FilterChainMatch filter_chain_match = 1;
      Returns:
      The filterChainMatch.

    • getFilterChainMatchOrBuilder

      FilterChainMatchOrBuilder getFilterChainMatchOrBuilder()
       The criteria to use when matching a connection to this filter chain.
      .envoy.api.v2.listener.FilterChainMatch filter_chain_match = 1;

    • hasTlsContext

      @Deprecated boolean hasTlsContext()
      Deprecated.
      envoy.api.v2.listener.FilterChain.tls_context is deprecated. See envoy/api/v2/listener/listener_components.proto;l=180
       The TLS context for this filter chain.

 .. attention::

   **This field is deprecated**. Use `transport_socket` with name `tls` instead. If both are
   set, `transport_socket` takes priority.
      .envoy.api.v2.auth.DownstreamTlsContext tls_context = 2 [deprecated = true];
      Returns:
      Whether the tlsContext field is set.

    • getTlsContext

      @Deprecated DownstreamTlsContext getTlsContext()
      Deprecated.
      envoy.api.v2.listener.FilterChain.tls_context is deprecated. See envoy/api/v2/listener/listener_components.proto;l=180
       The TLS context for this filter chain.

 .. attention::

   **This field is deprecated**. Use `transport_socket` with name `tls` instead. If both are
   set, `transport_socket` takes priority.
      .envoy.api.v2.auth.DownstreamTlsContext tls_context = 2 [deprecated = true];
      Returns:
      The tlsContext.

    • getTlsContextOrBuilder

      @Deprecated DownstreamTlsContextOrBuilder getTlsContextOrBuilder()
      Deprecated.
       The TLS context for this filter chain.

 .. attention::

   **This field is deprecated**. Use `transport_socket` with name `tls` instead. If both are
   set, `transport_socket` takes priority.
      .envoy.api.v2.auth.DownstreamTlsContext tls_context = 2 [deprecated = true];

    • getFiltersList

      List<Filter> getFiltersList()
       A list of individual network filters that make up the filter chain for
 connections established with the listener. Order matters as the filters are
 processed sequentially as connection events happen. Note: If the filter
 list is empty, the connection will close by default.
      repeated .envoy.api.v2.listener.Filter filters = 3;

    • getFilters

      Filter getFilters(int index)
       A list of individual network filters that make up the filter chain for
 connections established with the listener. Order matters as the filters are
 processed sequentially as connection events happen. Note: If the filter
 list is empty, the connection will close by default.
      repeated .envoy.api.v2.listener.Filter filters = 3;

    • getFiltersCount

      int getFiltersCount()
       A list of individual network filters that make up the filter chain for
 connections established with the listener. Order matters as the filters are
 processed sequentially as connection events happen. Note: If the filter
 list is empty, the connection will close by default.
      repeated .envoy.api.v2.listener.Filter filters = 3;

    • getFiltersOrBuilderList

      List<? extends FilterOrBuilder> getFiltersOrBuilderList()
       A list of individual network filters that make up the filter chain for
 connections established with the listener. Order matters as the filters are
 processed sequentially as connection events happen. Note: If the filter
 list is empty, the connection will close by default.
      repeated .envoy.api.v2.listener.Filter filters = 3;

    • getFiltersOrBuilder

      FilterOrBuilder getFiltersOrBuilder(int index)
       A list of individual network filters that make up the filter chain for
 connections established with the listener. Order matters as the filters are
 processed sequentially as connection events happen. Note: If the filter
 list is empty, the connection will close by default.
      repeated .envoy.api.v2.listener.Filter filters = 3;

    • hasUseProxyProto

      boolean hasUseProxyProto()
       Whether the listener should expect a PROXY protocol V1 header on new
 connections. If this option is enabled, the listener will assume that that
 remote address of the connection is the one specified in the header. Some
 load balancers including the AWS ELB support this option. If the option is
 absent or set to false, Envoy will use the physical peer address of the
 connection as the remote address.
      .google.protobuf.BoolValue use_proxy_proto = 4;
      Returns:
      Whether the useProxyProto field is set.

    • getUseProxyProto

      com.google.protobuf.BoolValue getUseProxyProto()
       Whether the listener should expect a PROXY protocol V1 header on new
 connections. If this option is enabled, the listener will assume that that
 remote address of the connection is the one specified in the header. Some
 load balancers including the AWS ELB support this option. If the option is
 absent or set to false, Envoy will use the physical peer address of the
 connection as the remote address.
      .google.protobuf.BoolValue use_proxy_proto = 4;
      Returns:
      The useProxyProto.

    • getUseProxyProtoOrBuilder

      com.google.protobuf.BoolValueOrBuilder getUseProxyProtoOrBuilder()
       Whether the listener should expect a PROXY protocol V1 header on new
 connections. If this option is enabled, the listener will assume that that
 remote address of the connection is the one specified in the header. Some
 load balancers including the AWS ELB support this option. If the option is
 absent or set to false, Envoy will use the physical peer address of the
 connection as the remote address.
      .google.protobuf.BoolValue use_proxy_proto = 4;

    • hasMetadata

      boolean hasMetadata()
       [#not-implemented-hide:] filter chain metadata.
      .envoy.api.v2.core.Metadata metadata = 5;
      Returns:
      Whether the metadata field is set.

    • getMetadata

      Metadata getMetadata()
       [#not-implemented-hide:] filter chain metadata.
      .envoy.api.v2.core.Metadata metadata = 5;
      Returns:
      The metadata.

    • getMetadataOrBuilder

      MetadataOrBuilder getMetadataOrBuilder()
       [#not-implemented-hide:] filter chain metadata.
      .envoy.api.v2.core.Metadata metadata = 5;

    • hasTransportSocket

      boolean hasTransportSocket()
       Optional custom transport socket implementation to use for downstream connections.
 To setup TLS, set a transport socket with name `tls` and
 :ref:`DownstreamTlsContext <envoy_api_msg_auth.DownstreamTlsContext>` in the `typed_config`.
 If no transport socket configuration is specified, new connections
 will be set up with plaintext.
      .envoy.api.v2.core.TransportSocket transport_socket = 6;
      Returns:
      Whether the transportSocket field is set.

    • getTransportSocket

      TransportSocket getTransportSocket()
       Optional custom transport socket implementation to use for downstream connections.
 To setup TLS, set a transport socket with name `tls` and
 :ref:`DownstreamTlsContext <envoy_api_msg_auth.DownstreamTlsContext>` in the `typed_config`.
 If no transport socket configuration is specified, new connections
 will be set up with plaintext.
      .envoy.api.v2.core.TransportSocket transport_socket = 6;
      Returns:
      The transportSocket.

    • getTransportSocketOrBuilder

      TransportSocketOrBuilder getTransportSocketOrBuilder()
       Optional custom transport socket implementation to use for downstream connections.
 To setup TLS, set a transport socket with name `tls` and
 :ref:`DownstreamTlsContext <envoy_api_msg_auth.DownstreamTlsContext>` in the `typed_config`.
 If no transport socket configuration is specified, new connections
 will be set up with plaintext.
      .envoy.api.v2.core.TransportSocket transport_socket = 6;

    • getName

      String getName()
       [#not-implemented-hide:] The unique name (or empty) by which this filter chain is known. If no
 name is provided, Envoy will allocate an internal UUID for the filter chain. If the filter
 chain is to be dynamically updated or removed via FCDS a unique name must be provided.
      string name = 7;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       [#not-implemented-hide:] The unique name (or empty) by which this filter chain is known. If no
 name is provided, Envoy will allocate an internal UUID for the filter chain. If the filter
 chain is to be dynamically updated or removed via FCDS a unique name must be provided.
      string name = 7;
      Returns:
      The bytes for name.