Class FeedResponse<T>

Namespace

Microsoft.Azure.Cosmos

Assembly

Microsoft.Azure.Cosmos.Client.dll

The user contract for the various feed responses that serialized the responses to a type. To follow the .NET standard for typed responses any exceptions should be thrown to the user.

public abstract class FeedResponse<T> : Response<IEnumerable<T>>, IEnumerable<T>, IEnumerable

Type Parameters

T

Inheritance

object

Response<IEnumerable<T>>

FeedResponse<T>

Implements

IEnumerable<T>

IEnumerable

Inherited Members

Response<IEnumerable<T>>.Headers

Response<IEnumerable<T>>.Resource

Response<IEnumerable<T>>.StatusCode

Response<IEnumerable<T>>.Diagnostics

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

CosmosLinqExtensions.IsDefined(object)

CosmosLinqExtensions.IsNull(object)

CosmosLinqExtensions.IsPrimitive(object)

Constructors

FeedResponse()

Create an empty cosmos feed response for mock testing

protected FeedResponse()

Properties

ActivityId

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

public override string ActivityId { get; }

Property Value

string

The activity ID for the request.

ContinuationToken

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

public abstract string ContinuationToken { get; }

Property Value

string

The continuation token to be used for continuing enumeration.

Count

The number of items in the stream.

public abstract int Count { get; }

Property Value

int

ETag

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

public override string ETag { get; }

Property Value

string

The entity tag associated with the resource.

Remarks

ETags are used for concurrency checking when updating resources.

IndexMetrics

Gets the index utilization metrics to be used for debugging purposes. It's applicable to query response only. Other feed response will return null for this field. This result is only available if QueryRequestOptions.PopulateIndexMetrics is set to true.

public abstract string IndexMetrics { get; }

Property Value

string

The index utilization metrics.

RequestCharge

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

public override double RequestCharge { get; }

Property Value

double

The request charge measured in request units.

Methods

GetEnumerator()

Get an enumerator of the object.

public abstract IEnumerator<T> GetEnumerator()

Returns

IEnumerator<T>

An instance of an Enumerator