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

Class CacheV2Config.Builder

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

  • 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<CacheV2Config.Builder>

    • clear

      public CacheV2Config.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<CacheV2Config.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<CacheV2Config.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public CacheV2Config.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<CacheV2Config.Builder>

    • setField

      public CacheV2Config.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<CacheV2Config.Builder>

    • clearField

      public CacheV2Config.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<CacheV2Config.Builder>

    • clearOneof

      public CacheV2Config.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<CacheV2Config.Builder>

    • setRepeatedField

      public CacheV2Config.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<CacheV2Config.Builder>

    • addRepeatedField

      public CacheV2Config.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<CacheV2Config.Builder>

    • mergeFrom

      public CacheV2Config.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<CacheV2Config.Builder>

    • mergeFrom

      public CacheV2Config.Builder mergeFrom(CacheV2Config other)

    • isInitialized

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

    • mergeFrom

      public CacheV2Config.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<CacheV2Config.Builder>
      Throws:
      IOException

    • hasTypedConfig

      public 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;
      Specified by:
      hasTypedConfig in interface CacheV2ConfigOrBuilder
      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_v2]
      .google.protobuf.Any typed_config = 1;
      Specified by:
      getTypedConfig in interface CacheV2ConfigOrBuilder
      Returns:
      The typedConfig.

    • setTypedConfig

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

    • setTypedConfig

      public CacheV2Config.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_v2]
      .google.protobuf.Any typed_config = 1;

    • mergeTypedConfig

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

    • clearTypedConfig

      public CacheV2Config.Builder clearTypedConfig()
       Config specific to the cache storage implementation. Required unless ``disabled``
 is true.
 [#extension-category: envoy.http.cache_v2]
      .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_v2]
      .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_v2]
      .google.protobuf.Any typed_config = 1;
      Specified by:
      getTypedConfigOrBuilder in interface CacheV2ConfigOrBuilder

    • 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 CacheV2ConfigOrBuilder
      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 CacheV2ConfigOrBuilder
      Returns:
      The disabled.

    • setDisabled

      public CacheV2Config.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 CacheV2Config.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 CacheV2Config.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 CacheV2Config.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 CacheV2ConfigOrBuilder

    • getAllowedVaryHeadersList

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

    • getAllowedVaryHeadersCount

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

    • getAllowedVaryHeaders

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

    • setAllowedVaryHeaders

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

    • setAllowedVaryHeaders

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

    • addAllowedVaryHeaders

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

    • addAllowedVaryHeaders

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

    • addAllowedVaryHeaders

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

    • addAllowedVaryHeaders

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

    • addAllAllowedVaryHeaders

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

    • clearAllowedVaryHeaders

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

    • removeAllowedVaryHeaders

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

    • getAllowedVaryHeadersBuilder

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

    • getAllowedVaryHeadersOrBuilder

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

    • getAllowedVaryHeadersOrBuilderList

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

    • addAllowedVaryHeadersBuilder

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

    • addAllowedVaryHeadersBuilder

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

    • getAllowedVaryHeadersBuilderList

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

      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_v2.v3.CacheV2Config.KeyCreatorParams key_creator_params = 3;
      Specified by:
      hasKeyCreatorParams in interface CacheV2ConfigOrBuilder
      Returns:
      Whether the keyCreatorParams field is set.

    • getKeyCreatorParams

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

    • setKeyCreatorParams

      public CacheV2Config.Builder setKeyCreatorParams(CacheV2Config.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_v2.v3.CacheV2Config.KeyCreatorParams key_creator_params = 3;

    • setKeyCreatorParams

      public CacheV2Config.Builder setKeyCreatorParams(CacheV2Config.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_v2.v3.CacheV2Config.KeyCreatorParams key_creator_params = 3;

    • mergeKeyCreatorParams

      public CacheV2Config.Builder mergeKeyCreatorParams(CacheV2Config.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_v2.v3.CacheV2Config.KeyCreatorParams key_creator_params = 3;

    • clearKeyCreatorParams

      public CacheV2Config.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_v2.v3.CacheV2Config.KeyCreatorParams key_creator_params = 3;

    • getKeyCreatorParamsBuilder

      public CacheV2Config.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_v2.v3.CacheV2Config.KeyCreatorParams key_creator_params = 3;

    • getKeyCreatorParamsOrBuilder

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

    • 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 CacheV2ConfigOrBuilder
      Returns:
      The maxBodyBytes.

    • setMaxBodyBytes

      public CacheV2Config.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 CacheV2Config.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 CacheV2ConfigOrBuilder
      Returns:
      The ignoreRequestCacheControlHeader.

    • setIgnoreRequestCacheControlHeader

      public CacheV2Config.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 CacheV2Config.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.

    • getOverrideUpstreamCluster

      public 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;
      Specified by:
      getOverrideUpstreamCluster in interface CacheV2ConfigOrBuilder
      Returns:
      The overrideUpstreamCluster.

    • getOverrideUpstreamClusterBytes

      public 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;
      Specified by:
      getOverrideUpstreamClusterBytes in interface CacheV2ConfigOrBuilder
      Returns:
      The bytes for overrideUpstreamCluster.

    • setOverrideUpstreamCluster

      public CacheV2Config.Builder setOverrideUpstreamCluster(String value)
       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;
      Parameters:
      value - The overrideUpstreamCluster to set.
      Returns:
      This builder for chaining.

    • clearOverrideUpstreamCluster

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

    • setOverrideUpstreamClusterBytes

      public CacheV2Config.Builder setOverrideUpstreamClusterBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for overrideUpstreamCluster to set.
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final CacheV2Config.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<CacheV2Config.Builder>

    • mergeUnknownFields

      public final CacheV2Config.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<CacheV2Config.Builder>