140 строки
13 KiB
YAML
140 строки
13 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.documentdb.ConsistencyPolicy"
|
|
fullName: "com.microsoft.azure.documentdb.ConsistencyPolicy"
|
|
name: "ConsistencyPolicy"
|
|
nameWithType: "ConsistencyPolicy"
|
|
summary: "Encapsulates the settings for consistency policy in the Azure Cosmos DB database service."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable?alt=com.microsoft.azure.documentdb.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.<T>getCollection(java.lang.String,java.lang.Class<T>)?alt=com.microsoft.azure.documentdb.JsonSerializable.<T>getCollection&text=<T>getCollection\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.<T>getObject(java.lang.String,java.lang.Class<T>)?alt=com.microsoft.azure.documentdb.JsonSerializable.<T>getObject&text=<T>getObject\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.<T>set(java.lang.String,T)?alt=com.microsoft.azure.documentdb.JsonSerializable.<T>set&text=<T>set\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.<T>toObject(java.lang.Class<T>)?alt=com.microsoft.azure.documentdb.JsonSerializable.<T>toObject&text=<T>toObject\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.get(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.get&text=get\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getBoolean(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getBoolean&text=getBoolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getCollection(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getCollection&text=getCollection\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getDouble(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getDouble&text=getDouble\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getHashMap()?alt=com.microsoft.azure.documentdb.JsonSerializable.getHashMap&text=getHashMap\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getInt(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getInt&text=getInt\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getLogger()?alt=com.microsoft.azure.documentdb.JsonSerializable.getLogger&text=getLogger\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getLong(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getLong&text=getLong\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getMapper()?alt=com.microsoft.azure.documentdb.JsonSerializable.getMapper&text=getMapper\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getObject(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getObject&text=getObject\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getObjectByPath(java.util.Collection<java.lang.String>)?alt=com.microsoft.azure.documentdb.JsonSerializable.getObjectByPath&text=getObjectByPath\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getString(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getString&text=getString\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.has(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.has&text=has\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.remove(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.remove&text=remove\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.toJson()?alt=com.microsoft.azure.documentdb.JsonSerializable.toJson&text=toJson\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.toJson(com.microsoft.azure.documentdb.SerializationFormattingPolicy)?alt=com.microsoft.azure.documentdb.JsonSerializable.toJson&text=toJson\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.toString()?alt=com.microsoft.azure.documentdb.JsonSerializable.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.toString(int)?alt=com.microsoft.azure.documentdb.JsonSerializable.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
|
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public final class **ConsistencyPolicy**</br> extends <xref href=\"com.microsoft.azure.documentdb.JsonSerializable?alt=com.microsoft.azure.documentdb.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.documentdb.ConsistencyPolicy.ConsistencyPolicy(java.lang.String)"
|
|
fullName: "com.microsoft.azure.documentdb.ConsistencyPolicy.ConsistencyPolicy(String jsonString)"
|
|
name: "ConsistencyPolicy(String jsonString)"
|
|
nameWithType: "ConsistencyPolicy.ConsistencyPolicy(String jsonString)"
|
|
summary: "Constructor."
|
|
parameters:
|
|
- description: "the json string that represents the consistency policy."
|
|
name: "jsonString"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ConsistencyPolicy(String jsonString)"
|
|
desc: "Constructor."
|
|
- uid: "com.microsoft.azure.documentdb.ConsistencyPolicy.ConsistencyPolicy(org.json.JSONObject)"
|
|
fullName: "com.microsoft.azure.documentdb.ConsistencyPolicy.ConsistencyPolicy(JSONObject jsonObject)"
|
|
name: "ConsistencyPolicy(JSONObject jsonObject)"
|
|
nameWithType: "ConsistencyPolicy.ConsistencyPolicy(JSONObject jsonObject)"
|
|
summary: "Constructor."
|
|
parameters:
|
|
- description: "the json object that represents the consistency policy."
|
|
name: "jsonObject"
|
|
type: "<xref href=\"org.json.JSONObject?alt=org.json.JSONObject&text=JSONObject\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ConsistencyPolicy(JSONObject jsonObject)"
|
|
desc: "Constructor."
|
|
methods:
|
|
- uid: "com.microsoft.azure.documentdb.ConsistencyPolicy.getDefaultConsistencyLevel()"
|
|
fullName: "com.microsoft.azure.documentdb.ConsistencyPolicy.getDefaultConsistencyLevel()"
|
|
name: "getDefaultConsistencyLevel()"
|
|
nameWithType: "ConsistencyPolicy.getDefaultConsistencyLevel()"
|
|
summary: "Get the name of the resource."
|
|
syntax: "public ConsistencyLevel getDefaultConsistencyLevel()"
|
|
desc: "Get the name of the resource."
|
|
returns:
|
|
description: "the default consistency level."
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.ConsistencyLevel?alt=com.microsoft.azure.documentdb.ConsistencyLevel&text=ConsistencyLevel\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.ConsistencyPolicy.getMaxStalenessIntervalInSeconds()"
|
|
fullName: "com.microsoft.azure.documentdb.ConsistencyPolicy.getMaxStalenessIntervalInSeconds()"
|
|
name: "getMaxStalenessIntervalInSeconds()"
|
|
nameWithType: "ConsistencyPolicy.getMaxStalenessIntervalInSeconds()"
|
|
summary: "Gets the in bounded staleness consistency, the maximum allowed staleness in terms time interval."
|
|
syntax: "public int getMaxStalenessIntervalInSeconds()"
|
|
desc: "Gets the in bounded staleness consistency, the maximum allowed staleness in terms time interval."
|
|
returns:
|
|
description: "the max staleness prefix."
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.ConsistencyPolicy.getMaxStalenessPrefix()"
|
|
fullName: "com.microsoft.azure.documentdb.ConsistencyPolicy.getMaxStalenessPrefix()"
|
|
name: "getMaxStalenessPrefix()"
|
|
nameWithType: "ConsistencyPolicy.getMaxStalenessPrefix()"
|
|
summary: "Gets the bounded staleness consistency, the maximum allowed staleness in terms difference in sequence numbers (aka version)."
|
|
syntax: "public int getMaxStalenessPrefix()"
|
|
desc: "Gets the bounded staleness consistency, the maximum allowed staleness in terms difference in sequence numbers (aka version)."
|
|
returns:
|
|
description: "the max staleness prefix."
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.ConsistencyPolicy.setDefaultConsistencyLevel(com.microsoft.azure.documentdb.ConsistencyLevel)"
|
|
fullName: "com.microsoft.azure.documentdb.ConsistencyPolicy.setDefaultConsistencyLevel(ConsistencyLevel level)"
|
|
name: "setDefaultConsistencyLevel(ConsistencyLevel level)"
|
|
nameWithType: "ConsistencyPolicy.setDefaultConsistencyLevel(ConsistencyLevel level)"
|
|
summary: "Set the name of the resource."
|
|
parameters:
|
|
- description: "the consistency level."
|
|
name: "level"
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.ConsistencyLevel?alt=com.microsoft.azure.documentdb.ConsistencyLevel&text=ConsistencyLevel\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setDefaultConsistencyLevel(ConsistencyLevel level)"
|
|
desc: "Set the name of the resource."
|
|
- uid: "com.microsoft.azure.documentdb.ConsistencyPolicy.setMaxStalenessIntervalInSeconds(int)"
|
|
fullName: "com.microsoft.azure.documentdb.ConsistencyPolicy.setMaxStalenessIntervalInSeconds(int maxStalenessIntervalInSeconds)"
|
|
name: "setMaxStalenessIntervalInSeconds(int maxStalenessIntervalInSeconds)"
|
|
nameWithType: "ConsistencyPolicy.setMaxStalenessIntervalInSeconds(int maxStalenessIntervalInSeconds)"
|
|
summary: "Sets the in bounded staleness consistency, the maximum allowed staleness in terms time interval."
|
|
parameters:
|
|
- description: "the max staleness interval in seconds."
|
|
name: "maxStalenessIntervalInSeconds"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setMaxStalenessIntervalInSeconds(int maxStalenessIntervalInSeconds)"
|
|
desc: "Sets the in bounded staleness consistency, the maximum allowed staleness in terms time interval."
|
|
- uid: "com.microsoft.azure.documentdb.ConsistencyPolicy.setMaxStalenessPrefix(int)"
|
|
fullName: "com.microsoft.azure.documentdb.ConsistencyPolicy.setMaxStalenessPrefix(int maxStalenessPrefix)"
|
|
name: "setMaxStalenessPrefix(int maxStalenessPrefix)"
|
|
nameWithType: "ConsistencyPolicy.setMaxStalenessPrefix(int maxStalenessPrefix)"
|
|
summary: "Sets the bounded staleness consistency, the maximum allowed staleness in terms difference in sequence numbers (aka version)."
|
|
parameters:
|
|
- description: "the max staleness prefix."
|
|
name: "maxStalenessPrefix"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setMaxStalenessPrefix(int maxStalenessPrefix)"
|
|
desc: "Sets the bounded staleness consistency, the maximum allowed staleness in terms difference in sequence numbers (aka version)."
|
|
type: "class"
|
|
desc: "Encapsulates the settings for consistency policy in the Azure Cosmos DB database service."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.documentdb"
|
|
artifact: com.microsoft.azure:azure-documentdb:2.4.7
|