com.microsoft.azure.cosmosdb

Class ConsistencyPolicy

java.lang.Object

com.microsoft.azure.cosmosdb.JsonSerializable

com.microsoft.azure.cosmosdb.ConsistencyPolicy

All Implemented Interfaces:

Serializable

public final class ConsistencyPolicy
extends JsonSerializable

Encapsulates the settings for consistency policy in the Azure Cosmos DB database service.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConsistencyPolicy(org.json.JSONObject jsonObject) Constructor.
ConsistencyPolicy(String jsonString) Constructor.

Method Summary

Modifier and Type	Method and Description
ConsistencyLevel	getDefaultConsistencyLevel() Get the name of the resource.
int	getMaxStalenessIntervalInSeconds() Gets the in bounded staleness consistency, the maximum allowed staleness in terms time interval.
int	getMaxStalenessPrefix() Gets the bounded staleness consistency, the maximum allowed staleness in terms difference in sequence numbers (aka version).
void	setDefaultConsistencyLevel(ConsistencyLevel level) Set the name of the resource.
void	setMaxStalenessIntervalInSeconds(int maxStalenessIntervalInSeconds) Sets the in bounded staleness consistency, the maximum allowed staleness in terms time interval.
void	setMaxStalenessPrefix(int maxStalenessPrefix) Sets the bounded staleness consistency, the maximum allowed staleness in terms difference in sequence numbers (aka version).

Methods inherited from class com.microsoft.azure.cosmosdb.JsonSerializable

get, getBoolean, getCollection, getCollection, getDouble, getHashMap, getInt, getLogger, getLong, getMapper, getObject, getObject, getObjectByPath, getString, has, remove, set, toJson, toJson, toObject, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ConsistencyPolicy

public ConsistencyPolicy(String jsonString)

Constructor.

Parameters:

jsonString - the json string that represents the consistency policy.

ConsistencyPolicy

public ConsistencyPolicy(org.json.JSONObject jsonObject)

Constructor.

Parameters:

jsonObject - the json object that represents the consistency policy.

Method Detail

getDefaultConsistencyLevel

public ConsistencyLevel getDefaultConsistencyLevel()

Get the name of the resource.

Returns:

the default consistency level.

setDefaultConsistencyLevel

public void setDefaultConsistencyLevel(ConsistencyLevel level)

Set the name of the resource.

Parameters:

level - the consistency level.

getMaxStalenessPrefix

public int getMaxStalenessPrefix()

Gets the bounded staleness consistency, the maximum allowed staleness in terms difference in sequence numbers (aka version).

Returns:

the max staleness prefix.

setMaxStalenessPrefix

public void setMaxStalenessPrefix(int maxStalenessPrefix)

Sets the bounded staleness consistency, the maximum allowed staleness in terms difference in sequence numbers (aka version).

Parameters:

maxStalenessPrefix - the max staleness prefix.

getMaxStalenessIntervalInSeconds

public int getMaxStalenessIntervalInSeconds()

Gets the in bounded staleness consistency, the maximum allowed staleness in terms time interval.

Returns:

the max staleness prefix.

setMaxStalenessIntervalInSeconds

public void setMaxStalenessIntervalInSeconds(int maxStalenessIntervalInSeconds)

Sets the in bounded staleness consistency, the maximum allowed staleness in terms time interval.

Parameters:

maxStalenessIntervalInSeconds - the max staleness interval in seconds.