Package io.envoyproxy.envoy.extensions.filters.http.compressor.v3

Interface Compressor.ResponseDirectionConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Compressor.ResponseDirectionConfig, Compressor.ResponseDirectionConfig.Builder
Enclosing class:
Compressor
public static interface Compressor.ResponseDirectionConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    Compressor.CommonDirectionConfig
    getCommonConfig()
    .envoy.extensions.filters.http.compressor.v3.Compressor.CommonDirectionConfig common_config = 1;
    Compressor.CommonDirectionConfigOrBuilder
    getCommonConfigOrBuilder()
    .envoy.extensions.filters.http.compressor.v3.Compressor.CommonDirectionConfig common_config = 1;
    boolean
    getDisableOnEtagHeader()
    When this field is ``true``, disables compression when the response contains an ``ETag`` header.
    boolean
    getRemoveAcceptEncodingHeader()
    When this field is ``true``, removes ``Accept-Encoding`` from the request headers before dispatching the request to the upstream so that responses do not get compressed before reaching the filter. .. attention:: To avoid interfering with other compression filters in the same chain, use this option in the filter closest to the upstream.
    boolean
    getStatusHeaderEnabled()
    If true, the filter adds the ``x-envoy-compression-status`` response header to indicate whether the compression occurred and, if not, provide the reason why.
    int
    getUncompressibleResponseCodes(int index)
    Set of response codes for which compression is disabled; e.g., 206 Partial Content should not be compressed.
    int
    getUncompressibleResponseCodesCount()
    Set of response codes for which compression is disabled; e.g., 206 Partial Content should not be compressed.
    List<Integer>
    getUncompressibleResponseCodesList()
    Set of response codes for which compression is disabled; e.g., 206 Partial Content should not be compressed.
    boolean
    hasCommonConfig()
    .envoy.extensions.filters.http.compressor.v3.Compressor.CommonDirectionConfig common_config = 1;

    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

    • hasCommonConfig

      boolean hasCommonConfig()
      .envoy.extensions.filters.http.compressor.v3.Compressor.CommonDirectionConfig common_config = 1;
      Returns:
      Whether the commonConfig field is set.

    • getCommonConfig

      Compressor.CommonDirectionConfig getCommonConfig()
      .envoy.extensions.filters.http.compressor.v3.Compressor.CommonDirectionConfig common_config = 1;
      Returns:
      The commonConfig.

    • getCommonConfigOrBuilder

      Compressor.CommonDirectionConfigOrBuilder getCommonConfigOrBuilder()
      .envoy.extensions.filters.http.compressor.v3.Compressor.CommonDirectionConfig common_config = 1;

    • getDisableOnEtagHeader

      boolean getDisableOnEtagHeader()
       When this field is ``true``, disables compression when the response contains an ``ETag`` header.
 When this field is ``false``, the filter will preserve weak ``ETag`` values and remove those that
 require strong validation.
      bool disable_on_etag_header = 2;
      Returns:
      The disableOnEtagHeader.

    • getRemoveAcceptEncodingHeader

      boolean getRemoveAcceptEncodingHeader()
       When this field is ``true``, removes ``Accept-Encoding`` from the request headers before dispatching
 the request to the upstream so that responses do not get compressed before reaching the filter.

 .. attention::

    To avoid interfering with other compression filters in the same chain, use this option in
    the filter closest to the upstream.
      bool remove_accept_encoding_header = 3;
      Returns:
      The removeAcceptEncodingHeader.

    • getUncompressibleResponseCodesList

      List<Integer> getUncompressibleResponseCodesList()
       Set of response codes for which compression is disabled; e.g., 206 Partial Content should not
 be compressed.
      repeated uint32 uncompressible_response_codes = 4 [(.validate.rules) = { ... }
      Returns:
      A list containing the uncompressibleResponseCodes.

    • getUncompressibleResponseCodesCount

      int getUncompressibleResponseCodesCount()
       Set of response codes for which compression is disabled; e.g., 206 Partial Content should not
 be compressed.
      repeated uint32 uncompressible_response_codes = 4 [(.validate.rules) = { ... }
      Returns:
      The count of uncompressibleResponseCodes.

    • getUncompressibleResponseCodes

      int getUncompressibleResponseCodes(int index)
       Set of response codes for which compression is disabled; e.g., 206 Partial Content should not
 be compressed.
      repeated uint32 uncompressible_response_codes = 4 [(.validate.rules) = { ... }
      Parameters:
      index - The index of the element to return.
      Returns:
      The uncompressibleResponseCodes at the given index.

    • getStatusHeaderEnabled

      boolean getStatusHeaderEnabled()
       If true, the filter adds the ``x-envoy-compression-status`` response
 header to indicate whether the compression occurred and, if not, provide
 the reason why. The header's value format is
 ``<encoder-type>;<status>[;<additional-params>]``, where ``<status>`` is
 ``Compressed`` or the reason compression was skipped (e.g.,
 ``ContentLengthTooSmall``). When this field is enabled, the compressor
 filter alters the order of the compression eligibility checks to report
 the most valid reason for skipping the compression.
      bool status_header_enabled = 5;
      Returns:
      The statusHeaderEnabled.