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

Class CacheConfig.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<CacheConfig.Builder>
io.envoyproxy.envoy.extensions.filters.http.cache.v3.CacheConfig.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CacheConfigOrBuilder, Cloneable
Enclosing class:
CacheConfig
public static final class CacheConfig.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<CacheConfig.Builder> implements CacheConfigOrBuilder
 [#extension: envoy.filters.http.cache]
 [#next-free-field: 7]
Protobuf type envoy.extensions.filters.http.cache.v3.CacheConfig

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<CacheConfig.Builder>

    • clear

      public CacheConfig.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<CacheConfig.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<CacheConfig.Builder>

    • getDefaultInstanceForType

      public CacheConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public CacheConfig build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public CacheConfig buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public CacheConfig.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<CacheConfig.Builder>

    • setField

      public CacheConfig.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<CacheConfig.Builder>

    • clearField

      public CacheConfig.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<CacheConfig.Builder>

    • clearOneof

      public CacheConfig.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<CacheConfig.Builder>

    • setRepeatedField

      public CacheConfig.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CacheConfig.Builder>

    • addRepeatedField

      public CacheConfig.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CacheConfig.Builder>

    • mergeFrom

      public CacheConfig.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CacheConfig.Builder>

    • mergeFrom

      public CacheConfig.Builder mergeFrom(CacheConfig other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<CacheConfig.Builder>

    • mergeFrom

      public CacheConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CacheConfig.Builder>
      Throws:
      IOException

    • hasTypedConfig

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

    • getTypedConfig

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

    • setTypedConfig

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

    • setTypedConfig

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

    • mergeTypedConfig

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

    • clearTypedConfig

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

    • getTypedConfigBuilder

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

    • getTypedConfigOrBuilder

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

    • hasDisabled

      public 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;
      Specified by:
      hasDisabled in interface CacheConfigOrBuilder
      Returns:
      Whether the disabled field is set.

    • getDisabled

      public 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;
      Specified by:
      getDisabled in interface CacheConfigOrBuilder
      Returns:
      The disabled.

    • setDisabled

      public CacheConfig.Builder setDisabled(com.google.protobuf.BoolValue value)
       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;

    • setDisabled

      public CacheConfig.Builder setDisabled(com.google.protobuf.BoolValue.Builder builderForValue)
       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;

    • mergeDisabled

      public CacheConfig.Builder mergeDisabled(com.google.protobuf.BoolValue value)
       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;

    • clearDisabled

      public CacheConfig.Builder clearDisabled()
       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;

    • getDisabledBuilder

      public com.google.protobuf.BoolValue.Builder getDisabledBuilder()
       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;

    • getDisabledOrBuilder

      public 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;
      Specified by:
      getDisabledOrBuilder in interface CacheConfigOrBuilder

    • getAllowedVaryHeadersList

      public 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;
      Specified by:
      getAllowedVaryHeadersList in interface CacheConfigOrBuilder

    • getAllowedVaryHeadersCount

      public 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;
      Specified by:
      getAllowedVaryHeadersCount in interface CacheConfigOrBuilder

    • getAllowedVaryHeaders

      public 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;
      Specified by:
      getAllowedVaryHeaders in interface CacheConfigOrBuilder

    • setAllowedVaryHeaders

      public CacheConfig.Builder setAllowedVaryHeaders(int index, StringMatcher value)
       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;

    • setAllowedVaryHeaders

      public CacheConfig.Builder setAllowedVaryHeaders(int index, StringMatcher.Builder builderForValue)
       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;

    • addAllowedVaryHeaders

      public CacheConfig.Builder addAllowedVaryHeaders(StringMatcher value)
       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;

    • addAllowedVaryHeaders

      public CacheConfig.Builder addAllowedVaryHeaders(int index, StringMatcher value)
       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;

    • addAllowedVaryHeaders

      public CacheConfig.Builder addAllowedVaryHeaders(StringMatcher.Builder builderForValue)
       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;

    • addAllowedVaryHeaders

      public CacheConfig.Builder addAllowedVaryHeaders(int index, StringMatcher.Builder builderForValue)
       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;

    • addAllAllowedVaryHeaders

      public CacheConfig.Builder addAllAllowedVaryHeaders(Iterable<? extends StringMatcher> values)
       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;

    • clearAllowedVaryHeaders

      public CacheConfig.Builder clearAllowedVaryHeaders()
       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;

    • removeAllowedVaryHeaders

      public CacheConfig.Builder removeAllowedVaryHeaders(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;

    • getAllowedVaryHeadersBuilder

      public StringMatcher.Builder getAllowedVaryHeadersBuilder(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;

    • getAllowedVaryHeadersOrBuilder

      public 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;
      Specified by:
      getAllowedVaryHeadersOrBuilder in interface CacheConfigOrBuilder

    • getAllowedVaryHeadersOrBuilderList

      public 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;
      Specified by:
      getAllowedVaryHeadersOrBuilderList in interface CacheConfigOrBuilder

    • addAllowedVaryHeadersBuilder

      public StringMatcher.Builder addAllowedVaryHeadersBuilder()
       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;

    • addAllowedVaryHeadersBuilder

      public StringMatcher.Builder addAllowedVaryHeadersBuilder(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;

    • getAllowedVaryHeadersBuilderList

      public List<StringMatcher.Builder> getAllowedVaryHeadersBuilderList()
       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

      public 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;
      Specified by:
      hasKeyCreatorParams in interface CacheConfigOrBuilder
      Returns:
      Whether the keyCreatorParams field is set.

    • getKeyCreatorParams

      public 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;
      Specified by:
      getKeyCreatorParams in interface CacheConfigOrBuilder
      Returns:
      The keyCreatorParams.

    • setKeyCreatorParams

      public CacheConfig.Builder setKeyCreatorParams(CacheConfig.KeyCreatorParams value)
       [#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;

    • setKeyCreatorParams

      public CacheConfig.Builder setKeyCreatorParams(CacheConfig.KeyCreatorParams.Builder builderForValue)
       [#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;

    • mergeKeyCreatorParams

      public CacheConfig.Builder mergeKeyCreatorParams(CacheConfig.KeyCreatorParams value)
       [#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;

    • clearKeyCreatorParams

      public CacheConfig.Builder clearKeyCreatorParams()
       [#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;

    • getKeyCreatorParamsBuilder

      public CacheConfig.KeyCreatorParams.Builder getKeyCreatorParamsBuilder()
       [#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;

    • getKeyCreatorParamsOrBuilder

      public 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;
      Specified by:
      getKeyCreatorParamsOrBuilder in interface CacheConfigOrBuilder

    • getMaxBodyBytes

      public 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;
      Specified by:
      getMaxBodyBytes in interface CacheConfigOrBuilder
      Returns:
      The maxBodyBytes.

    • setMaxBodyBytes

      public CacheConfig.Builder setMaxBodyBytes(int value)
       [#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;
      Parameters:
      value - The maxBodyBytes to set.
      Returns:
      This builder for chaining.

    • clearMaxBodyBytes

      public CacheConfig.Builder clearMaxBodyBytes()
       [#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:
      This builder for chaining.

    • getIgnoreRequestCacheControlHeader

      public 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;
      Specified by:
      getIgnoreRequestCacheControlHeader in interface CacheConfigOrBuilder
      Returns:
      The ignoreRequestCacheControlHeader.

    • setIgnoreRequestCacheControlHeader

      public CacheConfig.Builder setIgnoreRequestCacheControlHeader(boolean value)
       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;
      Parameters:
      value - The ignoreRequestCacheControlHeader to set.
      Returns:
      This builder for chaining.

    • clearIgnoreRequestCacheControlHeader

      public CacheConfig.Builder clearIgnoreRequestCacheControlHeader()
       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:
      This builder for chaining.

    • setUnknownFields

      public final CacheConfig.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CacheConfig.Builder>

    • mergeUnknownFields

      public final CacheConfig.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CacheConfig.Builder>