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 Summary
FieldsModifier and TypeFieldDescriptionprivate int
private com.google.protobuf.SingleFieldBuilder
<ExtensionConfigSource, ExtensionConfigSource.Builder, ExtensionConfigSourceOrBuilder> private Object
private int
private boolean
private boolean
private Object
private com.google.protobuf.SingleFieldBuilder
<com.google.protobuf.Any, com.google.protobuf.Any.Builder, com.google.protobuf.AnyOrBuilder> -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
private void
buildPartial0
(HttpFilter result) private void
buildPartialOneofs
(HttpFilter result) clear()
Configuration source specifier for an extension configuration discovery service.If true, the filter is disabled by default and must be explicitly enabled by setting per filter configuration in the route configuration.If true, clients that do not support this filter may ignore the filter but otherwise accept the config.The name of the filter configuration.Filter specific configuration which depends on the filter being instantiated.Configuration source specifier for an extension configuration discovery service.Configuration source specifier for an extension configuration discovery service.Configuration source specifier for an extension configuration discovery service.static final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.Descriptors.Descriptor
boolean
If true, the filter is disabled by default and must be explicitly enabled by setting per filter configuration in the route configuration.boolean
If true, clients that do not support this filter may ignore the filter but otherwise accept the config.getName()
The name of the filter configuration.com.google.protobuf.ByteString
The name of the filter configuration.com.google.protobuf.Any
Filter specific configuration which depends on the filter being instantiated.com.google.protobuf.Any.Builder
Filter specific configuration which depends on the filter being instantiated.com.google.protobuf.AnyOrBuilder
Filter specific configuration which depends on the filter being instantiated.boolean
Configuration source specifier for an extension configuration discovery service.boolean
Filter specific configuration which depends on the filter being instantiated.private com.google.protobuf.SingleFieldBuilder
<ExtensionConfigSource, ExtensionConfigSource.Builder, ExtensionConfigSourceOrBuilder> Configuration source specifier for an extension configuration discovery service.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
private com.google.protobuf.SingleFieldBuilder
<com.google.protobuf.Any, com.google.protobuf.Any.Builder, com.google.protobuf.AnyOrBuilder> Filter specific configuration which depends on the filter being instantiated.final boolean
Configuration source specifier for an extension configuration discovery service.mergeFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom
(com.google.protobuf.Message other) mergeFrom
(HttpFilter other) mergeTypedConfig
(com.google.protobuf.Any value) Filter specific configuration which depends on the filter being instantiated.Configuration source specifier for an extension configuration discovery service.setConfigDiscovery
(ExtensionConfigSource.Builder builderForValue) Configuration source specifier for an extension configuration discovery service.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.setIsOptional
(boolean value) If true, clients that do not support this filter may ignore the filter but otherwise accept the config.The name of the filter configuration.setNameBytes
(com.google.protobuf.ByteString value) The name of the filter configuration.setTypedConfig
(com.google.protobuf.Any value) Filter specific configuration which depends on the filter being instantiated.setTypedConfig
(com.google.protobuf.Any.Builder builderForValue) Filter specific configuration which depends on the filter being instantiated.Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom
Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
configTypeCase_
private int configTypeCase_ -
configType_
-
bitField0_
private int bitField0_ -
name_
-
typedConfigBuilder_
private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.Any,com.google.protobuf.Any.Builder, typedConfigBuilder_com.google.protobuf.AnyOrBuilder> -
configDiscoveryBuilder_
private com.google.protobuf.SingleFieldBuilder<ExtensionConfigSource,ExtensionConfigSource.Builder, configDiscoveryBuilder_ExtensionConfigSourceOrBuilder> -
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 classcom.google.protobuf.GeneratedMessage.Builder<HttpFilter.Builder>
-
clear
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessage.Builder<HttpFilter.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessage.Builder<HttpFilter.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial0
-
buildPartialOneofs
-
mergeFrom
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<HttpFilter.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.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 interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<HttpFilter.Builder>
- Throws:
IOException
-
getConfigTypeCase
- Specified by:
getConfigTypeCase
in interfaceHttpFilterOrBuilder
-
clearConfigType
-
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 interfaceHttpFilterOrBuilder
- 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 interfaceHttpFilterOrBuilder
- Returns:
- The bytes for name.
-
setName
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
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
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 interfaceHttpFilterOrBuilder
- 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 interfaceHttpFilterOrBuilder
- Returns:
- The typedConfig.
-
setTypedConfig
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
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
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
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 interfaceHttpFilterOrBuilder
-
internalGetTypedConfigFieldBuilder
private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.Any,com.google.protobuf.Any.Builder, internalGetTypedConfigFieldBuilder()com.google.protobuf.AnyOrBuilder> 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 interfaceHttpFilterOrBuilder
- Returns:
- Whether the configDiscovery field is set.
-
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 interfaceHttpFilterOrBuilder
- Returns:
- The configDiscovery.
-
setConfigDiscovery
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
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
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
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
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
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 interfaceHttpFilterOrBuilder
-
internalGetConfigDiscoveryFieldBuilder
private com.google.protobuf.SingleFieldBuilder<ExtensionConfigSource,ExtensionConfigSource.Builder, internalGetConfigDiscoveryFieldBuilder()ExtensionConfigSourceOrBuilder> 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 interfaceHttpFilterOrBuilder
- Returns:
- The isOptional.
-
setIsOptional
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
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 interfaceHttpFilterOrBuilder
- Returns:
- The disabled.
-
setDisabled
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
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.
-