CosmosConflictRequestOptions Class

Package:

com.azure.cosmos.models

Maven Artifact:

com.azure:azure-cosmos:4.79.1

• java.lang.Object
• • com.azure.cosmos.models.CosmosConflictRequestOptions

public final class CosmosConflictRequestOptions

The type Cosmos conflict request options.

Constructor Summary

Constructor	Description
CosmosConflictRequestOptions()	Creates a new CosmosConflictRequestOptions object.
CosmosConflictRequestOptions(PartitionKey partitionKey)	Creates a new CosmosConflictRequestOptions object.

Method Summary

Modifier and Type	Method and Description
String	getIfMatchETag() Gets the If-Match (ETag) associated with the request in the Azure Cosmos DB service.
String	getIfNoneMatchETag() Gets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service.
PartitionKey	getPartitionKey() Gets the partition key associated with the request in the Azure Cosmos DB service.
CosmosConflictRequestOptions	setIfMatchETag(String ifMatchETag) Sets the If-Match (ETag) associated with the request in the Azure Cosmos DB service.
CosmosConflictRequestOptions	setIfNoneMatchETag(String ifNoneMatchEtag) Sets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service.
CosmosConflictRequestOptions	setPartitionKey(PartitionKey partitionKey) Sets the partition key associated with the request in the Azure Cosmos DB service.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CosmosConflictRequestOptions

public CosmosConflictRequestOptions()

Creates a new CosmosConflictRequestOptions object.

CosmosConflictRequestOptions

public CosmosConflictRequestOptions(PartitionKey partitionKey)

Creates a new CosmosConflictRequestOptions object.

Parameters:

partitionKey - the partitionKey associated with the request.

Method Details

getIfMatchETag

public String getIfMatchETag()

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

Returns:

ifMatchETag the ifMatchETag associated with the request.

getIfNoneMatchETag

public String getIfNoneMatchETag()

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

Returns:

the ifNoneMatchETag associated with the request.

getPartitionKey

public PartitionKey getPartitionKey()

Gets the partition key associated with the request in the Azure Cosmos DB service.

Returns:

the partitionKey associated with the request.

setIfMatchETag

public CosmosConflictRequestOptions setIfMatchETag(String ifMatchETag)

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

Parameters:

ifMatchETag - the ifMatchETag associated with the request.

Returns:

the current request options

setIfNoneMatchETag

public CosmosConflictRequestOptions setIfNoneMatchETag(String ifNoneMatchEtag)

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

Parameters:

ifNoneMatchEtag - the ifNoneMatchETag associated with the request.

Returns:

the current request options

setPartitionKey

public CosmosConflictRequestOptions setPartitionKey(PartitionKey partitionKey)

Sets the partition key associated with the request in the Azure Cosmos DB service.

Parameters:

partitionKey - the partition key associated with the request.

Returns:

the CosmosItemRequestOptions.