DocumentClient.ReadConflictAsync Method

Definition

Overloads

ReadConflictAsync(String, RequestOptions)

Reads a Conflict from the Azure Cosmos DB service as an asynchronous operation.

ReadConflictAsync(Uri, RequestOptions)

Reads a Conflict as an asynchronous operation from the Azure Cosmos DB service.

ReadConflictAsync(String, RequestOptions)

Reads a Conflict from the Azure Cosmos DB service as an asynchronous operation.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Conflict>> ReadConflictAsync (string conflictLink, Microsoft.Azure.Documents.Client.RequestOptions options = null);
abstract member ReadConflictAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Conflict>>
override this.ReadConflictAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Conflict>>
Public Function ReadConflictAsync (conflictLink As String, Optional options As RequestOptions = null) As Task(Of ResourceResponse(Of Conflict))

Parameters

conflictLink
String

The link to the Conflict to be read.

options
RequestOptions

(Optional) The request options for the request.

Returns

A System.Threading.Tasks containing a ResourceResponse<TResource> which wraps a Conflict containing the read resource record.

Implements

Exceptions

If conflictLink is not set.

This exception can encapsulate many different types of errors. To determine the specific error always look at the StatusCode property. Some common codes you may get when creating a Document are:

StatusCodeReason for exception
404NotFound - This means the resource you tried to read did not exist.
429TooManyRequests - This means you have exceeded the number of request units per second. Consult the DocumentClientException.RetryAfter value to see how long you should wait before retrying this operation.

Examples


  //Reads a Conflict resource from a Database
  // - sample_database is the ID of the database
  // - sample_collection is the ID of the collection
  // - conflict_id is the ID of the conflict to be read
  var conflictLink = "/dbs/sample_database/colls/sample_collection/conflicts/conflict_id";
  Conflict conflict = await client.ReadConflictAsync(conflictLink);

Remarks

Doing a read of a resource is the most efficient way to get a resource from the Database. If you know the resource's ID, do a read instead of a query by ID.

The example shown uses ID-based links, where the link is composed of the ID properties used when the resources were created. You can still use the SelfLink property of the Conflict if you prefer. A self-link is a URI for a resource that is made up of Resource Identifiers (or the _rid properties). ID-based links and SelfLink will both work. The format for conflictLink is always "/dbs/{db identifier}/colls/{collectioon identifier}/conflicts/{conflict identifier}" only the values within the {...} change depending on which method you wish to use to address the resource.

See also

ReadConflictAsync(Uri, RequestOptions)

Reads a Conflict as an asynchronous operation from the Azure Cosmos DB service.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Conflict>> ReadConflictAsync (Uri conflictUri, Microsoft.Azure.Documents.Client.RequestOptions options = null);
abstract member ReadConflictAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Conflict>>
override this.ReadConflictAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Conflict>>
Public Function ReadConflictAsync (conflictUri As Uri, Optional options As RequestOptions = null) As Task(Of ResourceResponse(Of Conflict))

Parameters

conflictUri
Uri

A URI to the Conflict resource to be read.

options
RequestOptions

The request options for the request.

Returns

A System.Threading.Tasks containing a ResourceResponse<TResource> which wraps a Conflict containing the read resource record.

Implements

Exceptions

If conflictUri is not set.

This exception can encapsulate many different types of errors. To determine the specific error always look at the StatusCode property. Some common codes you may get when creating a Document are:

StatusCodeReason for exception
404NotFound - This means the resource you tried to read did not exist.
429TooManyRequests - This means you have exceeded the number of request units per second. Consult the DocumentClientException.RetryAfter value to see how long you should wait before retrying this operation.

Examples


  //Reads a Conflict resource where 
  // - db_id is the ID property of the Database
  // - coll_id is the ID property of the DocumentCollection
  // - conflict_id is the ID property of the Conflict you wish to read. 
  var conflictLink = UriFactory.CreateConflictUri("db_id", "coll_id", "conflict_id");
  Conflict conflict = await client.ReadConflictAsync(conflictLink);

Remarks

Doing a read of a resource is the most efficient way to get a resource from the service. If you know the resource's ID, do a read instead of a query by ID.

See also

Applies to