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

Class CacheConfig.KeyCreatorParams

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.cache.v3.CacheConfig.KeyCreatorParams
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CacheConfig.KeyCreatorParamsOrBuilder, Serializable
Enclosing class:
CacheConfig
public static final class CacheConfig.KeyCreatorParams extends com.google.protobuf.GeneratedMessageV3 implements CacheConfig.KeyCreatorParamsOrBuilder
 [#not-implemented-hide:]
 Modifies cache key creation by restricting which parts of the URL are included.
Protobuf type envoy.extensions.filters.http.cache.v3.CacheConfig.KeyCreatorParams
See Also:

  • Field Details

    • EXCLUDE_SCHEME_FIELD_NUMBER

      public static final int EXCLUDE_SCHEME_FIELD_NUMBER
      See Also:

    • EXCLUDE_HOST_FIELD_NUMBER

      public static final int EXCLUDE_HOST_FIELD_NUMBER
      See Also:

    • QUERY_PARAMETERS_INCLUDED_FIELD_NUMBER

      public static final int QUERY_PARAMETERS_INCLUDED_FIELD_NUMBER
      See Also:

    • QUERY_PARAMETERS_EXCLUDED_FIELD_NUMBER

      public static final int QUERY_PARAMETERS_EXCLUDED_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

    • getExcludeScheme

      public boolean getExcludeScheme()
       If true, exclude the URL scheme from the cache key. Set to true if your origins always
 produce the same response for http and https requests.
      bool exclude_scheme = 1;
      Specified by:
      getExcludeScheme in interface CacheConfig.KeyCreatorParamsOrBuilder
      Returns:
      The excludeScheme.

    • getExcludeHost

      public boolean getExcludeHost()
       If true, exclude the host from the cache key. Set to true if your origins' responses don't
 ever depend on host.
      bool exclude_host = 2;
      Specified by:
      getExcludeHost in interface CacheConfig.KeyCreatorParamsOrBuilder
      Returns:
      The excludeHost.

    • getQueryParametersIncludedList

      public List<QueryParameterMatcher> getQueryParametersIncludedList()
       If ``query_parameters_included`` is nonempty, only query parameters matched
 by one or more of its matchers are included in the cache key. Any other
 query params will not affect cache lookup.
      repeated .envoy.config.route.v3.QueryParameterMatcher query_parameters_included = 3;
      Specified by:
      getQueryParametersIncludedList in interface CacheConfig.KeyCreatorParamsOrBuilder

    • getQueryParametersIncludedOrBuilderList

      public List<? extends QueryParameterMatcherOrBuilder> getQueryParametersIncludedOrBuilderList()
       If ``query_parameters_included`` is nonempty, only query parameters matched
 by one or more of its matchers are included in the cache key. Any other
 query params will not affect cache lookup.
      repeated .envoy.config.route.v3.QueryParameterMatcher query_parameters_included = 3;
      Specified by:
      getQueryParametersIncludedOrBuilderList in interface CacheConfig.KeyCreatorParamsOrBuilder

    • getQueryParametersIncludedCount

      public int getQueryParametersIncludedCount()
       If ``query_parameters_included`` is nonempty, only query parameters matched
 by one or more of its matchers are included in the cache key. Any other
 query params will not affect cache lookup.
      repeated .envoy.config.route.v3.QueryParameterMatcher query_parameters_included = 3;
      Specified by:
      getQueryParametersIncludedCount in interface CacheConfig.KeyCreatorParamsOrBuilder

    • getQueryParametersIncluded

      public QueryParameterMatcher getQueryParametersIncluded(int index)
       If ``query_parameters_included`` is nonempty, only query parameters matched
 by one or more of its matchers are included in the cache key. Any other
 query params will not affect cache lookup.
      repeated .envoy.config.route.v3.QueryParameterMatcher query_parameters_included = 3;
      Specified by:
      getQueryParametersIncluded in interface CacheConfig.KeyCreatorParamsOrBuilder

    • getQueryParametersIncludedOrBuilder

      public QueryParameterMatcherOrBuilder getQueryParametersIncludedOrBuilder(int index)
       If ``query_parameters_included`` is nonempty, only query parameters matched
 by one or more of its matchers are included in the cache key. Any other
 query params will not affect cache lookup.
      repeated .envoy.config.route.v3.QueryParameterMatcher query_parameters_included = 3;
      Specified by:
      getQueryParametersIncludedOrBuilder in interface CacheConfig.KeyCreatorParamsOrBuilder

    • getQueryParametersExcludedList

      public List<QueryParameterMatcher> getQueryParametersExcludedList()
       If ``query_parameters_excluded`` is nonempty, query parameters matched by one
 or more of its matchers are excluded from the cache key (even if also
 matched by ``query_parameters_included``), and will not affect cache lookup.
      repeated .envoy.config.route.v3.QueryParameterMatcher query_parameters_excluded = 4;
      Specified by:
      getQueryParametersExcludedList in interface CacheConfig.KeyCreatorParamsOrBuilder

    • getQueryParametersExcludedOrBuilderList

      public List<? extends QueryParameterMatcherOrBuilder> getQueryParametersExcludedOrBuilderList()
       If ``query_parameters_excluded`` is nonempty, query parameters matched by one
 or more of its matchers are excluded from the cache key (even if also
 matched by ``query_parameters_included``), and will not affect cache lookup.
      repeated .envoy.config.route.v3.QueryParameterMatcher query_parameters_excluded = 4;
      Specified by:
      getQueryParametersExcludedOrBuilderList in interface CacheConfig.KeyCreatorParamsOrBuilder

    • getQueryParametersExcludedCount

      public int getQueryParametersExcludedCount()
       If ``query_parameters_excluded`` is nonempty, query parameters matched by one
 or more of its matchers are excluded from the cache key (even if also
 matched by ``query_parameters_included``), and will not affect cache lookup.
      repeated .envoy.config.route.v3.QueryParameterMatcher query_parameters_excluded = 4;
      Specified by:
      getQueryParametersExcludedCount in interface CacheConfig.KeyCreatorParamsOrBuilder

    • getQueryParametersExcluded

      public QueryParameterMatcher getQueryParametersExcluded(int index)
       If ``query_parameters_excluded`` is nonempty, query parameters matched by one
 or more of its matchers are excluded from the cache key (even if also
 matched by ``query_parameters_included``), and will not affect cache lookup.
      repeated .envoy.config.route.v3.QueryParameterMatcher query_parameters_excluded = 4;
      Specified by:
      getQueryParametersExcluded in interface CacheConfig.KeyCreatorParamsOrBuilder

    • getQueryParametersExcludedOrBuilder

      public QueryParameterMatcherOrBuilder getQueryParametersExcludedOrBuilder(int index)
       If ``query_parameters_excluded`` is nonempty, query parameters matched by one
 or more of its matchers are excluded from the cache key (even if also
 matched by ``query_parameters_included``), and will not affect cache lookup.
      repeated .envoy.config.route.v3.QueryParameterMatcher query_parameters_excluded = 4;
      Specified by:
      getQueryParametersExcludedOrBuilder in interface CacheConfig.KeyCreatorParamsOrBuilder

    • 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.KeyCreatorParams parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static CacheConfig.KeyCreatorParams 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.KeyCreatorParams parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static CacheConfig.KeyCreatorParams parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static CacheConfig.KeyCreatorParams.Builder newBuilder()

    • newBuilder

      public static CacheConfig.KeyCreatorParams.Builder newBuilder(CacheConfig.KeyCreatorParams prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static CacheConfig.KeyCreatorParams getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<CacheConfig.KeyCreatorParams> 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.KeyCreatorParams getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder