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

Interface CacheConfig.KeyCreatorParamsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CacheConfig.KeyCreatorParams, CacheConfig.KeyCreatorParams.Builder
Enclosing class:
CacheConfig
public static interface CacheConfig.KeyCreatorParamsOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getExcludeHost()
    If true, exclude the host from the cache key.
    boolean
    getExcludeScheme()
    If true, exclude the URL scheme from the cache key.
    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.
    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.
    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.
    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.
    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.
    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.
    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.
    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.
    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.
    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.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getExcludeScheme

      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;
      Returns:
      The excludeScheme.

    • getExcludeHost

      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;
      Returns:
      The excludeHost.

    • getQueryParametersIncludedList

      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.api.v2.route.QueryParameterMatcher query_parameters_included = 3;

    • getQueryParametersIncluded

      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.api.v2.route.QueryParameterMatcher query_parameters_included = 3;

    • getQueryParametersIncludedCount

      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.api.v2.route.QueryParameterMatcher query_parameters_included = 3;

    • getQueryParametersIncludedOrBuilderList

      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.api.v2.route.QueryParameterMatcher query_parameters_included = 3;

    • getQueryParametersIncludedOrBuilder

      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.api.v2.route.QueryParameterMatcher query_parameters_included = 3;

    • getQueryParametersExcludedList

      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.api.v2.route.QueryParameterMatcher query_parameters_excluded = 4;

    • getQueryParametersExcluded

      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.api.v2.route.QueryParameterMatcher query_parameters_excluded = 4;

    • getQueryParametersExcludedCount

      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.api.v2.route.QueryParameterMatcher query_parameters_excluded = 4;

    • getQueryParametersExcludedOrBuilderList

      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.api.v2.route.QueryParameterMatcher query_parameters_excluded = 4;

    • getQueryParametersExcludedOrBuilder

      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.api.v2.route.QueryParameterMatcher query_parameters_excluded = 4;