ChangeFeedResponse class

Package:

@azure/cosmos

A single response page from the Azure Cosmos DB Change Feed

Properties

activityId	Gets the activity ID for the request from the Azure Cosmos DB service.
continuation	Gets the continuation token to be used for continuing enumeration of the Azure Cosmos DB service. This is equivalent to the etag property.
count	Gets the number of items returned in the response from Azure Cosmos DB
diagnostics
etag	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.
headers	Response headers of the response from Azure Cosmos DB
requestCharge	Gets the request charge for this request from the Azure Cosmos DB service.
result	Gets the items returned in the response from Azure Cosmos DB
sessionToken	Gets the session token for use in session consistency reads from the Azure Cosmos DB service.
statusCode	Gets the status code of the response from Azure Cosmos DB

Property Details

activityId

Gets the activity ID for the request from the Azure Cosmos DB service.

string activityId

Property Value

string

continuation

Gets the continuation token to be used for continuing enumeration of the Azure Cosmos DB service.

This is equivalent to the etag property.

string continuation

Property Value

string

count

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

count: number

Property Value

number

diagnostics

diagnostics: CosmosDiagnostics

Property Value

CosmosDiagnostics

etag

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.

string etag

Property Value

string

headers

Response headers of the response from Azure Cosmos DB

headers: CosmosHeaders

Property Value

CosmosHeaders

requestCharge

Gets the request charge for this request from the Azure Cosmos DB service.

number requestCharge

Property Value

number

result

Gets the items returned in the response from Azure Cosmos DB

result: T

Property Value

T

sessionToken

Gets the session token for use in session consistency reads from the Azure Cosmos DB service.

string sessionToken

Property Value

string

statusCode

Gets the status code of the response from Azure Cosmos DB

statusCode: number

Property Value

number