Class FeedResponse<T>

Namespace

Microsoft.Azure.Documents.Client

Assembly

Microsoft.Azure.Documents.Client.dll

Represents the template class used by feed methods (enumeration operations) for the Azure Cosmos DB service.

public class FeedResponse<T> : IEnumerable<T>, IEnumerable, IDynamicMetaObjectProvider, IFeedResponse<T>

Type Parameters

T

The feed type.

Inheritance

object

FeedResponse<T>

Implements

IEnumerable<T>

IEnumerable

IDynamicMetaObjectProvider

IFeedResponse<T>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

TypeCheckFunctionsExtensions.IsArray(object)

TypeCheckFunctionsExtensions.IsBool(object)

TypeCheckFunctionsExtensions.IsDefined(object)

TypeCheckFunctionsExtensions.IsNull(object)

TypeCheckFunctionsExtensions.IsNumber(object)

TypeCheckFunctionsExtensions.IsObject(object)

TypeCheckFunctionsExtensions.IsPrimitive(object)

TypeCheckFunctionsExtensions.IsString(object)

Constructors

FeedResponse()

Constructor exposed for mocking purposes.

public FeedResponse()

FeedResponse(IEnumerable<T>)

Constructor exposed for mocking purposes.

public FeedResponse(IEnumerable<T> result)

Parameters

result IEnumerable<T>

Properties

ActivityId

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

public string ActivityId { get; }

Property Value

string

The activity ID for the request.

CollectionQuota

Gets the maximum quota for collection resources within an account from the Azure Cosmos DB service.

public long CollectionQuota { get; }

Property Value

long

The maximum quota for the account.

CollectionSizeQuota

Gets the maximum size of a collection in kilobytes from the Azure Cosmos DB service.

public long CollectionSizeQuota { get; }

Property Value

long

Quota in kilobytes.

CollectionSizeUsage

Gets the current size of a collection in kilobytes from the Azure Cosmos DB service.

public long CollectionSizeUsage { get; }

Property Value

long

CollectionUsage

Gets the current number of collection resources within the account from the Azure Cosmos DB service.

public long CollectionUsage { get; }

Property Value

long

The number of collections.

ContentLocation

Gets the content parent location, for example, dbs/foo/colls/bar, from the Azure Cosmos DB service.

public string ContentLocation { get; }

Property Value

string

Count

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

public int Count { get; }

Property Value

int

Count of items in the response.

CurrentResourceQuotaUsage

Gets the current size of this entity from the Azure Cosmos DB service.

public string CurrentResourceQuotaUsage { get; }

Property Value

string

The current size for this entity. Measured in kilobytes for document resources and in counts for other resources.

DatabaseQuota

Gets the maximum quota for database resources within the account from the Azure Cosmos DB service.

public long DatabaseQuota { get; }

Property Value

long

The maximum quota for the account.

DatabaseUsage

Gets the current number of database resources within the account from the Azure Cosmos DB service.

public long DatabaseUsage { get; }

Property Value

long

The number of databases.

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 ContinuationToken property of ChangeFeedOptions parameter for CreateDocumentChangeFeedQuery(string, ChangeFeedOptions) to get feed changes since the transaction specified by this entity tag.

public string ETag { get; }

Property Value

string

IsRUPerMinuteUsed

Gets the flag associated with the response from the Azure Cosmos DB service whether this feed request is served from Request Units(RUs)/minute capacity or not.

public bool IsRUPerMinuteUsed { get; }

Property Value

bool

True if this request is served from RUs/minute capacity. Otherwise, false.

MaxResourceQuota

Gets the maximum size limit for this entity from the Azure Cosmos DB service.

public string MaxResourceQuota { get; }

Property Value

string

The maximum size limit for this entity. Measured in kilobytes for document resources and in counts for other resources.

PermissionQuota

Gets the maximum quota for permission resources within an account from the Azure Cosmos DB service.

public long PermissionQuota { get; }

Property Value

long

The maximum quota for the account.

PermissionUsage

Gets the current number of permission resources within the account from the Azure Cosmos DB service.

public long PermissionUsage { get; }

Property Value

long

The number of permissions.

QueryMetrics

Get QueryMetrics for each individual partition in the Azure Cosmos DB service

public IReadOnlyDictionary<string, QueryMetrics> QueryMetrics { get; }

Property Value

IReadOnlyDictionary<string, QueryMetrics>

RequestCharge

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

public double RequestCharge { get; }

Property Value

double

The request charge measured in reqest units.

RequestDiagnosticsString

Gets a dump for troubleshooting the request.

public string RequestDiagnosticsString { get; }

Property Value

string

ResponseContinuation

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

public string ResponseContinuation { get; }

Property Value

string

The continuation token to be used for continuing enumeration.

ResponseHeaders

Gets the response headers from the Azure Cosmos DB service.

public NameValueCollection ResponseHeaders { get; }

Property Value

NameValueCollection

The response headers.

SessionToken

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

public string SessionToken { get; }

Property Value

string

The session token for use in session consistency.

StoredProceduresQuota

Gets the maximum quota of stored procedures for a collection from the Azure Cosmos DB service.

public long StoredProceduresQuota { get; }

Property Value

long

The maximum quota.

StoredProceduresUsage

Gets the current number of stored procedures for a collection from the Azure Cosmos DB service.

public long StoredProceduresUsage { get; }

Property Value

long

Current number of stored procedures.

TriggersQuota

Gets the maximum quota of triggers for a collection from the Azure Cosmos DB service.

public long TriggersQuota { get; }

Property Value

long

The maximum quota.

TriggersUsage

Get the current number of triggers for a collection from the Azure Cosmos DB service.

public long TriggersUsage { get; }

Property Value

long

Current number of triggers.

UserDefinedFunctionsQuota

Gets the maximum quota of user defined functions for a collection from the Azure Cosmos DB service.

public long UserDefinedFunctionsQuota { get; }

Property Value

long

Maximum quota.

UserDefinedFunctionsUsage

Gets the current number of user defined functions for a collection from the Azure Cosmos DB service.

public long UserDefinedFunctionsUsage { get; }

Property Value

long

Current number of user defined functions.

UserQuota

Gets the maximum quota for user resources within an account from the Azure Cosmos DB service.

public long UserQuota { get; }

Property Value

long

The maximum quota for the account.

UserUsage

Gets the current number of user resources within the account from the Azure Cosmos DB service.

public long UserUsage { get; }

Property Value

long

The number of users.

Methods

GetEnumerator()

Returns an enumerator that iterates through a collection from the Azure Cosmos DB service.

public IEnumerator<T> GetEnumerator()

Returns

IEnumerator<T>

An IEnumerator object that can be used to iterate through the collection.