@Generated(value="OracleSDKGenerator", comments="API Version: 20181116") public final class CachingRuleSummary extends Object
The caching rule settings.
Note: Objects should always be created or deserialized using the CachingRuleSummary.Builder
. This model distinguishes fields
that are null
because they are unset from fields that are explicitly set to null
. This is done in
the setter methods of the CachingRuleSummary.Builder
, which maintain a set of all explicitly set fields called
__explicitlySet__
. The hashCode()
and equals(Object)
methods are implemented to take
__explicitlySet__
into account. The constructor, on the other hand, does not set __explicitlySet__
(since the constructor cannot distinguish explicit null
from unset null
).
Modifier and Type | Class and Description |
---|---|
static class |
CachingRuleSummary.Action
The action to take when the criteria of a caching rule are met.
|
static class |
CachingRuleSummary.Builder |
Constructor and Description |
---|
CachingRuleSummary(String key,
String name,
CachingRuleSummary.Action action,
String cachingDuration,
Boolean isClientCachingEnabled,
String clientCachingDuration,
List<CachingRuleCriteria> criteria)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static CachingRuleSummary.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
CachingRuleSummary.Action |
getAction()
The action to take when the criteria of a caching rule are met.
|
String |
getCachingDuration()
The duration to cache content for the caching rule, specified in ISO 8601 extended format.
|
String |
getClientCachingDuration()
The duration to cache content in the user’s browser, specified in ISO 8601 extended format.
|
List<CachingRuleCriteria> |
getCriteria()
The array of the rule criteria with condition and value.
|
Boolean |
getIsClientCachingEnabled()
Enables or disables client caching.
|
String |
getKey()
The unique key for the caching rule.
|
String |
getName()
The name of the caching rule.
|
int |
hashCode() |
CachingRuleSummary.Builder |
toBuilder() |
String |
toString() |
@Deprecated @ConstructorProperties(value={"key","name","action","cachingDuration","isClientCachingEnabled","clientCachingDuration","criteria"}) public CachingRuleSummary(String key, String name, CachingRuleSummary.Action action, String cachingDuration, Boolean isClientCachingEnabled, String clientCachingDuration, List<CachingRuleCriteria> criteria)
public static CachingRuleSummary.Builder builder()
Create a new builder.
public CachingRuleSummary.Builder toBuilder()
public String getKey()
The unique key for the caching rule.
public String getName()
The name of the caching rule.
public CachingRuleSummary.Action getAction()
The action to take when the criteria of a caching 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.
public String getCachingDuration()
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
public Boolean getIsClientCachingEnabled()
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.
public String getClientCachingDuration()
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
public List<CachingRuleCriteria> getCriteria()
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.
Copyright © 2016–2022. All rights reserved.