diff --git a/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosBatchItemRequestOptions.java b/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosBatchItemRequestOptions.java index dc7d3014c2e1..56de174ce6be 100644 --- a/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosBatchItemRequestOptions.java +++ b/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosBatchItemRequestOptions.java @@ -22,6 +22,9 @@ public CosmosBatchItemRequestOptions() { /** * Gets the If-Match (ETag) associated with the operation in CosmosBatch. + * Most commonly used with replace, upsert and delete requests. + * This will be ignored if specified for create requests or for upsert requests if the item doesn't exist. + * For more details, refer to optimistic concurrency control documentation * * @return ifMatchETag the ifMatchETag associated with the request. */ @@ -31,6 +34,9 @@ public String getIfMatchETag() { /** * Sets the If-Match (ETag) associated with the operation in CosmosBatch. + * Most commonly used with replace, upsert and delete requests. + * This will be ignored if specified for create requests or for upsert requests if the item doesn't exist. + * For more details, refer to optimistic concurrency control documentation * * @param ifMatchETag the ifMatchETag associated with the request. * @return the current request options @@ -42,6 +48,11 @@ public CosmosBatchItemRequestOptions setIfMatchETag(final String ifMatchETag) { /** * Gets the If-None-Match (ETag) associated with the request in operation in CosmosBatch. + * Most commonly used to detect changes to the resource via read requests. + * When Item Etag matches the specified ifNoneMatchETag then 304 status code will be returned, otherwise existing Item will be returned with 200. + * To match any Etag use "*" + * This will be ignored if specified for write requests (ex: Create, Replace, Delete). + * For more details, refer to optimistic concurrency control documentation * * @return the ifNoneMatchETag associated with the request. */ @@ -51,6 +62,11 @@ public String getIfNoneMatchETag() { /** * Sets the If-None-Match (ETag) associated with the request in operation in CosmosBatch. + * Most commonly used to detect changes to the resource via read requests. + * When Item Etag matches the specified ifNoneMatchETag then 304 status code will be returned, otherwise existing Item will be returned with 200. + * To match any Etag use "*" + * This will be ignored if specified for write requests (ex: Create, Replace, Delete). + * For more details, refer to optimistic concurrency control documentation * * @param ifNoneMatchEtag the ifNoneMatchETag associated with the request. * @return the current request options diff --git a/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosBatchPatchItemRequestOptions.java b/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosBatchPatchItemRequestOptions.java index d7009987d7ef..a40f3ec57e9d 100644 --- a/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosBatchPatchItemRequestOptions.java +++ b/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosBatchPatchItemRequestOptions.java @@ -42,6 +42,9 @@ public CosmosBatchPatchItemRequestOptions setFilterPredicate(String filterPredic /** * Gets the If-Match (ETag) associated with the operation in CosmosBatch. + * Most commonly used with replace, upsert and delete requests. + * This will be ignored if specified for create requests or for upsert requests if the item doesn't exist. + * For more details, refer to optimistic concurrency control documentation * * @return ifMatchETag the ifMatchETag associated with the request. */ @@ -51,6 +54,9 @@ public String getIfMatchETag() { /** * Sets the If-Match (ETag) associated with the operation in CosmosBatch. + * Most commonly used with replace, upsert and delete requests. + * This will be ignored if specified for create requests or for upsert requests if the item doesn't exist. + * For more details, refer to optimistic concurrency control documentation * * @param ifMatchETag the ifMatchETag associated with the request. * @return the current request options @@ -62,6 +68,11 @@ public CosmosBatchPatchItemRequestOptions setIfMatchETag(final String ifMatchETa /** * Gets the If-None-Match (ETag) associated with the request in operation in CosmosBatch. + * Most commonly used to detect changes to the resource via read requests. + * When Item Etag matches the specified ifNoneMatchETag then 304 status code will be returned, otherwise existing Item will be returned with 200. + * To match any Etag use "*" + * This will be ignored if specified for write requests (ex: Create, Replace, Delete). + * For more details, refer to optimistic concurrency control documentation * * @return the ifNoneMatchETag associated with the request. */ @@ -71,6 +82,11 @@ public String getIfNoneMatchETag() { /** * Sets the If-None-Match (ETag) associated with the request in operation in CosmosBatch. + * Most commonly used to detect changes to the resource via read requests. + * When Item Etag matches the specified ifNoneMatchETag then 304 status code will be returned, otherwise existing Item will be returned with 200. + * To match any Etag use "*" + * This will be ignored if specified for write requests (ex: Create, Replace, Delete). + * For more details, refer to optimistic concurrency control documentation * * @param ifNoneMatchEtag the ifNoneMatchETag associated with the request. * @return the current request options diff --git a/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosBulkItemRequestOptions.java b/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosBulkItemRequestOptions.java index 7c2f108d896f..d5fcb1220734 100644 --- a/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosBulkItemRequestOptions.java +++ b/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosBulkItemRequestOptions.java @@ -23,6 +23,9 @@ public CosmosBulkItemRequestOptions() { /** * Gets the If-Match (ETag) associated with the operation in {@link CosmosItemOperation}. + * Most commonly used with replace, upsert and delete requests. + * This will be ignored if specified for create requests or for upsert requests if the item doesn't exist. + * For more details, refer to optimistic concurrency control documentation * * @return ifMatchETag the ifMatchETag associated with the request. */ @@ -32,6 +35,9 @@ public String getIfMatchETag() { /** * Sets the If-Match (ETag) associated with the operation in {@link CosmosItemOperation}. + * Most commonly used with replace, upsert and delete requests. + * This will be ignored if specified for create requests or for upsert requests if the item doesn't exist. + * For more details, refer to optimistic concurrency control documentation * * @param ifMatchETag the ifMatchETag associated with the request. * @return the current request options @@ -43,6 +49,11 @@ public CosmosBulkItemRequestOptions setIfMatchETag(final String ifMatchETag) { /** * Gets the If-None-Match (ETag) associated with the request in operation in {@link CosmosItemOperation}. + * Most commonly used to detect changes to the resource via read requests. + * When Item Etag matches the specified ifNoneMatchETag then 304 status code will be returned, otherwise existing Item will be returned with 200. + * To match any Etag use "*" + * This will be ignored if specified for write requests (ex: Create, Replace, Delete). + * For more details, refer to optimistic concurrency control documentation * * @return the ifNoneMatchETag associated with the request. */ @@ -52,6 +63,11 @@ public String getIfNoneMatchETag() { /** * Sets the If-None-Match (ETag) associated with the request in operation in {@link CosmosItemOperation}. + * Most commonly used to detect changes to the resource via read requests. + * When Item Etag matches the specified ifNoneMatchETag then 304 status code will be returned, otherwise existing Item will be returned with 200. + * To match any Etag use "*" + * This will be ignored if specified for write requests (ex: Create, Replace, Delete). + * For more details, refer to optimistic concurrency control documentation * * @param ifNoneMatchEtag the ifNoneMatchETag associated with the request. * @return the current request options. diff --git a/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosBulkPatchItemRequestOptions.java b/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosBulkPatchItemRequestOptions.java index ba4cbf4e4e8f..311a69541da2 100644 --- a/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosBulkPatchItemRequestOptions.java +++ b/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosBulkPatchItemRequestOptions.java @@ -85,6 +85,11 @@ public CosmosBulkPatchItemRequestOptions setContentResponseOnWriteEnabled(Boolea /** * Gets the If-None-Match (ETag) associated with the request in operation in {@link CosmosItemOperation}. + * Most commonly used to detect changes to the resource via read requests. + * When Item Etag matches the specified ifNoneMatchETag then 304 status code will be returned, otherwise existing Item will be returned with 200. + * To match any Etag use "*" + * This will be ignored if specified for write requests (ex: Create, Replace, Delete). + * For more details, refer to optimistic concurrency control documentation * * @return the ifNoneMatchETag associated with the request. */ @@ -94,6 +99,11 @@ public String getIfNoneMatchETag() { /** * Sets the If-None-Match (ETag) associated with the request in operation in {@link CosmosItemOperation}. + * Most commonly used to detect changes to the resource via read requests. + * When Item Etag matches the specified ifNoneMatchETag then 304 status code will be returned, otherwise existing Item will be returned with 200. + * To match any Etag use "*" + * This will be ignored if specified for write requests (ex: Create, Replace, Delete). + * For more details, refer to optimistic concurrency control documentation * * @param ifNoneMatchEtag the ifNoneMatchETag associated with the request. * @return the current request options. @@ -105,6 +115,9 @@ public CosmosBulkPatchItemRequestOptions setIfNoneMatchETag(final String ifNoneM /** * Gets the If-Match (ETag) associated with the operation in {@link CosmosItemOperation}. + * Most commonly used with replace, upsert and delete requests. + * This will be ignored if specified for create requests or for upsert requests if the item doesn't exist. + * For more details, refer to optimistic concurrency control documentation * * @return ifMatchETag the ifMatchETag associated with the request. */ @@ -114,6 +127,9 @@ public String getIfMatchETag() { /** * Sets the If-Match (ETag) associated with the operation in {@link CosmosItemOperation}. + * Most commonly used with replace, upsert and delete requests. + * This will be ignored if specified for create requests or for upsert requests if the item doesn't exist. + * For more details, refer to optimistic concurrency control documentation * * @param ifMatchETag the ifMatchETag associated with the request. * @return the current request options diff --git a/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosConflictRequestOptions.java b/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosConflictRequestOptions.java index 4ae4ad0d9de3..fd9011bed18d 100644 --- a/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosConflictRequestOptions.java +++ b/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosConflictRequestOptions.java @@ -28,6 +28,9 @@ public CosmosConflictRequestOptions(PartitionKey partitionKey) { /** * Gets the If-Match (ETag) associated with the request in the Azure Cosmos DB service. + * Most commonly used with replace and delete requests. + * This will be ignored if specified for create requests. + * For more details, refer to optimistic concurrency control documentation * * @return ifMatchETag the ifMatchETag associated with the request. */ @@ -37,6 +40,9 @@ public String getIfMatchETag() { /** * Sets the If-Match (ETag) associated with the request in the Azure Cosmos DB service. + * Most commonly used with replace and delete requests. + * This will be ignored if specified for create requests. + * For more details, refer to optimistic concurrency control documentation * * @param ifMatchETag the ifMatchETag associated with the request. * @return the current request options @@ -48,6 +54,11 @@ public CosmosConflictRequestOptions setIfMatchETag(String ifMatchETag) { /** * Gets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service. + * Most commonly used to detect changes to the resource via read requests. + * When Item Etag matches the specified ifNoneMatchETag then 304 status code will be returned, otherwise existing Item will be returned with 200. + * To match any Etag use "*" + * This will be ignored if specified for write requests (ex: Create, Replace, Delete). + * For more details, refer to optimistic concurrency control documentation * * @return the ifNoneMatchETag associated with the request. */ @@ -57,6 +68,11 @@ public String getIfNoneMatchETag() { /** * Sets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service. + * Most commonly used to detect changes to the resource via read requests. + * When Item Etag matches the specified ifNoneMatchETag then 304 status code will be returned, otherwise existing Item will be returned with 200. + * To match any Etag use "*" + * This will be ignored if specified for write requests (ex: Create, Replace, Delete). + * For more details, refer to optimistic concurrency control documentation * * @param ifNoneMatchEtag the ifNoneMatchETag associated with the request. * @return the current request options diff --git a/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosContainerRequestOptions.java b/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosContainerRequestOptions.java index 02690f8346cc..1a2cad1b85ed 100644 --- a/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosContainerRequestOptions.java +++ b/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosContainerRequestOptions.java @@ -82,6 +82,9 @@ public CosmosContainerRequestOptions setSessionToken(String sessionToken) { /** * Gets the If-Match (ETag) associated with the request in the Azure Cosmos DB service. + * Most commonly used with replace and delete requests. + * This will be ignored if specified for create requests. + * For more details, refer to optimistic concurrency control documentation * * @return the ifMatchETag associated with the request. */ @@ -91,6 +94,9 @@ public String getIfMatchETag() { /** * Sets the If-Match (ETag) associated with the request in the Azure Cosmos DB service. + * Most commonly used with replace and delete requests. + * This will be ignored if specified for create requests. + * For more details, refer to optimistic concurrency control documentation * * @param ifMatchETag the ifMatchETag associated with the request. * @return the current request options @@ -102,6 +108,11 @@ public CosmosContainerRequestOptions setIfMatchETag(String ifMatchETag) { /** * Gets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service. + * Most commonly used to detect changes to the resource via read requests. + * When Item Etag matches the specified ifNoneMatchETag then 304 status code will be returned, otherwise existing Item will be returned with 200. + * To match any Etag use "*" + * This will be ignored if specified for write requests (ex: Create, Replace, Delete). + * For more details, refer to optimistic concurrency control documentation * * @return the ifNoneMatchETag associated with the request. */ @@ -111,6 +122,11 @@ public String getIfNoneMatchETag() { /** * Sets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service. + * Most commonly used to detect changes to the resource via read requests. + * When Item Etag matches the specified ifNoneMatchETag then 304 status code will be returned, otherwise existing Item will be returned with 200. + * To match any Etag use "*" + * This will be ignored if specified for write requests (ex: Create, Replace, Delete). + * For more details, refer to optimistic concurrency control documentation * * @param ifNoneMatchETag the ifNoneMatchETag associated with the request. * @return the current request options diff --git a/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosDatabaseRequestOptions.java b/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosDatabaseRequestOptions.java index fec9bf1acfd1..a4817e14be7e 100644 --- a/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosDatabaseRequestOptions.java +++ b/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosDatabaseRequestOptions.java @@ -14,6 +14,9 @@ public final class CosmosDatabaseRequestOptions { /** * Gets the If-Match (ETag) associated with the request in the Azure Cosmos DB service. + * Most commonly used with replace and delete requests. + * This will be ignored if specified for create requests. + * For more details, refer to optimistic concurrency control documentation * * @return the ifMatchETag associated with the request. */ @@ -23,6 +26,9 @@ public String getIfMatchETag() { /** * Sets the If-Match (ETag) associated with the request in the Azure Cosmos DB service. + * Most commonly used with replace and delete requests. + * This will be ignored if specified for create requests. + * For more details, refer to optimistic concurrency control documentation * * @param ifMatchETag the ifMatchETag associated with the request. * @return the current request options @@ -34,6 +40,11 @@ public CosmosDatabaseRequestOptions setIfMatchETag(String ifMatchETag) { /** * Gets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service. + * Most commonly used to detect changes to the resource via read requests. + * When Item Etag matches the specified ifNoneMatchETag then 304 status code will be returned, otherwise existing Item will be returned with 200. + * To match any Etag use "*" + * This will be ignored if specified for write requests (ex: Create, Replace, Delete). + * For more details, refer to optimistic concurrency control documentation * * @return the ifNoneMatchETag associated with the request. */ @@ -43,6 +54,11 @@ public String getIfNoneMatchETag() { /** * Sets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service. + * Most commonly used to detect changes to the resource via read requests. + * When Item Etag matches the specified ifNoneMatchETag then 304 status code will be returned, otherwise existing Item will be returned with 200. + * To match any Etag use "*" + * This will be ignored if specified for write requests (ex: Create, Replace, Delete). + * For more details, refer to optimistic concurrency control documentation * * @param ifNoneMatchETag the ifNoneMatchETag associated with the request. * @return the current request options diff --git a/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosItemRequestOptions.java b/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosItemRequestOptions.java index b2cfd207bd0a..35a1e0376fd3 100644 --- a/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosItemRequestOptions.java +++ b/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosItemRequestOptions.java @@ -99,6 +99,9 @@ public CosmosItemRequestOptions() { /** * Gets the If-Match (ETag) associated with the request in the Azure Cosmos DB service. + * Most commonly used with replace, upsert and delete requests. + * This will be ignored if specified for create requests or for upsert requests if the item doesn't exist. + * For more details, refer to optimistic concurrency control documentation * * @return the ifMatchETag associated with the request. */ @@ -108,6 +111,9 @@ public String getIfMatchETag() { /** * Sets the If-Match (ETag) associated with the request in the Azure Cosmos DB service. + * Most commonly used with replace, upsert and delete requests. + * This will be ignored if specified for create requests or for upsert requests if the item doesn't exist. + * For more details, refer to optimistic concurrency control documentation * * @param ifMatchETag the ifMatchETag associated with the request. * @return the current request options @@ -119,6 +125,11 @@ public CosmosItemRequestOptions setIfMatchETag(String ifMatchETag) { /** * Gets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service. + * Most commonly used to detect changes to the resource via read requests. + * When Item Etag matches the specified ifNoneMatchETag then 304 status code will be returned, otherwise existing Item will be returned with 200. + * To match any Etag use "*" + * This will be ignored if specified for write requests (ex: Create, Replace, Delete). + * For more details, refer to optimistic concurrency control documentation * * @return the ifNoneMatchETag associated with the request. */ @@ -128,6 +139,11 @@ public String getIfNoneMatchETag() { /** * Sets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service. + * Most commonly used to detect changes to the resource via read requests. + * When Item Etag matches the specified ifNoneMatchETag then 304 status code will be returned, otherwise existing Item will be returned with 200. + * To match any Etag use "*" + * This will be ignored if specified for write requests (ex: Create, Replace, Delete). + * For more details, refer to optimistic concurrency control documentation * * @param ifNoneMatchETag the ifNoneMatchETag associated with the request. * @return the current request options diff --git a/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosPermissionRequestOptions.java b/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosPermissionRequestOptions.java index 5fcaede8b479..89794f611656 100644 --- a/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosPermissionRequestOptions.java +++ b/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosPermissionRequestOptions.java @@ -14,6 +14,9 @@ public final class CosmosPermissionRequestOptions { /** * Gets the If-Match (ETag) associated with the request in the Azure Cosmos DB service. + * Most commonly used with replace and delete requests. + * This will be ignored if specified for create requests. + * For more details, refer to optimistic concurrency control documentation * * @return the ifMatchETag associated with the request. */ @@ -23,6 +26,9 @@ public String getIfMatchETag() { /** * Sets the If-Match (ETag) associated with the request in the Azure Cosmos DB service. + * Most commonly used with replace and delete requests. + * This will be ignored if specified for create requests. + * For more details, refer to optimistic concurrency control documentation * * @param ifMatchETag the ifMatchETag associated with the request. * @return the current request options @@ -34,6 +40,11 @@ public CosmosPermissionRequestOptions setIfMatchETag(String ifMatchETag) { /** * Gets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service. + * Most commonly used to detect changes to the resource via read requests. + * When Item Etag matches the specified ifNoneMatchETag then 304 status code will be returned, otherwise existing Item will be returned with 200. + * To match any Etag use "*" + * This will be ignored if specified for write requests (ex: Create, Replace, Delete). + * For more details, refer to optimistic concurrency control documentation * * @return the ifNoneMatchETag associated with the request. */ @@ -43,6 +54,11 @@ public String getIfNoneMatchETag() { /** * Sets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service. + * Most commonly used to detect changes to the resource via read requests. + * When Item Etag matches the specified ifNoneMatchETag then 304 status code will be returned, otherwise existing Item will be returned with 200. + * To match any Etag use "*" + * This will be ignored if specified for write requests (ex: Create, Replace, Delete). + * For more details, refer to optimistic concurrency control documentation * * @param ifNoneMatchETag the ifNoneMatchETag associated with the request. * @return the current request options diff --git a/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosQueryRequestOptions.java b/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosQueryRequestOptions.java index 3bf082a33b43..85efe4d8bc72 100644 --- a/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosQueryRequestOptions.java +++ b/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosQueryRequestOptions.java @@ -63,7 +63,7 @@ public ConsistencyLevel getConsistencyLevel() { /** * Sets the consistency level required for the request. The effective consistency level - * can only be reduce for read/query requests. So when the Account's default consistency level + * can only be reduced for read/query requests. So when the Account's default consistency level * is for example Session you can specify on a request-by-request level for individual requests * that Eventual consistency is sufficient - which could reduce the latency and RU charges for this * request but will not guarantee session consistency (read-your-own-write) anymore diff --git a/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosStoredProcedureRequestOptions.java b/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosStoredProcedureRequestOptions.java index 23d680ebfca8..02f360299c42 100644 --- a/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosStoredProcedureRequestOptions.java +++ b/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosStoredProcedureRequestOptions.java @@ -18,6 +18,9 @@ public final class CosmosStoredProcedureRequestOptions { /** * Gets the If-Match (ETag) associated with the request in the Azure Cosmos DB service. + * Most commonly used with replace and delete requests. + * This will be ignored if specified for create requests. + * For more details, refer to optimistic concurrency control documentation * * @return the ifMatchETag associated with the request. */ @@ -27,6 +30,9 @@ public String getIfMatchETag() { /** * Sets the If-Match (ETag) associated with the request in the Azure Cosmos DB service. + * Most commonly used with replace and delete requests. + * This will be ignored if specified for create requests. + * For more details, refer to optimistic concurrency control documentation * * @param ifMatchETag the ifMatchETag associated with the request. * @return the current request options @@ -38,6 +44,11 @@ public CosmosStoredProcedureRequestOptions setIfMatchETag(String ifMatchETag) { /** * Gets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service. + * Most commonly used to detect changes to the resource via read requests. + * When Item Etag matches the specified ifNoneMatchETag then 304 status code will be returned, otherwise existing Item will be returned with 200. + * To match any Etag use "*" + * This will be ignored if specified for write requests (ex: Create, Replace, Delete). + * For more details, refer to optimistic concurrency control documentation * * @return the ifNoneMatchETag associated with the request. */ @@ -47,6 +58,11 @@ public String getIfNoneMatchETag() { /** * Sets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service. + * Most commonly used to detect changes to the resource via read requests. + * When Item Etag matches the specified ifNoneMatchETag then 304 status code will be returned, otherwise existing Item will be returned with 200. + * To match any Etag use "*" + * This will be ignored if specified for write requests (ex: Create, Replace, Delete). + * For more details, refer to optimistic concurrency control documentation * * @param ifNoneMatchETag the ifNoneMatchETag associated with the request. * @return the current request options