Remove Cache

When to use

Use this policy when you want to force the removal of value in cache. When used the cache lookup is done and data from the cache is removed. 

Details

This policy forces the cache removal and disregards the cache time to live value. This is useful when the data in the cache is known to be stale and there is still some time for the cached data to expire. Any next request will then be sent to backend API and the data will be added to cache from backend API call.

Without this policy, the cache is removed only after the cache expiry happens.

Configuration

The configuration fields for the policy are:

[* Indicates a mandatory field]

Name *: Display name of the policy

Description: Description of policy

Enabled: Flag to indicate if the policy is enabled. If this field is not checked, the policy will be ignored at runtime and any fields from its output will contain a default initial value

Continue on Error: Flag to indicate that the flow should continue even if this policy throws an error

TTL in seconds: Cache Time to live specifies how long after cache is valid after added. If present, this overrides Expiry date and expiry time. The cache will be removed after this time is elapsed and for any next request, the cache data will be re-populated with the response from the backend API call

Input fields

cacheKey: Key based on which cache lookup is done

Output fields

status: returns boolean true if the data is removed from cache, otherwise returns false