Package com.oracle.bmc.waas.model

Class CachingRuleSummary

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.waas.model.CachingRuleSummary

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20181116")
public final class CachingRuleSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

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 CachingRuleSummary.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CachingRuleSummary.Action	The action to take when the criteria of a caching rule are met.
static class	CachingRuleSummary.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
CachingRuleSummary(String key, String name, CachingRuleSummary.Action action, String cachingDuration, Boolean isClientCachingEnabled, String clientCachingDuration, List<CachingRuleCriteria> criteria)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static CachingRuleSummary.Builder	builder()	Create a new builder.
boolean	equals(Object o)
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()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CachingRuleSummary

@Deprecated
@ConstructorProperties({"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)

Deprecated.

Method Detail

builder

public static CachingRuleSummary.Builder builder()

Create a new builder.

toBuilder

public CachingRuleSummary.Builder toBuilder()

getKey

public String getKey()

The unique key for the caching rule.

Returns:

the value

getName

public String getName()

The name of the caching rule.

Returns:

the value

getAction

public CachingRuleSummary.Action getAction()

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.

Returns:

the value

getCachingDuration

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

Returns:

the value

getIsClientCachingEnabled

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.

Returns:

the value

getClientCachingDuration

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

Returns:

the value

getCriteria

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.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel