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

Interface CacheConfigOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    CacheConfig, CacheConfig.Builder
    public interface CacheConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • hasTypedConfig

        boolean hasTypedConfig()
         Config specific to the cache storage implementation.
 [#extension-category: envoy.http.cache]
        .google.protobuf.Any typed_config = 1 [(.validate.rules) = { ... }
        Returns:
        Whether the typedConfig field is set.

      • getTypedConfig

        com.google.protobuf.Any getTypedConfig()
         Config specific to the cache storage implementation.
 [#extension-category: envoy.http.cache]
        .google.protobuf.Any typed_config = 1 [(.validate.rules) = { ... }
        Returns:
        The typedConfig.

      • getTypedConfigOrBuilder

        com.google.protobuf.AnyOrBuilder getTypedConfigOrBuilder()
         Config specific to the cache storage implementation.
 [#extension-category: envoy.http.cache]
        .google.protobuf.Any typed_config = 1 [(.validate.rules) = { ... }

      • getAllowedVaryHeadersList

        java.util.List<StringMatcher> getAllowedVaryHeadersList()
         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.
        repeated .envoy.type.matcher.v3.StringMatcher allowed_vary_headers = 2;

      • getAllowedVaryHeaders

        StringMatcher getAllowedVaryHeaders​(int index)
         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.
        repeated .envoy.type.matcher.v3.StringMatcher allowed_vary_headers = 2;

      • getAllowedVaryHeadersCount

        int getAllowedVaryHeadersCount()
         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.
        repeated .envoy.type.matcher.v3.StringMatcher allowed_vary_headers = 2;

      • getAllowedVaryHeadersOrBuilderList

        java.util.List<? extends StringMatcherOrBuilder> getAllowedVaryHeadersOrBuilderList()
         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.
        repeated .envoy.type.matcher.v3.StringMatcher allowed_vary_headers = 2;

      • getAllowedVaryHeadersOrBuilder

        StringMatcherOrBuilder getAllowedVaryHeadersOrBuilder​(int index)
         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.
        repeated .envoy.type.matcher.v3.StringMatcher allowed_vary_headers = 2;

      • hasKeyCreatorParams

        boolean hasKeyCreatorParams()
         [#not-implemented-hide:]
 <TODO(toddmgreer) implement key customization>
 Modifies cache key creation by restricting which parts of the URL are included.
        .envoy.extensions.filters.http.cache.v3.CacheConfig.KeyCreatorParams key_creator_params = 3;
        Returns:
        Whether the keyCreatorParams field is set.

      • getKeyCreatorParams

        CacheConfig.KeyCreatorParams getKeyCreatorParams()
         [#not-implemented-hide:]
 <TODO(toddmgreer) implement key customization>
 Modifies cache key creation by restricting which parts of the URL are included.
        .envoy.extensions.filters.http.cache.v3.CacheConfig.KeyCreatorParams key_creator_params = 3;
        Returns:
        The keyCreatorParams.

      • getKeyCreatorParamsOrBuilder

        CacheConfig.KeyCreatorParamsOrBuilder getKeyCreatorParamsOrBuilder()
         [#not-implemented-hide:]
 <TODO(toddmgreer) implement key customization>
 Modifies cache key creation by restricting which parts of the URL are included.
        .envoy.extensions.filters.http.cache.v3.CacheConfig.KeyCreatorParams key_creator_params = 3;

      • getMaxBodyBytes

        int getMaxBodyBytes()
         [#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).
        uint32 max_body_bytes = 4;
        Returns:
        The maxBodyBytes.