Class HttpFilter.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<HttpFilter.Builder>
com.google.protobuf.GeneratedMessage.Builder<HttpFilter.Builder>
io.envoyproxy.envoy.extensions.filters.network.http_connection_manager.v3.HttpFilter.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HttpFilterOrBuilder, Cloneable
Enclosing class:
HttpFilter
public static final class HttpFilter.Builder extends com.google.protobuf.GeneratedMessage.Builder<HttpFilter.Builder> implements HttpFilterOrBuilder
[#next-free-field: 8]
Protobuf type envoy.extensions.filters.network.http_connection_manager.v3.HttpFilter

  • Field Details

    • configTypeCase_

      private int configTypeCase_

    • configType_

      private Object configType_

    • bitField0_

      private int bitField0_

    • name_

      private Object name_

    • typedConfigBuilder_

      private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.Any, com.google.protobuf.Any.Builder, com.google.protobuf.AnyOrBuilder> typedConfigBuilder_

    • configDiscoveryBuilder_

      private com.google.protobuf.SingleFieldBuilder<ExtensionConfigSource, ExtensionConfigSource.Builder, ExtensionConfigSourceOrBuilder> configDiscoveryBuilder_

    • isOptional_

      private boolean isOptional_

    • disabled_

      private boolean disabled_

  • Constructor Details

    • Builder

      private Builder()

    • Builder

      private Builder(com.google.protobuf.AbstractMessage.BuilderParent parent)

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<HttpFilter.Builder>

    • clear

      public HttpFilter.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<HttpFilter.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<HttpFilter.Builder>

    • getDefaultInstanceForType

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

    • build

      public HttpFilter build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public HttpFilter buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • buildPartial0

      private void buildPartial0(HttpFilter result)

    • buildPartialOneofs

      private void buildPartialOneofs(HttpFilter result)

    • mergeFrom

      public HttpFilter.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<HttpFilter.Builder>

    • mergeFrom

      public HttpFilter.Builder mergeFrom(HttpFilter other)

    • isInitialized

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

    • mergeFrom

      public HttpFilter.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<HttpFilter.Builder>
      Throws:
      IOException

    • getConfigTypeCase

      public HttpFilter.ConfigTypeCase getConfigTypeCase()
      Specified by:
      getConfigTypeCase in interface HttpFilterOrBuilder

    • clearConfigType

      public HttpFilter.Builder clearConfigType()

    • getName

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

    • getNameBytes

      public 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) = { ... }
      Specified by:
      getNameBytes in interface HttpFilterOrBuilder
      Returns:
      The bytes for name.

    • setName

      public HttpFilter.Builder setName(String value)
      The name of the filter configuration. It also serves as a resource name in ExtensionConfigDS.
      string name = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public HttpFilter.Builder clearName()
      The name of the filter configuration. It also serves as a resource name in ExtensionConfigDS.
      string name = 1 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setNameBytes

      public HttpFilter.Builder setNameBytes(com.google.protobuf.ByteString value)
      The name of the filter configuration. It also serves as a resource name in ExtensionConfigDS.
      string name = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • hasTypedConfig

      public 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;
      Specified by:
      hasTypedConfig in interface HttpFilterOrBuilder
      Returns:
      Whether the typedConfig field is set.

    • getTypedConfig

      public 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;
      Specified by:
      getTypedConfig in interface HttpFilterOrBuilder
      Returns:
      The typedConfig.

    • setTypedConfig

      public HttpFilter.Builder setTypedConfig(com.google.protobuf.Any value)
      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;

    • setTypedConfig

      public HttpFilter.Builder setTypedConfig(com.google.protobuf.Any.Builder builderForValue)
      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;

    • mergeTypedConfig

      public HttpFilter.Builder mergeTypedConfig(com.google.protobuf.Any value)
      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;

    • clearTypedConfig

      public HttpFilter.Builder clearTypedConfig()
      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;

    • getTypedConfigBuilder

      public com.google.protobuf.Any.Builder getTypedConfigBuilder()
      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;

    • getTypedConfigOrBuilder

      public 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;
      Specified by:
      getTypedConfigOrBuilder in interface HttpFilterOrBuilder

    • internalGetTypedConfigFieldBuilder

      private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.Any, com.google.protobuf.Any.Builder, com.google.protobuf.AnyOrBuilder> internalGetTypedConfigFieldBuilder()
      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

      public 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;
      Specified by:
      hasConfigDiscovery in interface HttpFilterOrBuilder
      Returns:
      Whether the configDiscovery field is set.

    • getConfigDiscovery

      public 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;
      Specified by:
      getConfigDiscovery in interface HttpFilterOrBuilder
      Returns:
      The configDiscovery.

    • setConfigDiscovery

      public HttpFilter.Builder setConfigDiscovery(ExtensionConfigSource value)
      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;

    • setConfigDiscovery

      public HttpFilter.Builder setConfigDiscovery(ExtensionConfigSource.Builder builderForValue)
      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;

    • mergeConfigDiscovery

      public HttpFilter.Builder mergeConfigDiscovery(ExtensionConfigSource value)
      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;

    • clearConfigDiscovery

      public HttpFilter.Builder clearConfigDiscovery()
      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;

    • getConfigDiscoveryBuilder

      public ExtensionConfigSource.Builder getConfigDiscoveryBuilder()
      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;

    • getConfigDiscoveryOrBuilder

      public 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;
      Specified by:
      getConfigDiscoveryOrBuilder in interface HttpFilterOrBuilder

    • internalGetConfigDiscoveryFieldBuilder

      private com.google.protobuf.SingleFieldBuilder<ExtensionConfigSource, ExtensionConfigSource.Builder, ExtensionConfigSourceOrBuilder> internalGetConfigDiscoveryFieldBuilder()
      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

      public 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.
      bool is_optional = 6;
      Specified by:
      getIsOptional in interface HttpFilterOrBuilder
      Returns:
      The isOptional.

    • setIsOptional

      public HttpFilter.Builder setIsOptional(boolean value)
      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.
      bool is_optional = 6;
      Parameters:
      value - The isOptional to set.
      Returns:
      This builder for chaining.

    • clearIsOptional

      public HttpFilter.Builder clearIsOptional()
      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.
      bool is_optional = 6;
      Returns:
      This builder for chaining.

    • getDisabled

      public boolean getDisabled()
      If true, the filter is disabled by default and must be explicitly enabled by setting
