Interface FilterConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
FilterConfig, FilterConfig.Builder

public interface FilterConfigOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Any
    The filter config.
    com.google.protobuf.AnyOrBuilder
    The filter config.
    boolean
    If true, the filter is disabled in the route or virtual host and the ``config`` field is ignored.
    boolean
    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
    The filter config.

    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 Details

    • hasConfig

      boolean hasConfig()
       The filter config.
       
      .google.protobuf.Any config = 1;
      Returns:
      Whether the config field is set.
    • getConfig

      com.google.protobuf.Any getConfig()
       The filter config.
       
      .google.protobuf.Any config = 1;
      Returns:
      The config.
    • getConfigOrBuilder

      com.google.protobuf.AnyOrBuilder getConfigOrBuilder()
       The filter config.
       
      .google.protobuf.Any config = 1;
    • getIsOptional

      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;
      Returns:
      The isOptional.
    • getDisabled

      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;
      Returns:
      The disabled.