Package io.envoyproxy.envoy.extensions.filters.network.http_connection_manager.v3

Interface HttpFilterOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    HttpFilter, HttpFilter.Builder
    public interface HttpFilterOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      ExtensionConfigSource getConfigDiscovery()
      Configuration source specifier for an extension configuration discovery service.
      ExtensionConfigSourceOrBuilder getConfigDiscoveryOrBuilder()
      Configuration source specifier for an extension configuration discovery service.
      HttpFilter.ConfigTypeCase getConfigTypeCase()  
      boolean getIsOptional()
      If true, clients that do not support this filter may ignore the filter but otherwise accept the config.
      String getName()
      The name of the filter configuration.
      com.google.protobuf.ByteString getNameBytes()
      The name of the filter configuration.
      com.google.protobuf.Any getTypedConfig()
      Filter specific configuration which depends on the filter being instantiated.
      com.google.protobuf.AnyOrBuilder getTypedConfigOrBuilder()
      Filter specific configuration which depends on the filter being instantiated.
      boolean hasConfigDiscovery()
      Configuration source specifier for an extension configuration discovery service.
      boolean hasTypedConfig()
      Filter specific configuration which depends on the filter being instantiated.

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

      • getName

        String getName()
         The name of the filter configuration. It also serves as a resource name in ExtensionConfigDS.
        string name = 1 [(.validate.rules) = { ... }
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         The name of the filter configuration. It also serves as a resource name in ExtensionConfigDS.
        string name = 1 [(.validate.rules) = { ... }
        Returns:
        The bytes for name.

      • hasTypedConfig

        boolean hasTypedConfig()
         Filter specific configuration which depends on the filter being instantiated. See the supported
 filters for further documentation.
 To support configuring a :ref:`match tree <arch_overview_matching_api>`, use an
 :ref:`ExtensionWithMatcher <envoy_v3_api_msg_extensions.common.matching.v3.ExtensionWithMatcher>`
 with the desired HTTP filter.
 [#extension-category: envoy.filters.http]
        .google.protobuf.Any typed_config = 4;
        Returns:
        Whether the typedConfig field is set.

      • getTypedConfig

        com.google.protobuf.Any getTypedConfig()
         Filter specific configuration which depends on the filter being instantiated. See the supported
 filters for further documentation.
 To support configuring a :ref:`match tree <arch_overview_matching_api>`, use an
 :ref:`ExtensionWithMatcher <envoy_v3_api_msg_extensions.common.matching.v3.ExtensionWithMatcher>`
 with the desired HTTP filter.
 [#extension-category: envoy.filters.http]
        .google.protobuf.Any typed_config = 4;
        Returns:
        The typedConfig.

      • getTypedConfigOrBuilder

        com.google.protobuf.AnyOrBuilder getTypedConfigOrBuilder()
         Filter specific configuration which depends on the filter being instantiated. See the supported
 filters for further documentation.
 To support configuring a :ref:`match tree <arch_overview_matching_api>`, use an
 :ref:`ExtensionWithMatcher <envoy_v3_api_msg_extensions.common.matching.v3.ExtensionWithMatcher>`
 with the desired HTTP filter.
 [#extension-category: envoy.filters.http]
        .google.protobuf.Any typed_config = 4;

      • hasConfigDiscovery

        boolean hasConfigDiscovery()
         Configuration source specifier for an extension configuration discovery service.
 In case of a failure and without the default configuration, the HTTP listener responds with code 500.
 Extension configs delivered through this mechanism are not expected to require warming (see https://github.com/envoyproxy/envoy/issues/12061).
 To support configuring a :ref:`match tree <arch_overview_matching_api>`, use an
 :ref:`ExtensionWithMatcher <envoy_v3_api_msg_extensions.common.matching.v3.ExtensionWithMatcher>`
 with the desired HTTP filter. This works for both the default filter configuration as well
 as for filters provided via the API.
        .envoy.config.core.v3.ExtensionConfigSource config_discovery = 5;
        Returns:
        Whether the configDiscovery field is set.

      • getConfigDiscovery

        ExtensionConfigSource getConfigDiscovery()
         Configuration source specifier for an extension configuration discovery service.
 In case of a failure and without the default configuration, the HTTP listener responds with code 500.
 Extension configs delivered through this mechanism are not expected to require warming (see https://github.com/envoyproxy/envoy/issues/12061).
 To support configuring a :ref:`match tree <arch_overview_matching_api>`, use an
 :ref:`ExtensionWithMatcher <envoy_v3_api_msg_extensions.common.matching.v3.ExtensionWithMatcher>`
 with the desired HTTP filter. This works for both the default filter configuration as well
 as for filters provided via the API.
        .envoy.config.core.v3.ExtensionConfigSource config_discovery = 5;
        Returns:
        The configDiscovery.

      • getConfigDiscoveryOrBuilder

        ExtensionConfigSourceOrBuilder getConfigDiscoveryOrBuilder()
         Configuration source specifier for an extension configuration discovery service.
 In case of a failure and without the default configuration, the HTTP listener responds with code 500.
 Extension configs delivered through this mechanism are not expected to require warming (see https://github.com/envoyproxy/envoy/issues/12061).
 To support configuring a :ref:`match tree <arch_overview_matching_api>`, use an
 :ref:`ExtensionWithMatcher <envoy_v3_api_msg_extensions.common.matching.v3.ExtensionWithMatcher>`
 with the desired HTTP filter. This works for both the default filter configuration as well
 as for filters provided via the API.
        .envoy.config.core.v3.ExtensionConfigSource config_discovery = 5;

      • getIsOptional

        boolean getIsOptional()
         If true, clients that do not support this filter may ignore the
 filter but otherwise accept the config.
 Otherwise, clients that do not support this filter must reject the config.
 This is also same with typed per filter config.
        bool is_optional = 6;
        Returns:
        The isOptional.