Class AfdRouteCacheConfiguration


  • public final class AfdRouteCacheConfiguration
    extends Object
    Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.
    • Constructor Detail

      • AfdRouteCacheConfiguration

        public AfdRouteCacheConfiguration()
    • Method Detail

      • queryStringCachingBehavior

        public AfdQueryStringCachingBehavior queryStringCachingBehavior()
        Get the queryStringCachingBehavior property: Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.
        Returns:
        the queryStringCachingBehavior value.
      • withQueryStringCachingBehavior

        public AfdRouteCacheConfiguration withQueryStringCachingBehavior​(AfdQueryStringCachingBehavior queryStringCachingBehavior)
        Set the queryStringCachingBehavior property: Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.
        Parameters:
        queryStringCachingBehavior - the queryStringCachingBehavior value to set.
        Returns:
        the AfdRouteCacheConfiguration object itself.
      • queryParameters

        public String queryParameters()
        Get the queryParameters property: query parameters to include or exclude (comma separated).
        Returns:
        the queryParameters value.
      • withQueryParameters

        public AfdRouteCacheConfiguration withQueryParameters​(String queryParameters)
        Set the queryParameters property: query parameters to include or exclude (comma separated).
        Parameters:
        queryParameters - the queryParameters value to set.
        Returns:
        the AfdRouteCacheConfiguration object itself.
      • compressionSettings

        public Object compressionSettings()
        Get the compressionSettings property: compression settings.
        Returns:
        the compressionSettings value.
      • withCompressionSettings

        public AfdRouteCacheConfiguration withCompressionSettings​(Object compressionSettings)
        Set the compressionSettings property: compression settings.
        Parameters:
        compressionSettings - the compressionSettings value to set.
        Returns:
        the AfdRouteCacheConfiguration object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.