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

Class CacheConfig

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CacheConfigOrBuilder, Serializable
    public final class CacheConfig
extends com.google.protobuf.GeneratedMessageV3
implements CacheConfigOrBuilder
     [#extension: envoy.filters.http.cache]
    Protobuf type envoy.extensions.filters.http.cache.v3.CacheConfig
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  CacheConfig.Builder
      [#extension: envoy.filters.http.cache]
      static class  CacheConfig.KeyCreatorParams
      [#not-implemented-hide:] Modifies cache key creation by restricting which parts of the URL are included.
      static interface  CacheConfig.KeyCreatorParamsOrBuilder  

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Detail

      • TYPED_CONFIG_FIELD_NUMBER

        public static final int TYPED_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ALLOWED_VARY_HEADERS_FIELD_NUMBER

        public static final int ALLOWED_VARY_HEADERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • KEY_CREATOR_PARAMS_FIELD_NUMBER

        public static final int KEY_CREATOR_PARAMS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MAX_BODY_BYTES_FIELD_NUMBER

        public static final int MAX_BODY_BYTES_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • 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

      • hasTypedConfig

        public boolean hasTypedConfig()
         Config specific to the cache storage implementation.
 [#extension-category: envoy.http.cache]
        .google.protobuf.Any typed_config = 1 [(.validate.rules) = { ... }
        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.
 [#extension-category: envoy.http.cache]
        .google.protobuf.Any typed_config = 1 [(.validate.rules) = { ... }
        Specified by:
        getTypedConfig in interface CacheConfigOrBuilder
        Returns:
        The typedConfig.

      • getTypedConfigOrBuilder

        public 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) = { ... }
        Specified by:
        getTypedConfigOrBuilder 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

      • 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

      • 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

      • 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

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

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

      • isInitialized

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

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static CacheConfig parseFrom​(ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CacheConfig parseFrom​(ByteBuffer data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CacheConfig parseFrom​(com.google.protobuf.ByteString data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CacheConfig parseFrom​(com.google.protobuf.ByteString data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CacheConfig parseFrom​(byte[] data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CacheConfig parseFrom​(byte[] data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CacheConfig parseFrom​(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException
        Throws:
        IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected CacheConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static CacheConfig getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<CacheConfig> parser()

      • getParserForType

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

      • getDefaultInstanceForType

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