SimpleLookupPolicy¶

class oci.apigateway.models.SimpleLookupPolicy(**kwargs)¶

Bases: oci.apigateway.models.response_cache_lookup_policy.ResponseCacheLookupPolicy

Provides ability to vary the cache key using context expressions.

Attributes

`TYPE_SIMPLE_LOOKUP_POLICY`	str(object=’’) -> str
`cache_key_additions`	Gets the cache_key_additions of this SimpleLookupPolicy.
`is_enabled`	Gets the is_enabled of this ResponseCacheLookupPolicy.
`is_private_caching_enabled`	Gets the is_private_caching_enabled of this ResponseCacheLookupPolicy.
`type`	[Required] Gets the type of this ResponseCacheLookupPolicy.

Methods

`__init__`(**kwargs)	Initializes a new SimpleLookupPolicy object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

TYPE_SIMPLE_LOOKUP_POLICY = 'SIMPLE_LOOKUP_POLICY'¶

__init__(**kwargs)¶

Initializes a new SimpleLookupPolicy object with values from keyword arguments. The default value of the type attribute of this class is SIMPLE_LOOKUP_POLICY and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

type (str) – The value to assign to the type property of this SimpleLookupPolicy. Allowed values for this property are: “SIMPLE_LOOKUP_POLICY”
is_enabled (bool) – The value to assign to the is_enabled property of this SimpleLookupPolicy.
is_private_caching_enabled (bool) – The value to assign to the is_private_caching_enabled property of this SimpleLookupPolicy.
cache_key_additions (list[str]) – The value to assign to the cache_key_additions property of this SimpleLookupPolicy.

cache_key_additions¶

Gets the cache_key_additions of this SimpleLookupPolicy. A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available.

Returns:	The cache_key_additions of this SimpleLookupPolicy.
Return type:	list[str]

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

is_enabled¶

Gets the is_enabled of this ResponseCacheLookupPolicy. Whether this policy is currently enabled.

Returns:	The is_enabled of this ResponseCacheLookupPolicy.
Return type:	bool

is_private_caching_enabled¶

Gets the is_private_caching_enabled of this ResponseCacheLookupPolicy. Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your cache key additions to get the level of isolation across authenticated requests that you require.

When false, any request with an Authorization header will not be stored in the Response Cache.

If using the CustomAuthenticationPolicy then the tokenHeader/tokenQueryParam are also subject to this check.

Returns:	The is_private_caching_enabled of this ResponseCacheLookupPolicy.
Return type:	bool

type¶

[Required] Gets the type of this ResponseCacheLookupPolicy. Type of the Response Cache Store Policy.

Allowed values for this property are: “SIMPLE_LOOKUP_POLICY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The type of this ResponseCacheLookupPolicy.
Return type:	str