ConsistencyPolicy Class

Package:

com.microsoft.azure.cosmosdb

• java.lang.Object
• • JsonSerializable
  • • com.microsoft.azure.cosmosdb.ConsistencyPolicy

public class ConsistencyPolicy extends JsonSerializable

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

Constructor Summary

Constructor	Description
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).

Inherited Members

JsonSerializable.get(String propertyName) JsonSerializable.getBoolean(String propertyName) JsonSerializable.getCollection(String propertyName) JsonSerializable.getDouble(String propertyName) JsonSerializable.getHashMap() JsonSerializable.getInt(String propertyName) JsonSerializable.getLogger() JsonSerializable.getLong(String propertyName) JsonSerializable.getMapper() JsonSerializable.getObject(String propertyName) JsonSerializable.getObjectByPath(List<String> propertyNames) JsonSerializable.getString(String propertyName) JsonSerializable.has(String propertyName) JsonSerializable.JsonSerializable() JsonSerializable.JsonSerializable(String jsonString, ObjectMapper objectMapper) JsonSerializable.JsonSerializable(String jsonString) JsonSerializable.remove(String propertyName) JsonSerializable.toJson() JsonSerializable.toJson(SerializationFormattingPolicy formattingPolicy) JsonSerializable.toString()

Constructor Details

ConsistencyPolicy

public ConsistencyPolicy(String jsonString)

Constructor.

Parameters:

jsonString - the json string that represents the consistency policy.

Method Details

getDefaultConsistencyLevel

public ConsistencyLevel getDefaultConsistencyLevel()

Get the name of the resource.

Returns:

the default consistency level.

getMaxStalenessIntervalInSeconds

public int getMaxStalenessIntervalInSeconds()

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

Returns:

the max staleness prefix.

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.

setDefaultConsistencyLevel

public void setDefaultConsistencyLevel(ConsistencyLevel level)

Set the name of the resource.

Parameters:

level - the consistency level.

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.

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.