Package io.envoyproxy.envoy.config.filter.http.cache.v2alpha

Class CacheConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.config.filter.http.cache.v2alpha.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
Protobuf type envoy.config.filter.http.cache.v2alpha.CacheConfig
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    CacheConfig.Builder
    Protobuf type envoy.config.filter.http.cache.v2alpha.CacheConfig
    static final 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<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, 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 Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ALLOWED_VARY_HEADERS_FIELD_NUMBER
     
    static final int
    KEY_CREATOR_PARAMS_FIELD_NUMBER
     
    static final int
    MAX_BODY_BYTES_FIELD_NUMBER
     
    static final int
    TYPED_CONFIG_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    StringMatcher
    getAllowedVaryHeaders(int index)
    List of matching rules that defines allowed *Vary* headers.
    int
    getAllowedVaryHeadersCount()
    List of matching rules that defines allowed *Vary* headers.
    List<StringMatcher>
    getAllowedVaryHeadersList()
    List of matching rules that defines allowed *Vary* headers.
    StringMatcherOrBuilder
    getAllowedVaryHeadersOrBuilder(int index)
    List of matching rules that defines allowed *Vary* headers.
    List<? extends StringMatcherOrBuilder>
    getAllowedVaryHeadersOrBuilderList()
    List of matching rules that defines allowed *Vary* headers.
    static CacheConfig
    getDefaultInstance()
     
    CacheConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    CacheConfig.KeyCreatorParams
    getKeyCreatorParams()
    [#not-implemented-hide:] <TODO(toddmgreer) implement key customization> Modifies cache key creation by restricting which parts of the URL are included.
    CacheConfig.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).
    com.google.protobuf.Parser<CacheConfig>
    getParserForType()
     
    int
    getSerializedSize()
     
    com.google.protobuf.Any
    getTypedConfig()
    Config specific to the cache storage implementation.
    com.google.protobuf.AnyOrBuilder
    getTypedConfigOrBuilder()
    Config specific to the cache storage implementation.
    int
    hashCode()
     
    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.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static CacheConfig.Builder
    newBuilder()
     
    static CacheConfig.Builder
    newBuilder(CacheConfig prototype)
     
    CacheConfig.Builder
    newBuilderForType()
     
    protected CacheConfig.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static CacheConfig
    parseDelimitedFrom(InputStream input)
     
    static CacheConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CacheConfig
    parseFrom(byte[] data)
     
    static CacheConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CacheConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static CacheConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CacheConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static CacheConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CacheConfig
    parseFrom(InputStream input)
     
    static CacheConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CacheConfig
    parseFrom(ByteBuffer data)
     
    static CacheConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<CacheConfig>
    parser()
     
    CacheConfig.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • TYPED_CONFIG_FIELD_NUMBER

      public static final int TYPED_CONFIG_FIELD_NUMBER
      See Also:

    • ALLOWED_VARY_HEADERS_FIELD_NUMBER

      public static final int ALLOWED_VARY_HEADERS_FIELD_NUMBER
      See Also:

    • KEY_CREATOR_PARAMS_FIELD_NUMBER

      public static final int KEY_CREATOR_PARAMS_FIELD_NUMBER
      See Also:

    • MAX_BODY_BYTES_FIELD_NUMBER

      public static final int MAX_BODY_BYTES_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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.
      .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.
      .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.
      .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.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.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.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.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.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.config.filter.http.cache.v2alpha.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.config.filter.http.cache.v2alpha.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.config.filter.http.cache.v2alpha.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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static CacheConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CacheConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • 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

    • newBuilder

      public static CacheConfig.Builder newBuilder()

    • newBuilder

      public static CacheConfig.Builder newBuilder(CacheConfig prototype)

    • 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