86 строки
7.9 KiB
YAML
86 строки
7.9 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.cosmos.NonIdempotentWriteRetryOptions"
|
|
fullName: "com.azure.cosmos.NonIdempotentWriteRetryOptions"
|
|
name: "NonIdempotentWriteRetryOptions"
|
|
nameWithType: "NonIdempotentWriteRetryOptions"
|
|
summary: "Class to define the options for non-idempotent write operations"
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **NonIdempotentWriteRetryOptions**"
|
|
constructors:
|
|
- uid: "com.azure.cosmos.NonIdempotentWriteRetryOptions.NonIdempotentWriteRetryOptions()"
|
|
fullName: "com.azure.cosmos.NonIdempotentWriteRetryOptions.NonIdempotentWriteRetryOptions()"
|
|
name: "NonIdempotentWriteRetryOptions()"
|
|
nameWithType: "NonIdempotentWriteRetryOptions.NonIdempotentWriteRetryOptions()"
|
|
summary: "Creates an instance of the Non<wbr>Idempotent<wbr>Write<wbr>Retry<wbr>Options class."
|
|
syntax: "public NonIdempotentWriteRetryOptions()"
|
|
desc: "Creates an instance of the NonIdempotentWriteRetryOptions class."
|
|
methods:
|
|
- uid: "com.azure.cosmos.NonIdempotentWriteRetryOptions.isEnabled()"
|
|
fullName: "com.azure.cosmos.NonIdempotentWriteRetryOptions.isEnabled()"
|
|
name: "isEnabled()"
|
|
nameWithType: "NonIdempotentWriteRetryOptions.isEnabled()"
|
|
summary: "Returns a flag indicating whether automatic retries for write operations even when they are not guaranteed to be idempotent are enabled or not."
|
|
syntax: "public boolean isEnabled()"
|
|
desc: "Returns a flag indicating whether automatic retries for write operations even when they are not guaranteed to be idempotent are enabled or not. The default value is false."
|
|
returns:
|
|
description: "a flag indicating whether automatic retries for non-idempotent write operations are enabled or not."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.NonIdempotentWriteRetryOptions.isTrackingIdUsed()"
|
|
fullName: "com.azure.cosmos.NonIdempotentWriteRetryOptions.isTrackingIdUsed()"
|
|
name: "isTrackingIdUsed()"
|
|
nameWithType: "NonIdempotentWriteRetryOptions.isTrackingIdUsed()"
|
|
summary: "Returns a flag indicating whether write operations can use the tracking<wbr>Id system property '/\\_tracking<wbr>Id' to allow identification of conflicts and pre-condition failures due to retries."
|
|
syntax: "public boolean isTrackingIdUsed()"
|
|
desc: "Returns a flag indicating whether write operations can use the trackingId system property '/\\_trackingId' to allow identification of conflicts and pre-condition failures due to retries. If enabled, each document being created or replaced will have an additional '/\\_trackingId' property for which the value will be updated by the SDK. If it is not desired to add this new json property (for example due to the RU-increase based on the payload size or because it causes documents to exceed the max payload size upper limit), the usage of this system property can be disabled by setting this parameter to false. This means there could be a higher level of 409/312 due to retries - and applications would need to handle them gracefully on their own."
|
|
returns:
|
|
description: "a flag indicating whether write operations can use the\n trackingId system property '/_trackingId' to allow identification of conflicts and pre-condition failures due\n to retries."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.NonIdempotentWriteRetryOptions.setEnabled(boolean)"
|
|
fullName: "com.azure.cosmos.NonIdempotentWriteRetryOptions.setEnabled(boolean isEnabled)"
|
|
name: "setEnabled(boolean isEnabled)"
|
|
nameWithType: "NonIdempotentWriteRetryOptions.setEnabled(boolean isEnabled)"
|
|
summary: "Specifies whether automatic retries for write operations even when they are not guaranteed to be idempotent are enabled."
|
|
parameters:
|
|
- description: "- a flag indicating whether to enable automatic retries even for non-idempotent write operations"
|
|
name: "isEnabled"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public NonIdempotentWriteRetryOptions setEnabled(boolean isEnabled)"
|
|
desc: "Specifies whether automatic retries for write operations even when they are not guaranteed to be idempotent are enabled."
|
|
returns:
|
|
description: "current options"
|
|
type: "<xref href=\"com.azure.cosmos.NonIdempotentWriteRetryOptions?alt=com.azure.cosmos.NonIdempotentWriteRetryOptions&text=NonIdempotentWriteRetryOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.NonIdempotentWriteRetryOptions.setTrackingIdUsed(boolean)"
|
|
fullName: "com.azure.cosmos.NonIdempotentWriteRetryOptions.setTrackingIdUsed(boolean useTrackingIdForCreateAndReplace)"
|
|
name: "setTrackingIdUsed(boolean useTrackingIdForCreateAndReplace)"
|
|
nameWithType: "NonIdempotentWriteRetryOptions.setTrackingIdUsed(boolean useTrackingIdForCreateAndReplace)"
|
|
summary: "Specifies whether write operations can use the tracking<wbr>Id system property '/\\_tracking<wbr>Id' to allow identification of conflicts and pre-condition failures due to retries."
|
|
parameters:
|
|
- description: "indicates whether a system property '/_trackingId' should be used to\n allow identification of conflicts and pre-condition failures due to retries."
|
|
name: "useTrackingIdForCreateAndReplace"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public NonIdempotentWriteRetryOptions setTrackingIdUsed(boolean useTrackingIdForCreateAndReplace)"
|
|
desc: "Specifies whether write operations can use the trackingId system property '/\\_trackingId' to allow identification of conflicts and pre-condition failures due to retries. If enabled, each document being created or replaced will have an additional '/\\_trackingId' property for which the value will be updated by the SDK. If it is not desired to add this new json property (for example due to the RU-increase based on the payload size or because it causes documents to exceed the max payload size upper limit), the usage of this system property can be disabled by setting this parameter to false. This means there could be a higher level of 409/312 due to retries - and applications would need to handle them gracefully on their own."
|
|
returns:
|
|
description: "current options"
|
|
type: "<xref href=\"com.azure.cosmos.NonIdempotentWriteRetryOptions?alt=com.azure.cosmos.NonIdempotentWriteRetryOptions&text=NonIdempotentWriteRetryOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Class to define the options for non-idempotent write operations"
|
|
metadata: {}
|
|
package: "com.azure.cosmos"
|
|
artifact: com.azure:azure-cosmos:4.63.4
|