CachingRuleSummary

class oci.waas.models.CachingRuleSummary(**kwargs)

Bases: object

The caching rule settings.

Attributes

ACTION_BYPASS_CACHE A constant which can be used with the action property of a CachingRuleSummary.
ACTION_CACHE A constant which can be used with the action property of a CachingRuleSummary.
action [Required] Gets the action of this CachingRuleSummary.
caching_duration Gets the caching_duration of this CachingRuleSummary.
client_caching_duration Gets the client_caching_duration of this CachingRuleSummary.
criteria [Required] Gets the criteria of this CachingRuleSummary.
is_client_caching_enabled Gets the is_client_caching_enabled of this CachingRuleSummary.
key Gets the key of this CachingRuleSummary.
name [Required] Gets the name of this CachingRuleSummary.

Methods

__init__(**kwargs) Initializes a new CachingRuleSummary object with values from keyword arguments.
ACTION_BYPASS_CACHE = 'BYPASS_CACHE'

A constant which can be used with the action property of a CachingRuleSummary. This constant has a value of “BYPASS_CACHE”

ACTION_CACHE = 'CACHE'

A constant which can be used with the action property of a CachingRuleSummary. This constant has a value of “CACHE”

__init__(**kwargs)

Initializes a new CachingRuleSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • key (str) – The value to assign to the key property of this CachingRuleSummary.
  • name (str) – The value to assign to the name property of this CachingRuleSummary.
  • action (str) – The value to assign to the action property of this CachingRuleSummary. Allowed values for this property are: “CACHE”, “BYPASS_CACHE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • caching_duration (str) – The value to assign to the caching_duration property of this CachingRuleSummary.
  • is_client_caching_enabled (bool) – The value to assign to the is_client_caching_enabled property of this CachingRuleSummary.
  • client_caching_duration (str) – The value to assign to the client_caching_duration property of this CachingRuleSummary.
  • criteria (list[CachingRuleCriteria]) – The value to assign to the criteria property of this CachingRuleSummary.
action

[Required] Gets the action of this CachingRuleSummary. The action to take when the criteria of a caching rule are met. - CACHE: Caches requested content when the criteria of the rule are met.

  • BYPASS_CACHE: Allows requests to bypass the cache and be directed to the origin when the criteria of the rule is met.

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

Returns:The action of this CachingRuleSummary.
Return type:str
caching_duration

Gets the caching_duration of this CachingRuleSummary. The duration to cache content for the caching rule, specified in ISO 8601 extended format. Supported units: seconds, minutes, hours, days, weeks, months. The maximum value that can be set for any unit is 99. Mixing of multiple units is not supported. Only applies when the action is set to CACHE. Example: PT1H

Returns:The caching_duration of this CachingRuleSummary.
Return type:str
client_caching_duration

Gets the client_caching_duration of this CachingRuleSummary. The duration to cache content in the user’s browser, specified in ISO 8601 extended format. Supported units: seconds, minutes, hours, days, weeks, months. The maximum value that can be set for any unit is 99. Mixing of multiple units is not supported. Only applies when the action is set to CACHE. Example: PT1H

Returns:The client_caching_duration of this CachingRuleSummary.
Return type:str
criteria

[Required] Gets the criteria of this CachingRuleSummary. The array of the rule criteria with condition and value. The caching rule would be applied for the requests that matched any of the listed conditions.

Returns:The criteria of this CachingRuleSummary.
Return type:list[CachingRuleCriteria]
is_client_caching_enabled

Gets the is_client_caching_enabled of this CachingRuleSummary. Enables or disables client caching. Browsers use the Cache-Control header value for caching content locally in the browser. This setting overrides the addition of a Cache-Control header in responses.

Returns:The is_client_caching_enabled of this CachingRuleSummary.
Return type:bool
key

Gets the key of this CachingRuleSummary. The unique key for the caching rule.

Returns:The key of this CachingRuleSummary.
Return type:str
name

[Required] Gets the name of this CachingRuleSummary. The name of the caching rule.

Returns:The name of this CachingRuleSummary.
Return type:str