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

Class Compressor.ResponseDirectionConfig.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<Compressor.ResponseDirectionConfig.Builder>
io.envoyproxy.envoy.extensions.filters.http.compressor.v3.Compressor.ResponseDirectionConfig.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Compressor.ResponseDirectionConfigOrBuilder, Cloneable
Enclosing class:
Compressor.ResponseDirectionConfig
public static final class Compressor.ResponseDirectionConfig.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Compressor.ResponseDirectionConfig.Builder> 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

  • 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<Compressor.ResponseDirectionConfig.Builder>

    • clear

      public Compressor.ResponseDirectionConfig.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<Compressor.ResponseDirectionConfig.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<Compressor.ResponseDirectionConfig.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public Compressor.ResponseDirectionConfig.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<Compressor.ResponseDirectionConfig.Builder>

    • setField

      public Compressor.ResponseDirectionConfig.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<Compressor.ResponseDirectionConfig.Builder>

    • clearField

      public Compressor.ResponseDirectionConfig.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<Compressor.ResponseDirectionConfig.Builder>

    • clearOneof

      public Compressor.ResponseDirectionConfig.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<Compressor.ResponseDirectionConfig.Builder>

    • setRepeatedField

      public Compressor.ResponseDirectionConfig.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<Compressor.ResponseDirectionConfig.Builder>

    • addRepeatedField

      public Compressor.ResponseDirectionConfig.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<Compressor.ResponseDirectionConfig.Builder>

    • mergeFrom

      public Compressor.ResponseDirectionConfig.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<Compressor.ResponseDirectionConfig.Builder>

    • mergeFrom

      public Compressor.ResponseDirectionConfig.Builder mergeFrom(Compressor.ResponseDirectionConfig other)

    • isInitialized

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

    • mergeFrom

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

    • 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.

    • setCommonConfig

      public Compressor.ResponseDirectionConfig.Builder setCommonConfig(Compressor.CommonDirectionConfig value)
      .envoy.extensions.filters.http.compressor.v3.Compressor.CommonDirectionConfig common_config = 1;

    • setCommonConfig

      public Compressor.ResponseDirectionConfig.Builder setCommonConfig(Compressor.CommonDirectionConfig.Builder builderForValue)
      .envoy.extensions.filters.http.compressor.v3.Compressor.CommonDirectionConfig common_config = 1;

    • mergeCommonConfig

      public Compressor.ResponseDirectionConfig.Builder mergeCommonConfig(Compressor.CommonDirectionConfig value)
      .envoy.extensions.filters.http.compressor.v3.Compressor.CommonDirectionConfig common_config = 1;

    • clearCommonConfig

      public Compressor.ResponseDirectionConfig.Builder clearCommonConfig()
      .envoy.extensions.filters.http.compressor.v3.Compressor.CommonDirectionConfig common_config = 1;

    • getCommonConfigBuilder

      public Compressor.CommonDirectionConfig.Builder getCommonConfigBuilder()
      .envoy.extensions.filters.http.compressor.v3.Compressor.CommonDirectionConfig common_config = 1;

    • 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.

    • setDisableOnEtagHeader

      public Compressor.ResponseDirectionConfig.Builder setDisableOnEtagHeader(boolean value)
       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;
      Parameters:
      value - The disableOnEtagHeader to set.
      Returns:
      This builder for chaining.

    • clearDisableOnEtagHeader

      public Compressor.ResponseDirectionConfig.Builder clearDisableOnEtagHeader()
       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:
      This builder for chaining.

    • 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.

    • setRemoveAcceptEncodingHeader

      public Compressor.ResponseDirectionConfig.Builder setRemoveAcceptEncodingHeader(boolean value)
       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;
      Parameters:
      value - The removeAcceptEncodingHeader to set.
      Returns:
      This builder for chaining.

    • clearRemoveAcceptEncodingHeader

      public Compressor.ResponseDirectionConfig.Builder clearRemoveAcceptEncodingHeader()
       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:
      This builder for chaining.

    • 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.

    • setUncompressibleResponseCodes

      public Compressor.ResponseDirectionConfig.Builder setUncompressibleResponseCodes(int index, int value)
       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 to set the value at.
      value - The uncompressibleResponseCodes to set.
      Returns:
      This builder for chaining.

    • addUncompressibleResponseCodes

      public Compressor.ResponseDirectionConfig.Builder addUncompressibleResponseCodes(int value)
       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:
      value - The uncompressibleResponseCodes to add.
      Returns:
      This builder for chaining.

    • addAllUncompressibleResponseCodes

      public Compressor.ResponseDirectionConfig.Builder addAllUncompressibleResponseCodes(Iterable<? extends Integer> values)
       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:
      values - The uncompressibleResponseCodes to add.
      Returns:
      This builder for chaining.

    • clearUncompressibleResponseCodes

      public Compressor.ResponseDirectionConfig.Builder clearUncompressibleResponseCodes()
       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:
      This builder for chaining.

    • 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.

    • setStatusHeaderEnabled

      public Compressor.ResponseDirectionConfig.Builder setStatusHeaderEnabled(boolean value)
       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;
      Parameters:
      value - The statusHeaderEnabled to set.
      Returns:
      This builder for chaining.

    • clearStatusHeaderEnabled

      public Compressor.ResponseDirectionConfig.Builder clearStatusHeaderEnabled()
       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:
      This builder for chaining.

    • setUnknownFields

      public final Compressor.ResponseDirectionConfig.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<Compressor.ResponseDirectionConfig.Builder>

    • mergeUnknownFields

      public final Compressor.ResponseDirectionConfig.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<Compressor.ResponseDirectionConfig.Builder>