package envoy.extensions.filters.http.compressor.v3

Get desktop application:
View/edit binary Protocol Buffers messages

[#next-free-field: 10]

Used in: gzip.v3.Gzip

• optional google.protobuf.UInt32Value content_length = 1

  Minimum response length, in bytes, which will trigger compression. The default value is 30.

• repeated string content_type = 2

  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.

• bool disable_on_etag_header = 3

  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 remove_accept_encoding_header = 4

  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.

• optional config.core.v3.RuntimeFeatureFlag runtime_enabled = 5

  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.

• optional config.core.v3.TypedExtensionConfig compressor_library = 6

  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]

• optional Compressor.RequestDirectionConfig request_direction_config = 7

  Configuration for request compression. Compression is disabled by default if left empty.

• optional Compressor.ResponseDirectionConfig response_direction_config = 8

  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>.*``.

• bool choose_first = 9

  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.

Used in: RequestDirectionConfig, ResponseDirectionConfig

• optional config.core.v3.RuntimeFeatureFlag enabled = 1

  Runtime flag that controls whether compression is enabled or not for the direction this common config is put in. If set to false, the filter will operate as a pass-through filter in the chosen direction, unless overridden by CompressorPerRoute. If the field is omitted, the filter will be enabled.

• optional google.protobuf.UInt32Value min_content_length = 2

  Minimum value of Content-Length header of request or response messages (depending on the direction this common config is put in), in bytes, which will trigger compression. The default value is 30.

• repeated string content_type = 3

  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.

Configuration for filter behavior on the request direction.

Used in: Compressor

• optional CommonDirectionConfig common_config = 1

Configuration for filter behavior on the response direction.

Used in: Compressor

• optional CommonDirectionConfig common_config = 1

• bool disable_on_etag_header = 2

  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 remove_accept_encoding_header = 3

  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.

• repeated uint32 uncompressible_response_codes = 4

  Set of response codes for which compression is disabled, e.g. 206 Partial Content should not be compressed.

Per-route overrides. As per-route overrides are needed, they should be added here, mirroring the structure of ``Compressor``. All fields should be optional, to allow overriding arbitrary subsets of configuration.

Used in: CompressorPerRoute

• optional ResponseDirectionOverrides response_direction_config = 1

  If present, response compression is enabled.

• oneof override

  • bool disabled = 1

    If set, the filter will operate as a pass-through filter. Overrides Compressor.runtime_enabled and CommonDirectionConfig.enabled.

  • CompressorOverrides overrides = 2

    Per-route overrides. Fields set here will override corresponding fields in ``Compressor``.

Per-route overrides of ``ResponseDirectionConfig``. Anything added here should be optional, to allow overriding arbitrary subsets of configuration. Omitted fields must have no effect.

Used in: CompressorOverrides

• optional google.protobuf.BoolValue remove_accept_encoding_header = 1

  If set, overrides the filter-level :ref:`remove_accept_encoding_header<envoy_v3_api_field_extensions.filters.http.compressor.v3.Compressor.ResponseDirectionConfig.remove_accept_encoding_header>`.