package envoy.extensions.filters.http.cache.v3

Get desktop application:
View/edit binary Protocol Buffers messages

[#extension: envoy.filters.http.cache] [#next-free-field: 7]

• optional google.protobuf.Any typed_config = 1

  Config specific to the cache storage implementation. Required unless ``disabled`` is true. [#extension-category: envoy.http.cache]

• optional google.protobuf.BoolValue disabled = 5

  When true, the cache filter is a no-op filter. Possible use-cases for this include: - Turning a filter on and off with :ref:`ECDS <envoy_v3_api_file_envoy/service/extension/v3/config_discovery.proto>`. [#comment: once route-specific overrides are implemented, they are the more likely use-case.]

• repeated type.matcher.v3.StringMatcher allowed_vary_headers = 2

  List of matching rules that defines allowed ``Vary`` headers. The ``vary`` response header holds a list of header names that affect the contents of a response, as described by https://httpwg.org/specs/rfc7234.html#caching.negotiated.responses. During insertion, ``allowed_vary_headers`` acts as a allowlist: if a response's ``vary`` header mentions any header names that aren't matched by any rules in ``allowed_vary_headers``, that response will not be cached. During lookup, ``allowed_vary_headers`` controls what request headers will be sent to the cache storage implementation.

• optional CacheConfig.KeyCreatorParams key_creator_params = 3

  [#not-implemented-hide:] <TODO(toddmgreer) implement key customization> Modifies cache key creation by restricting which parts of the URL are included.

• uint32 max_body_bytes = 4

  [#not-implemented-hide:] <TODO(toddmgreer) implement size limit> Max body size the cache filter will insert into a cache. 0 means unlimited (though the cache storage implementation may have its own limit beyond which it will reject insertions).

• bool ignore_request_cache_control_header = 6

  By default, a ``cache-control: no-cache`` or ``pragma: no-cache`` header in the request causes the cache to validate with its upstream even if the lookup is a hit. Setting this to true will ignore these headers.

[#not-implemented-hide:] Modifies cache key creation by restricting which parts of the URL are included.

Used in: CacheConfig

• bool exclude_scheme = 1

  If true, exclude the URL scheme from the cache key. Set to true if your origins always produce the same response for http and https requests.

• bool exclude_host = 2

  If true, exclude the host from the cache key. Set to true if your origins' responses don't ever depend on host.

• repeated config.route.v3.QueryParameterMatcher query_parameters_included = 3

  If ``query_parameters_included`` is nonempty, only query parameters matched by one or more of its matchers are included in the cache key. Any other query params will not affect cache lookup.

• repeated config.route.v3.QueryParameterMatcher query_parameters_excluded = 4

  If ``query_parameters_excluded`` is nonempty, query parameters matched by one or more of its matchers are excluded from the cache key (even if also matched by ``query_parameters_included``), and will not affect cache lookup.