Package io.envoyproxy.envoy.config.route.v3

Class FilterConfig.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.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, Cloneable
Enclosing class:
FilterConfig
public static final class FilterConfig.Builder extends com.google.protobuf.GeneratedMessageV3.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 type envoy.config.route.v3.FilterConfig

  • Method Summary

    Modifier and Type
    Method
    Description
    FilterConfig.Builder
    addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
     
    FilterConfig
    build()
     
    FilterConfig
    buildPartial()
     
    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
    clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
     
    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.
    FilterConfig.Builder
    clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
     
    FilterConfig.Builder
    clone()
     
    com.google.protobuf.Any
    getConfig()
    The filter config.
    com.google.protobuf.Any.Builder
    getConfigBuilder()
    The filter config.
    com.google.protobuf.AnyOrBuilder
    getConfigOrBuilder()
    The filter config.
    FilterConfig
    getDefaultInstanceForType()
     
    static final 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.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    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)
     
    final FilterConfig.Builder
    mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
     
    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
    setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
     
    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.
    FilterConfig.Builder
    setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
     
    final FilterConfig.Builder
    setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

    getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, 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

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • clear

      public FilterConfig.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.GeneratedMessageV3.Builder<FilterConfig.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.GeneratedMessageV3.Builder<FilterConfig.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public FilterConfig.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<FilterConfig.Builder>

    • setField

      public FilterConfig.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<FilterConfig.Builder>

    • clearField

      public FilterConfig.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<FilterConfig.Builder>

    • clearOneof

      public FilterConfig.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<FilterConfig.Builder>

    • setRepeatedField

      public FilterConfig.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<FilterConfig.Builder>

    • addRepeatedField

      public FilterConfig.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<FilterConfig.Builder>

    • mergeFrom

      public FilterConfig.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<FilterConfig.Builder>

    • mergeFrom

      public FilterConfig.Builder mergeFrom(FilterConfig other)

    • isInitialized

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

    • mergeFrom

      public FilterConfig.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<FilterConfig.Builder>
      Throws:
      IOException

    • hasConfig

      public boolean hasConfig()
       The filter config.
      .google.protobuf.Any config = 1;
      Specified by:
      hasConfig in interface FilterConfigOrBuilder
      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 interface FilterConfigOrBuilder
      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 interface FilterConfigOrBuilder

    • 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 interface FilterConfigOrBuilder
      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.
      bool disabled = 3;
      Specified by:
      getDisabled in interface FilterConfigOrBuilder
      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.
      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.
      bool disabled = 3;
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final FilterConfig.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FilterConfig.Builder>

    • mergeUnknownFields

      public final FilterConfig.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FilterConfig.Builder>