ChangeFeedIteratorResponse 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.
continuationToken	Gets the continuation token to be used for continuing enumeration of the Azure Cosmos DB service.
count	Gets the number of items returned in the response from Azure Cosmos DB
diagnostics	Cosmos Diagnostic Object.
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
subStatusCode	Gets the subStatusCodes of the response from Azure Cosmos DB. Useful in partition split or partition gone.

Property Details

activityId

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

string activityId

Property Value

string

continuationToken

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

string continuationToken

Property Value

string

count

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

count: number

Property Value

number

diagnostics

Cosmos Diagnostic Object.

diagnostics: CosmosDiagnostics

Property Value

CosmosDiagnostics

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

subStatusCode

Gets the subStatusCodes of the response from Azure Cosmos DB. Useful in partition split or partition gone.

subStatusCode?: number

Property Value

number