com.azure.cosmos.ConsistencyLevel Maven / Gradle / Ivy
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
package com.azure.cosmos;
/**
* Represents the consistency levels supported for Cosmos DB client operations in the Azure Cosmos DB database service.
*
* The requested ConsistencyLevel must match or be weaker than that provisioned for the database account. Consistency
* levels by order of strength are STRONG, BOUNDED_STALENESS, SESSION and EVENTUAL.
*/
public enum ConsistencyLevel {
/**
* STRONG Consistency guarantees that read operations always return the value that was last written.
*/
STRONG ("Strong"),
/**
* Bounded Staleness guarantees that reads are not too out-of-date. This can be configured based on number of
* operations (MaxStalenessPrefix) or time (MaxStalenessIntervalInSeconds)
*/
BOUNDED_STALENESS("BoundedStaleness"),
/**
* SESSION Consistency guarantees monotonic reads (you never read old data, then new, then old again), monotonic
* writes (writes are ordered) and read your writes (your writes are immediately visible to your reads) within
* any single session.
*/
SESSION("Session"),
/**
* EVENTUAL Consistency guarantees that reads will return a subset of writes. ALL writes will be eventually be
* available for reads.
*/
EVENTUAL("Eventual"),
/**
* CONSISTENT_PREFIX Consistency guarantees that reads will return some prefix of all writes with no gaps. ALL
* writes
* will be eventually be available for reads.
*/
CONSISTENT_PREFIX ("ConsistentPrefix");
ConsistencyLevel(String overWireValue) {
this.overWireValue = overWireValue;
}
private final String overWireValue;
@Override
public String toString() {
return this.overWireValue;
}
}