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

Interface CompressorOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Compressor, Compressor.Builder
public interface CompressorOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasContentLength

      @Deprecated boolean hasContentLength()
      Deprecated.
      envoy.extensions.filters.http.compressor.v3.Compressor.content_length is deprecated. See envoy/extensions/filters/http/compressor/v3/compressor.proto;l=79
       Minimum response length, in bytes, which will trigger compression. The default value is 30.
      .google.protobuf.UInt32Value content_length = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Returns:
      Whether the contentLength field is set.

    • getContentLength

      @Deprecated com.google.protobuf.UInt32Value getContentLength()
      Deprecated.
      envoy.extensions.filters.http.compressor.v3.Compressor.content_length is deprecated. See envoy/extensions/filters/http/compressor/v3/compressor.proto;l=79
       Minimum response length, in bytes, which will trigger compression. The default value is 30.
      .google.protobuf.UInt32Value content_length = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Returns:
      The contentLength.

    • getContentLengthOrBuilder

      @Deprecated com.google.protobuf.UInt32ValueOrBuilder getContentLengthOrBuilder()
      Deprecated.
       Minimum response length, in bytes, which will trigger compression. The default value is 30.
      .google.protobuf.UInt32Value content_length = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];

    • getContentTypeList

      @Deprecated List<String> getContentTypeList()
      Deprecated.
      envoy.extensions.filters.http.compressor.v3.Compressor.content_type is deprecated. See envoy/extensions/filters/http/compressor/v3/compressor.proto;l=87
       Set of strings that allows specifying which mime-types yield compression; e.g.,
 application/json, text/html, etc. When this field is not defined, compression will be applied
 to the following mime-types: "application/javascript", "application/json",
 "application/xhtml+xml", "image/svg+xml", "text/css", "text/html", "text/plain", "text/xml"
 and their synonyms.
      repeated string content_type = 2 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Returns:
      A list containing the contentType.

    • getContentTypeCount

      @Deprecated int getContentTypeCount()
      Deprecated.
      envoy.extensions.filters.http.compressor.v3.Compressor.content_type is deprecated. See envoy/extensions/filters/http/compressor/v3/compressor.proto;l=87
       Set of strings that allows specifying which mime-types yield compression; e.g.,
 application/json, text/html, etc. When this field is not defined, compression will be applied
 to the following mime-types: "application/javascript", "application/json",
 "application/xhtml+xml", "image/svg+xml", "text/css", "text/html", "text/plain", "text/xml"
 and their synonyms.
      repeated string content_type = 2 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Returns:
      The count of contentType.

    • getContentType

      @Deprecated String getContentType(int index)
      Deprecated.
      envoy.extensions.filters.http.compressor.v3.Compressor.content_type is deprecated. See envoy/extensions/filters/http/compressor/v3/compressor.proto;l=87
       Set of strings that allows specifying which mime-types yield compression; e.g.,
 application/json, text/html, etc. When this field is not defined, compression will be applied
 to the following mime-types: "application/javascript", "application/json",
 "application/xhtml+xml", "image/svg+xml", "text/css", "text/html", "text/plain", "text/xml"
 and their synonyms.
      repeated string content_type = 2 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The contentType at the given index.

    • getContentTypeBytes

      @Deprecated com.google.protobuf.ByteString getContentTypeBytes(int index)
      Deprecated.
      envoy.extensions.filters.http.compressor.v3.Compressor.content_type is deprecated. See envoy/extensions/filters/http/compressor/v3/compressor.proto;l=87
       Set of strings that allows specifying which mime-types yield compression; e.g.,
 application/json, text/html, etc. When this field is not defined, compression will be applied
 to the following mime-types: "application/javascript", "application/json",
 "application/xhtml+xml", "image/svg+xml", "text/css", "text/html", "text/plain", "text/xml"
 and their synonyms.
      repeated string content_type = 2 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the contentType at the given index.

    • getDisableOnEtagHeader

      @Deprecated boolean getDisableOnEtagHeader()
      Deprecated.
      envoy.extensions.filters.http.compressor.v3.Compressor.disable_on_etag_header is deprecated. See envoy/extensions/filters/http/compressor/v3/compressor.proto;l=92
       If true, disables compression when the response contains an etag header. When it is false, the
 filter will preserve weak etags and remove the ones that require strong validation.
      bool disable_on_etag_header = 3 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Returns:
      The disableOnEtagHeader.

    • getRemoveAcceptEncodingHeader

      @Deprecated boolean getRemoveAcceptEncodingHeader()
      Deprecated.
      envoy.extensions.filters.http.compressor.v3.Compressor.remove_accept_encoding_header is deprecated. See envoy/extensions/filters/http/compressor/v3/compressor.proto;l=102
       If true, removes accept-encoding from the request headers before dispatching it 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 = 4 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Returns:
      The removeAcceptEncodingHeader.

    • hasRuntimeEnabled

      @Deprecated boolean hasRuntimeEnabled()
      Deprecated.
      envoy.extensions.filters.http.compressor.v3.Compressor.runtime_enabled is deprecated. See envoy/extensions/filters/http/compressor/v3/compressor.proto;l=108
       Runtime flag that controls whether the filter is enabled or not. If set to false, the
 filter will operate as a pass-through filter, unless overridden by
 CompressorPerRoute. If not specified, defaults to enabled.
      .envoy.config.core.v3.RuntimeFeatureFlag runtime_enabled = 5 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Returns:
      Whether the runtimeEnabled field is set.

    • getRuntimeEnabled

      @Deprecated RuntimeFeatureFlag getRuntimeEnabled()
      Deprecated.
      envoy.extensions.filters.http.compressor.v3.Compressor.runtime_enabled is deprecated. See envoy/extensions/filters/http/compressor/v3/compressor.proto;l=108
       Runtime flag that controls whether the filter is enabled or not. If set to false, the
 filter will operate as a pass-through filter, unless overridden by
 CompressorPerRoute. If not specified, defaults to enabled.
      .envoy.config.core.v3.RuntimeFeatureFlag runtime_enabled = 5 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Returns:
      The runtimeEnabled.

    • getRuntimeEnabledOrBuilder

      @Deprecated RuntimeFeatureFlagOrBuilder getRuntimeEnabledOrBuilder()
      Deprecated.
       Runtime flag that controls whether the filter is enabled or not. If set to false, the
 filter will operate as a pass-through filter, unless overridden by
 CompressorPerRoute. If not specified, defaults to enabled.
      .envoy.config.core.v3.RuntimeFeatureFlag runtime_enabled = 5 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];

    • hasCompressorLibrary

      boolean hasCompressorLibrary()
       A compressor library to use for compression. Currently only
 :ref:`envoy.compression.gzip.compressor<envoy_v3_api_msg_extensions.compression.gzip.compressor.v3.Gzip>`
 is included in Envoy.
 [#extension-category: envoy.compression.compressor]
      .envoy.config.core.v3.TypedExtensionConfig compressor_library = 6 [(.validate.rules) = { ... }
      Returns:
      Whether the compressorLibrary field is set.

    • getCompressorLibrary

      TypedExtensionConfig getCompressorLibrary()
       A compressor library to use for compression. Currently only
 :ref:`envoy.compression.gzip.compressor<envoy_v3_api_msg_extensions.compression.gzip.compressor.v3.Gzip>`
 is included in Envoy.
 [#extension-category: envoy.compression.compressor]
      .envoy.config.core.v3.TypedExtensionConfig compressor_library = 6 [(.validate.rules) = { ... }
      Returns:
      The compressorLibrary.

    • getCompressorLibraryOrBuilder

      TypedExtensionConfigOrBuilder getCompressorLibraryOrBuilder()
       A compressor library to use for compression. Currently only
 :ref:`envoy.compression.gzip.compressor<envoy_v3_api_msg_extensions.compression.gzip.compressor.v3.Gzip>`
 is included in Envoy.
 [#extension-category: envoy.compression.compressor]
      .envoy.config.core.v3.TypedExtensionConfig compressor_library = 6 [(.validate.rules) = { ... }

    • hasRequestDirectionConfig

      boolean hasRequestDirectionConfig()
       Configuration for request compression. Compression is disabled by default if left empty.
      .envoy.extensions.filters.http.compressor.v3.Compressor.RequestDirectionConfig request_direction_config = 7;
      Returns:
      Whether the requestDirectionConfig field is set.

    • getRequestDirectionConfig

      Compressor.RequestDirectionConfig getRequestDirectionConfig()
       Configuration for request compression. Compression is disabled by default if left empty.
      .envoy.extensions.filters.http.compressor.v3.Compressor.RequestDirectionConfig request_direction_config = 7;
      Returns:
      The requestDirectionConfig.

    • getRequestDirectionConfigOrBuilder

      Compressor.RequestDirectionConfigOrBuilder getRequestDirectionConfigOrBuilder()
       Configuration for request compression. Compression is disabled by default if left empty.
      .envoy.extensions.filters.http.compressor.v3.Compressor.RequestDirectionConfig request_direction_config = 7;

    • hasResponseDirectionConfig

      boolean hasResponseDirectionConfig()
       Configuration for response compression. Compression is enabled by default if left empty.

 .. attention::

    If the field is not empty then the duplicate deprecated fields of the ``Compressor`` message,
    such as ``content_length``, ``content_type``, ``disable_on_etag_header``,
    ``remove_accept_encoding_header`` and ``runtime_enabled``, are ignored.

    Also all the statistics related to response compression will be rooted in
    ``<stat_prefix>.compressor.<compressor_library.name>.<compressor_library_stat_prefix>.response.*``
    instead of
    ``<stat_prefix>.compressor.<compressor_library.name>.<compressor_library_stat_prefix>.*``.
      .envoy.extensions.filters.http.compressor.v3.Compressor.ResponseDirectionConfig response_direction_config = 8;
      Returns:
      Whether the responseDirectionConfig field is set.

    • getResponseDirectionConfig

      Compressor.ResponseDirectionConfig getResponseDirectionConfig()
       Configuration for response compression. Compression is enabled by default if left empty.

 .. attention::

    If the field is not empty then the duplicate deprecated fields of the ``Compressor`` message,
    such as ``content_length``, ``content_type``, ``disable_on_etag_header``,
    ``remove_accept_encoding_header`` and ``runtime_enabled``, are ignored.

    Also all the statistics related to response compression will be rooted in
    ``<stat_prefix>.compressor.<compressor_library.name>.<compressor_library_stat_prefix>.response.*``
    instead of
    ``<stat_prefix>.compressor.<compressor_library.name>.<compressor_library_stat_prefix>.*``.
      .envoy.extensions.filters.http.compressor.v3.Compressor.ResponseDirectionConfig response_direction_config = 8;
      Returns:
      The responseDirectionConfig.

    • getResponseDirectionConfigOrBuilder

      Compressor.ResponseDirectionConfigOrBuilder getResponseDirectionConfigOrBuilder()
       Configuration for response compression. Compression is enabled by default if left empty.

 .. attention::

    If the field is not empty then the duplicate deprecated fields of the ``Compressor`` message,
    such as ``content_length``, ``content_type``, ``disable_on_etag_header``,
    ``remove_accept_encoding_header`` and ``runtime_enabled``, are ignored.

    Also all the statistics related to response compression will be rooted in
    ``<stat_prefix>.compressor.<compressor_library.name>.<compressor_library_stat_prefix>.response.*``
    instead of
    ``<stat_prefix>.compressor.<compressor_library.name>.<compressor_library_stat_prefix>.*``.
      .envoy.extensions.filters.http.compressor.v3.Compressor.ResponseDirectionConfig response_direction_config = 8;

    • getChooseFirst

      boolean getChooseFirst()
       If true, chooses this compressor first to do compression when the q-values in ``Accept-Encoding`` are same.
 The last compressor which enables choose_first will be chosen if multiple compressor filters in the chain have choose_first as true.
      bool choose_first = 9;
      Returns:
      The chooseFirst.