per filter configuration in the route configuration.
See :ref:`route based filter chain <arch_overview_http_filters_route_based_filter_chain>`
for more details.

Terminal filters (e.g. ``envoy.filters.http.router``) cannot be marked as disabled.
      bool disabled = 7;
      Specified by:
      getDisabled in interface HttpFilterOrBuilder
      Returns:
      The disabled.

    • setDisabled

      public HttpFilter.Builder setDisabled(boolean value)
      If true, the filter is disabled by default and must be explicitly enabled by setting
per filter configuration in the route configuration.
See :ref:`route based filter chain <arch_overview_http_filters_route_based_filter_chain>`
for more details.

Terminal filters (e.g. ``envoy.filters.http.router``) cannot be marked as disabled.
      bool disabled = 7;
      Parameters:
      value - The disabled to set.
      Returns:
      This builder for chaining.

    • clearDisabled

      public HttpFilter.Builder clearDisabled()
      If true, the filter is disabled by default and must be explicitly enabled by setting
per filter configuration in the route configuration.
See :ref:`route based filter chain <arch_overview_http_filters_route_based_filter_chain>`
for more details.

Terminal filters (e.g. ``envoy.filters.http.router``) cannot be marked as disabled.
      bool disabled = 7;
      Returns:
      This builder for chaining.