Class ChangeFeedResponse<T>

Package version

A single response page from the Azure Cosmos DB Change Feed

Type parameters

T

Hierarchy

ChangeFeedResponse

Index

Properties

Accessors

Properties

count

count: number

Gets the number of items returned in the response from Azure Cosmos DB

headers

headers: CosmosHeaders

Response headers of the response from Azure Cosmos DB

result

result: T

Gets the items returned in the response from Azure Cosmos DB

statusCode

statusCode: number

Gets the status code of the response from Azure Cosmos DB

Accessors

activityId

get activityId(): string

- Defined in home/vsts/work/1/s/sdk/cosmosdb/cosmos/src/ChangeFeedResponse.ts:48
Gets the activity ID for the request from the Azure Cosmos DB service.

Returns string

continuation

get continuation(): string

- Defined in home/vsts/work/1/s/sdk/cosmosdb/cosmos/src/ChangeFeedResponse.ts:57
Gets the continuation token to be used for continuing enumeration of the Azure Cosmos DB service.

This is equivalent to the etag property.

Returns string

etag

get etag(): string

- Defined in home/vsts/work/1/s/sdk/cosmosdb/cosmos/src/ChangeFeedResponse.ts:77
Gets the entity tag associated with last transaction in the Azure Cosmos DB service, which can be used as If-Non-Match Access condition for ReadFeed REST request or continuation property of ChangeFeedOptions parameter for Items.changeFeed() to get feed changes since the transaction specified by this entity tag.

This is equivalent to the continuation property.

Returns string

requestCharge

get requestCharge(): number

- Defined in home/vsts/work/1/s/sdk/cosmosdb/cosmos/src/ChangeFeedResponse.ts:40
Gets the request charge for this request from the Azure Cosmos DB service.

Returns number

sessionToken

get sessionToken(): string

- Defined in home/vsts/work/1/s/sdk/cosmosdb/cosmos/src/ChangeFeedResponse.ts:64
Gets the session token for use in session consistency reads from the Azure Cosmos DB service.

Returns string

Generated using TypeDoc