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

Interface CacheV2ConfigOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    StringMatcher
    getAllowedVaryHeaders(int index)
    [#not-implemented-hide:] List of matching rules that defines allowed ``Vary`` headers.
    int
    getAllowedVaryHeadersCount()
    [#not-implemented-hide:] List of matching rules that defines allowed ``Vary`` headers.
    List<StringMatcher>
    getAllowedVaryHeadersList()
    [#not-implemented-hide:] List of matching rules that defines allowed ``Vary`` headers.
    StringMatcherOrBuilder
    getAllowedVaryHeadersOrBuilder(int index)
    [#not-implemented-hide:] List of matching rules that defines allowed ``Vary`` headers.
    List<? extends StringMatcherOrBuilder>
    getAllowedVaryHeadersOrBuilderList()
    [#not-implemented-hide:] List of matching rules that defines allowed ``Vary`` headers.
    com.google.protobuf.BoolValue
    getDisabled()
    When true, the cache filter is a no-op filter.
    com.google.protobuf.BoolValueOrBuilder
    getDisabledOrBuilder()
    When true, the cache filter is a no-op filter.
    boolean
    getIgnoreRequestCacheControlHeader()
    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.
    CacheV2Config.KeyCreatorParams
    getKeyCreatorParams()
    [#not-implemented-hide:] <TODO(toddmgreer) implement key customization> Modifies cache key creation by restricting which parts of the URL are included.
    CacheV2Config.KeyCreatorParamsOrBuilder
    getKeyCreatorParamsOrBuilder()
    [#not-implemented-hide:] <TODO(toddmgreer) implement key customization> Modifies cache key creation by restricting which parts of the URL are included.
    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).
    String
    getOverrideUpstreamCluster()
    If this is set, requests sent upstream to populate the cache will go to the specified cluster rather than the cluster selected by the vhost and route.
    com.google.protobuf.ByteString
    getOverrideUpstreamClusterBytes()
    If this is set, requests sent upstream to populate the cache will go to the specified cluster rather than the cluster selected by the vhost and route.
    com.google.protobuf.Any
    getTypedConfig()
    Config specific to the cache storage implementation.
    com.google.protobuf.AnyOrBuilder
    getTypedConfigOrBuilder()
    Config specific to the cache storage implementation.
    boolean
    hasDisabled()
    When true, the cache filter is a no-op filter.
    boolean
    hasKeyCreatorParams()
    [#not-implemented-hide:] <TODO(toddmgreer) implement key customization> Modifies cache key creation by restricting which parts of the URL are included.
    boolean
    hasTypedConfig()
    Config specific to the cache storage implementation.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasTypedConfig

      boolean hasTypedConfig()
       Config specific to the cache storage implementation. Required unless ``disabled``
 is true.
 [#extension-category: envoy.http.cache_v2]
      .google.protobuf.Any typed_config = 1;
      Returns:
      Whether the typedConfig field is set.

    • getTypedConfig

      com.google.protobuf.Any getTypedConfig()
       Config specific to the cache storage implementation. Required unless ``disabled``
 is true.
 [#extension-category: envoy.http.cache_v2]
      .google.protobuf.Any typed_config = 1;
      Returns:
      The typedConfig.

    • getTypedConfigOrBuilder

      com.google.protobuf.AnyOrBuilder getTypedConfigOrBuilder()
       Config specific to the cache storage implementation. Required unless ``disabled``
 is true.
 [#extension-category: envoy.http.cache_v2]
      .google.protobuf.Any typed_config = 1;

    • hasDisabled

      boolean hasDisabled()
       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.]
      .google.protobuf.BoolValue disabled = 5;
      Returns:
      Whether the disabled field is set.

    • getDisabled

      com.google.protobuf.BoolValue getDisabled()
       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.]
      .google.protobuf.BoolValue disabled = 5;
      Returns:
      The disabled.

    • getDisabledOrBuilder

      com.google.protobuf.BoolValueOrBuilder getDisabledOrBuilder()
       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.]
      .google.protobuf.BoolValue disabled = 5;

    • getAllowedVaryHeadersList

      List<StringMatcher> getAllowedVaryHeadersList()
       [#not-implemented-hide:]
 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)
       [#not-implemented-hide:]
 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()
       [#not-implemented-hide:]
 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

      List<? extends StringMatcherOrBuilder> getAllowedVaryHeadersOrBuilderList()
       [#not-implemented-hide:]
 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)
       [#not-implemented-hide:]
 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_v2.v3.CacheV2Config.KeyCreatorParams key_creator_params = 3;
      Returns:
      Whether the keyCreatorParams field is set.

    • getKeyCreatorParams

      CacheV2Config.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_v2.v3.CacheV2Config.KeyCreatorParams key_creator_params = 3;
      Returns:
      The keyCreatorParams.

    • getKeyCreatorParamsOrBuilder

      CacheV2Config.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_v2.v3.CacheV2Config.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.

    • getIgnoreRequestCacheControlHeader

      boolean getIgnoreRequestCacheControlHeader()
       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.
      bool ignore_request_cache_control_header = 6;
      Returns:
      The ignoreRequestCacheControlHeader.

    • getOverrideUpstreamCluster

      String getOverrideUpstreamCluster()
       If this is set, requests sent upstream to populate the cache will go to the
 specified cluster rather than the cluster selected by the vhost and route.

 If you have actions to be taken by the router filter - either
 ``upstream_http_filters`` or one of the ``RouteConfiguration`` actions such as
 ``response_headers_to_add`` - then the cache's side-channel going directly to the
 routed cluster will bypass these actions. You can set ``override_upstream_cluster``
 to an internal listener which duplicates the relevant ``RouteConfiguration``, to
 replicate the desired behavior on the side-channel upstream request issued by the
 cache.

 This is a workaround for implementation constraints which it is hoped will at some
 point become unnecessary, then unsupported and this field will be removed.
      string override_upstream_cluster = 7;
      Returns:
      The overrideUpstreamCluster.

    • getOverrideUpstreamClusterBytes

      com.google.protobuf.ByteString getOverrideUpstreamClusterBytes()
       If this is set, requests sent upstream to populate the cache will go to the
 specified cluster rather than the cluster selected by the vhost and route.

 If you have actions to be taken by the router filter - either
 ``upstream_http_filters`` or one of the ``RouteConfiguration`` actions such as
 ``response_headers_to_add`` - then the cache's side-channel going directly to the
 routed cluster will bypass these actions. You can set ``override_upstream_cluster``
 to an internal listener which duplicates the relevant ``RouteConfiguration``, to
 replicate the desired behavior on the side-channel upstream request issued by the
 cache.

 This is a workaround for implementation constraints which it is hoped will at some
 point become unnecessary, then unsupported and this field will be removed.
      string override_upstream_cluster = 7;
      Returns:
      The bytes for overrideUpstreamCluster.