Class FilterConfig.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessage.Builder<FilterConfig.Builder>
-
- io.envoyproxy.envoy.config.route.v3.FilterConfig.Builder
-
- All Implemented Interfaces:
com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,FilterConfigOrBuilder
,java.lang.Cloneable
- Enclosing class:
- FilterConfig
public static final class FilterConfig.Builder extends com.google.protobuf.GeneratedMessage.Builder<FilterConfig.Builder> implements FilterConfigOrBuilder
A simple wrapper for an HTTP filter config. This is intended to be used as a wrapper for the map value in :ref:`VirtualHost.typed_per_filter_config<envoy_v3_api_field_config.route.v3.VirtualHost.typed_per_filter_config>`, :ref:`Route.typed_per_filter_config<envoy_v3_api_field_config.route.v3.Route.typed_per_filter_config>`, or :ref:`WeightedCluster.ClusterWeight.typed_per_filter_config<envoy_v3_api_field_config.route.v3.WeightedCluster.ClusterWeight.typed_per_filter_config>` to add additional flags to the filter.
Protobuf typeenvoy.config.route.v3.FilterConfig
-
-
Field Summary
Fields Modifier and Type Field Description private int
bitField0_
private com.google.protobuf.Any
config_
private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.Any,com.google.protobuf.Any.Builder,com.google.protobuf.AnyOrBuilder>
configBuilder_
private boolean
disabled_
private boolean
isOptional_
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description FilterConfig
build()
FilterConfig
buildPartial()
private void
buildPartial0(FilterConfig result)
FilterConfig.Builder
clear()
FilterConfig.Builder
clearConfig()
The filter config.FilterConfig.Builder
clearDisabled()
If true, the filter is disabled in the route or virtual host and the ``config`` field is ignored.FilterConfig.Builder
clearIsOptional()
If true, the filter is optional, meaning that if the client does not support the specified filter, it may ignore the map entry rather than rejecting the config.com.google.protobuf.Any
getConfig()
The filter config.com.google.protobuf.Any.Builder
getConfigBuilder()
The filter config.private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.Any,com.google.protobuf.Any.Builder,com.google.protobuf.AnyOrBuilder>
getConfigFieldBuilder()
The filter config.com.google.protobuf.AnyOrBuilder
getConfigOrBuilder()
The filter config.FilterConfig
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
com.google.protobuf.Descriptors.Descriptor
getDescriptorForType()
boolean
getDisabled()
If true, the filter is disabled in the route or virtual host and the ``config`` field is ignored.boolean
getIsOptional()
If true, the filter is optional, meaning that if the client does not support the specified filter, it may ignore the map entry rather than rejecting the config.boolean
hasConfig()
The filter config.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
private void
maybeForceBuilderInitialization()
FilterConfig.Builder
mergeConfig(com.google.protobuf.Any value)
The filter config.FilterConfig.Builder
mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
FilterConfig.Builder
mergeFrom(com.google.protobuf.Message other)
FilterConfig.Builder
mergeFrom(FilterConfig other)
FilterConfig.Builder
setConfig(com.google.protobuf.Any value)
The filter config.FilterConfig.Builder
setConfig(com.google.protobuf.Any.Builder builderForValue)
The filter config.FilterConfig.Builder
setDisabled(boolean value)
If true, the filter is disabled in the route or virtual host and the ``config`` field is ignored.FilterConfig.Builder
setIsOptional(boolean value)
If true, the filter is optional, meaning that if the client does not support the specified filter, it may ignore the map entry rather than rejecting the config.-
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
-
-
-
-
Field Detail
-
bitField0_
private int bitField0_
-
config_
private com.google.protobuf.Any config_
-
configBuilder_
private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.Any,com.google.protobuf.Any.Builder,com.google.protobuf.AnyOrBuilder> configBuilder_
-
isOptional_
private boolean isOptional_
-
disabled_
private boolean disabled_
-
-
Method Detail
-
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<FilterConfig.Builder>
-
maybeForceBuilderInitialization
private void maybeForceBuilderInitialization()
-
clear
public FilterConfig.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<FilterConfig.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<FilterConfig.Builder>
-
getDefaultInstanceForType
public FilterConfig getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
public FilterConfig build()
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public FilterConfig buildPartial()
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial0
private void buildPartial0(FilterConfig result)
-
mergeFrom
public FilterConfig.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<FilterConfig.Builder>
-
mergeFrom
public FilterConfig.Builder mergeFrom(FilterConfig other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage.Builder<FilterConfig.Builder>
-
mergeFrom
public FilterConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.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<FilterConfig.Builder>
- Throws:
java.io.IOException
-
hasConfig
public boolean hasConfig()
The filter config.
.google.protobuf.Any config = 1;
- Specified by:
hasConfig
in interfaceFilterConfigOrBuilder
- Returns:
- Whether the config field is set.
-
getConfig
public com.google.protobuf.Any getConfig()
The filter config.
.google.protobuf.Any config = 1;
- Specified by:
getConfig
in interfaceFilterConfigOrBuilder
- Returns:
- The config.
-
setConfig
public FilterConfig.Builder setConfig(com.google.protobuf.Any value)
The filter config.
.google.protobuf.Any config = 1;
-
setConfig
public FilterConfig.Builder setConfig(com.google.protobuf.Any.Builder builderForValue)
The filter config.
.google.protobuf.Any config = 1;
-
mergeConfig
public FilterConfig.Builder mergeConfig(com.google.protobuf.Any value)
The filter config.
.google.protobuf.Any config = 1;
-
clearConfig
public FilterConfig.Builder clearConfig()
The filter config.
.google.protobuf.Any config = 1;
-
getConfigBuilder
public com.google.protobuf.Any.Builder getConfigBuilder()
The filter config.
.google.protobuf.Any config = 1;
-
getConfigOrBuilder
public com.google.protobuf.AnyOrBuilder getConfigOrBuilder()
The filter config.
.google.protobuf.Any config = 1;
- Specified by:
getConfigOrBuilder
in interfaceFilterConfigOrBuilder
-
getConfigFieldBuilder
private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.Any,com.google.protobuf.Any.Builder,com.google.protobuf.AnyOrBuilder> getConfigFieldBuilder()
The filter config.
.google.protobuf.Any config = 1;
-
getIsOptional
public boolean getIsOptional()
If true, the filter is optional, meaning that if the client does not support the specified filter, it may ignore the map entry rather than rejecting the config.
bool is_optional = 2;
- Specified by:
getIsOptional
in interfaceFilterConfigOrBuilder
- Returns:
- The isOptional.
-
setIsOptional
public FilterConfig.Builder setIsOptional(boolean value)
If true, the filter is optional, meaning that if the client does not support the specified filter, it may ignore the map entry rather than rejecting the config.
bool is_optional = 2;
- Parameters:
value
- The isOptional to set.- Returns:
- This builder for chaining.
-
clearIsOptional
public FilterConfig.Builder clearIsOptional()
If true, the filter is optional, meaning that if the client does not support the specified filter, it may ignore the map entry rather than rejecting the config.
bool is_optional = 2;
- Returns:
- This builder for chaining.
-
getDisabled
public boolean getDisabled()
If true, the filter is disabled in the route or virtual host and the ``config`` field is ignored. See :ref:`route based filter chain <arch_overview_http_filters_route_based_filter_chain>` for more details. .. note:: This field will take effect when the request arrive and filter chain is created for the request. If initial route is selected for the request and a filter is disabled in the initial route, then the filter will not be added to the filter chain. And if the request is mutated later and re-match to another route, the disabled filter by the initial route will not be added back to the filter chain because the filter chain is already created and it is too late to change the chain. This field only make sense for the downstream HTTP filters for now.
bool disabled = 3;
- Specified by:
getDisabled
in interfaceFilterConfigOrBuilder
- Returns:
- The disabled.
-
setDisabled
public FilterConfig.Builder setDisabled(boolean value)
If true, the filter is disabled in the route or virtual host and the ``config`` field is ignored. See :ref:`route based filter chain <arch_overview_http_filters_route_based_filter_chain>` for more details. .. note:: This field will take effect when the request arrive and filter chain is created for the request. If initial route is selected for the request and a filter is disabled in the initial route, then the filter will not be added to the filter chain. And if the request is mutated later and re-match to another route, the disabled filter by the initial route will not be added back to the filter chain because the filter chain is already created and it is too late to change the chain. This field only make sense for the downstream HTTP filters for now.
bool disabled = 3;
- Parameters:
value
- The disabled to set.- Returns:
- This builder for chaining.
-
clearDisabled
public FilterConfig.Builder clearDisabled()
If true, the filter is disabled in the route or virtual host and the ``config`` field is ignored. See :ref:`route based filter chain <arch_overview_http_filters_route_based_filter_chain>` for more details. .. note:: This field will take effect when the request arrive and filter chain is created for the request. If initial route is selected for the request and a filter is disabled in the initial route, then the filter will not be added to the filter chain. And if the request is mutated later and re-match to another route, the disabled filter by the initial route will not be added back to the filter chain because the filter chain is already created and it is too late to change the chain. This field only make sense for the downstream HTTP filters for now.
bool disabled = 3;
- Returns:
- This builder for chaining.
-
-