DocumentClient.ReadTriggerFeedAsync Method

Definition

Overloads

ReadTriggerFeedAsync(String, FeedOptions)

Reads the feed (sequence) of Trigger for a collection from the Azure Cosmos DB service as an asynchronous operation.

ReadTriggerFeedAsync(Uri, FeedOptions)

Reads the feed (sequence) of triggers for a collection as an asynchronous operation from the Azure Cosmos DB service.

ReadTriggerFeedAsync(String, FeedOptions)

Reads the feed (sequence) of Trigger for a collection from the Azure Cosmos DB service as an asynchronous operation.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<Microsoft.Azure.Documents.Trigger>> ReadTriggerFeedAsync (string triggersLink, Microsoft.Azure.Documents.Client.FeedOptions options = null);
abstract member ReadTriggerFeedAsync : string * Microsoft.Azure.Documents.Client.FeedOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<Microsoft.Azure.Documents.Trigger>>
override this.ReadTriggerFeedAsync : string * Microsoft.Azure.Documents.Client.FeedOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<Microsoft.Azure.Documents.Trigger>>
Public Function ReadTriggerFeedAsync (triggersLink As String, Optional options As FeedOptions = null) As Task(Of FeedResponse(Of Trigger))

Parameters

triggersLink
String

The SelfLink of the resources to be read. E.g. /dbs/db_rid/colls/col_rid/triggers/

options
FeedOptions

(Optional) The request options for the request.

Returns

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

Implements

Exceptions

If triggersLink 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 feed you tried to read did not exist. Check the parent rids are correct.
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


   int count = 0;
   string continuation = string.Empty;
   do
   {
       // Read the feed 10 items at a time until there are no more items to read
       FeedResponse<Trigger> response = await client.ReadTriggerFeedAsync("/dbs/db_rid/colls/col_rid/triggers/",
                                                       new FeedOptions
                                                       {
                                                           MaxItemCount = 10,
                                                           RequestContinuation = continuation
                                                       });
  
       // Append the item count
       count += response.Count;
  
       // Get the continuation so that we know when to stop.
        continuation = response.ResponseContinuation;
   } while (!string.IsNullOrEmpty(continuation));

See also

ReadTriggerFeedAsync(Uri, FeedOptions)

Reads the feed (sequence) of triggers for a collection as an asynchronous operation from the Azure Cosmos DB service.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<Microsoft.Azure.Documents.Trigger>> ReadTriggerFeedAsync (Uri triggersUri, Microsoft.Azure.Documents.Client.FeedOptions options = null);
abstract member ReadTriggerFeedAsync : Uri * Microsoft.Azure.Documents.Client.FeedOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<Microsoft.Azure.Documents.Trigger>>
override this.ReadTriggerFeedAsync : Uri * Microsoft.Azure.Documents.Client.FeedOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<Microsoft.Azure.Documents.Trigger>>
Public Function ReadTriggerFeedAsync (triggersUri As Uri, Optional options As FeedOptions = null) As Task(Of FeedResponse(Of Trigger))

Parameters

triggersUri
Uri

the URI for the triggers.

options
FeedOptions

The request options for the request.

Returns

The task object representing the service response for the asynchronous operation.

Implements

Applies to