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

Class CacheConfig.KeyCreatorParams.Builder

    • Method Detail

      • 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<CacheConfig.KeyCreatorParams.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<CacheConfig.KeyCreatorParams.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • isInitialized

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

      • mergeFrom

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

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

      • setExcludeScheme

        public CacheConfig.KeyCreatorParams.Builder setExcludeScheme​(boolean value)
         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;
        Parameters:
        value - The excludeScheme to set.
        Returns:
        This builder for chaining.

      • clearExcludeScheme

        public CacheConfig.KeyCreatorParams.Builder clearExcludeScheme()
         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:
        This builder for chaining.

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

      • setExcludeHost

        public CacheConfig.KeyCreatorParams.Builder setExcludeHost​(boolean value)
         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;
        Parameters:
        value - The excludeHost to set.
        Returns:
        This builder for chaining.

      • clearExcludeHost

        public CacheConfig.KeyCreatorParams.Builder clearExcludeHost()
         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:
        This builder for chaining.

      • 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

      • 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

      • setQueryParametersIncluded

        public CacheConfig.KeyCreatorParams.Builder setQueryParametersIncluded​(int index,
                                                                       QueryParameterMatcher value)
         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;

      • setQueryParametersIncluded

        public CacheConfig.KeyCreatorParams.Builder setQueryParametersIncluded​(int index,
                                                                       QueryParameterMatcher.Builder builderForValue)
         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;

      • addQueryParametersIncluded

        public CacheConfig.KeyCreatorParams.Builder addQueryParametersIncluded​(QueryParameterMatcher value)
         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;

      • addQueryParametersIncluded

        public CacheConfig.KeyCreatorParams.Builder addQueryParametersIncluded​(int index,
                                                                       QueryParameterMatcher value)
         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;

      • addQueryParametersIncluded

        public CacheConfig.KeyCreatorParams.Builder addQueryParametersIncluded​(QueryParameterMatcher.Builder builderForValue)
         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;

      • addQueryParametersIncluded

        public CacheConfig.KeyCreatorParams.Builder addQueryParametersIncluded​(int index,
                                                                       QueryParameterMatcher.Builder builderForValue)
         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;

      • addAllQueryParametersIncluded

        public CacheConfig.KeyCreatorParams.Builder addAllQueryParametersIncluded​(Iterable<? extends QueryParameterMatcher> values)
         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;

      • clearQueryParametersIncluded

        public CacheConfig.KeyCreatorParams.Builder clearQueryParametersIncluded()
         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;

      • removeQueryParametersIncluded

        public CacheConfig.KeyCreatorParams.Builder removeQueryParametersIncluded​(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;

      • getQueryParametersIncludedBuilder

        public QueryParameterMatcher.Builder getQueryParametersIncludedBuilder​(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;

      • addQueryParametersIncludedBuilder

        public QueryParameterMatcher.Builder addQueryParametersIncludedBuilder()
         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;

      • addQueryParametersIncludedBuilder

        public QueryParameterMatcher.Builder addQueryParametersIncludedBuilder​(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;

      • getQueryParametersIncludedBuilderList

        public List<QueryParameterMatcher.Builder> getQueryParametersIncludedBuilderList()
         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;

      • 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

      • 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

      • setQueryParametersExcluded

        public CacheConfig.KeyCreatorParams.Builder setQueryParametersExcluded​(int index,
                                                                       QueryParameterMatcher value)
         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;

      • setQueryParametersExcluded

        public CacheConfig.KeyCreatorParams.Builder setQueryParametersExcluded​(int index,
                                                                       QueryParameterMatcher.Builder builderForValue)
         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;

      • addQueryParametersExcluded

        public CacheConfig.KeyCreatorParams.Builder addQueryParametersExcluded​(QueryParameterMatcher value)
         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;

      • addQueryParametersExcluded

        public CacheConfig.KeyCreatorParams.Builder addQueryParametersExcluded​(int index,
                                                                       QueryParameterMatcher value)
         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;

      • addQueryParametersExcluded

        public CacheConfig.KeyCreatorParams.Builder addQueryParametersExcluded​(QueryParameterMatcher.Builder builderForValue)
         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;

      • addQueryParametersExcluded

        public CacheConfig.KeyCreatorParams.Builder addQueryParametersExcluded​(int index,
                                                                       QueryParameterMatcher.Builder builderForValue)
         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;

      • addAllQueryParametersExcluded

        public CacheConfig.KeyCreatorParams.Builder addAllQueryParametersExcluded​(Iterable<? extends QueryParameterMatcher> values)
         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;

      • clearQueryParametersExcluded

        public CacheConfig.KeyCreatorParams.Builder clearQueryParametersExcluded()
         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;

      • removeQueryParametersExcluded

        public CacheConfig.KeyCreatorParams.Builder removeQueryParametersExcluded​(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;

      • getQueryParametersExcludedBuilder

        public QueryParameterMatcher.Builder getQueryParametersExcludedBuilder​(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;

      • 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

      • 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

      • addQueryParametersExcludedBuilder

        public QueryParameterMatcher.Builder addQueryParametersExcludedBuilder()
         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;

      • addQueryParametersExcludedBuilder

        public QueryParameterMatcher.Builder addQueryParametersExcludedBuilder​(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;

      • getQueryParametersExcludedBuilderList

        public List<QueryParameterMatcher.Builder> getQueryParametersExcludedBuilderList()
         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;