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

Class Compressor.ResponseDirectionConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.compressor.v3.Compressor.ResponseDirectionConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Compressor.ResponseDirectionConfigOrBuilder, Serializable
Enclosing class:
Compressor
public static final class Compressor.ResponseDirectionConfig extends com.google.protobuf.GeneratedMessageV3 implements Compressor.ResponseDirectionConfigOrBuilder
 Configuration for filter behavior on the response direction.
 [#next-free-field: 6]
Protobuf type envoy.extensions.filters.http.compressor.v3.Compressor.ResponseDirectionConfig
See Also:

  • Field Details

    • COMMON_CONFIG_FIELD_NUMBER

      public static final int COMMON_CONFIG_FIELD_NUMBER
      See Also:

    • DISABLE_ON_ETAG_HEADER_FIELD_NUMBER

      public static final int DISABLE_ON_ETAG_HEADER_FIELD_NUMBER
      See Also:

    • REMOVE_ACCEPT_ENCODING_HEADER_FIELD_NUMBER

      public static final int REMOVE_ACCEPT_ENCODING_HEADER_FIELD_NUMBER
      See Also:

    • UNCOMPRESSIBLE_RESPONSE_CODES_FIELD_NUMBER

      public static final int UNCOMPRESSIBLE_RESPONSE_CODES_FIELD_NUMBER
      See Also:

    • STATUS_HEADER_ENABLED_FIELD_NUMBER

      public static final int STATUS_HEADER_ENABLED_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • 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

    • hasCommonConfig

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

    • getCommonConfig

      public Compressor.CommonDirectionConfig getCommonConfig()
      .envoy.extensions.filters.http.compressor.v3.Compressor.CommonDirectionConfig common_config = 1;
      Specified by:
      getCommonConfig in interface Compressor.ResponseDirectionConfigOrBuilder
      Returns:
      The commonConfig.

    • getCommonConfigOrBuilder

      public Compressor.CommonDirectionConfigOrBuilder getCommonConfigOrBuilder()
      .envoy.extensions.filters.http.compressor.v3.Compressor.CommonDirectionConfig common_config = 1;
      Specified by:
      getCommonConfigOrBuilder in interface Compressor.ResponseDirectionConfigOrBuilder

    • getDisableOnEtagHeader

      public 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;
      Specified by:
      getDisableOnEtagHeader in interface Compressor.ResponseDirectionConfigOrBuilder
      Returns:
      The disableOnEtagHeader.

    • getRemoveAcceptEncodingHeader

      public 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;
      Specified by:
      getRemoveAcceptEncodingHeader in interface Compressor.ResponseDirectionConfigOrBuilder
      Returns:
      The removeAcceptEncodingHeader.

    • getUncompressibleResponseCodesList

      public 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) = { ... }
      Specified by:
      getUncompressibleResponseCodesList in interface Compressor.ResponseDirectionConfigOrBuilder
      Returns:
      A list containing the uncompressibleResponseCodes.

    • getUncompressibleResponseCodesCount

      public 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) = { ... }
      Specified by:
      getUncompressibleResponseCodesCount in interface Compressor.ResponseDirectionConfigOrBuilder
      Returns:
      The count of uncompressibleResponseCodes.

    • getUncompressibleResponseCodes

      public 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) = { ... }
      Specified by:
      getUncompressibleResponseCodes in interface Compressor.ResponseDirectionConfigOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The uncompressibleResponseCodes at the given index.

    • getStatusHeaderEnabled

      public 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;
      Specified by:
      getStatusHeaderEnabled in interface Compressor.ResponseDirectionConfigOrBuilder
      Returns:
      The statusHeaderEnabled.

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Compressor.ResponseDirectionConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Compressor.ResponseDirectionConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Compressor.ResponseDirectionConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Compressor.ResponseDirectionConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Compressor.ResponseDirectionConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Compressor.ResponseDirectionConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Compressor.ResponseDirectionConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Compressor.ResponseDirectionConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Compressor.ResponseDirectionConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Compressor.ResponseDirectionConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Compressor.ResponseDirectionConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Compressor.ResponseDirectionConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Compressor.ResponseDirectionConfig.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Compressor.ResponseDirectionConfig.Builder newBuilder()

    • newBuilder

      public static Compressor.ResponseDirectionConfig.Builder newBuilder(Compressor.ResponseDirectionConfig prototype)

    • toBuilder

      public Compressor.ResponseDirectionConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Compressor.ResponseDirectionConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Compressor.ResponseDirectionConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Compressor.ResponseDirectionConfig> parser()

    • getParserForType

      public com.google.protobuf.Parser<Compressor.ResponseDirectionConfig> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

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