Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

ItemResponse<T> Class

Definition

Namespace:
Microsoft.Azure.Cosmos
Assembly:
Microsoft.Azure.Cosmos.Client.dll
Package:
Microsoft.Azure.Cosmos v3.58.0
Package:
Microsoft.Azure.Cosmos v3.59.0-preview.0
Source:
ItemResponse.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The cosmos item response

public class ItemResponse<T> : Microsoft.Azure.Cosmos.Response<T>
type ItemResponse<'T> = class
 inherit Response<'T>
Public Class ItemResponse(Of T)
Inherits Response(Of T)

Type Parameters

T
Inheritance
ItemResponse<T>

Constructors

Name Description
ItemResponse<T>()

Create a ItemResponse<T> as a no-op for mock testing

Properties

Name Description
ActivityId

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

Diagnostics

Gets the cosmos diagnostics information for the current request to Azure Cosmos DB service

ETag

Gets the entity tag associated with the resource from the Azure Cosmos DB service.

Headers

Gets the current ResponseMessage HTTP headers.

RequestCharge

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

Resource

The content of the response.

StatusCode

Gets the request completion status code from the Azure Cosmos DB service. This can be used to in scenario like CreateDatabaseIfNotExists to help determine if the database was created or already existed.

Extension Methods

Name Description
GetIndexMetrics<T>(Response<T>)

This extension method returns the Index Metrics for a given Response object. The index utilization metrics is to be used for debugging purposes only. This result is only available if QueryRequestOptions.PopulateIndexMetrics is set to true.Returns null if the index metrics is not available in the response.

Applies to


Feedback

Was this page helpful?