Class ResourceResponseBase

Namespace

Microsoft.Azure.Documents.Client

Assembly

Microsoft.Azure.Documents.Client.dll

Represents the non-resource specific service response headers returned by any request in the Azure Cosmos DB service.

public abstract class ResourceResponseBase : IResourceResponseBase

Inheritance

object

ResourceResponseBase

Implements

IResourceResponseBase

Derived

DocumentResponse<TDocument>

ResourceResponse<TResource>

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

ResourceResponseBase()

Constructor exposed for mocking purposes for the Azure Cosmos DB service.

public ResourceResponseBase()

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

Current collection size in kilobytes.

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

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

public string ContentLocation { get; }

Property Value

string

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.

DocumentQuota

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

public long DocumentQuota { get; }

Property Value

long

Quota in kilobytes.

DocumentUsage

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

public long DocumentUsage { get; }

Property Value

long

Current documents size in kilobytes.

IndexTransformationProgress

Gets the progress of an index transformation, if one is underway from the Azure Cosmos DB service.

public long IndexTransformationProgress { get; }

Property Value

long

An integer from 0 to 100 representing percentage completion of the index transformation process. Returns -1 if the index transformation progress header could not be found.

Remarks

An index will be rebuilt when the IndexPolicy of a collection is updated.

IsRUPerMinuteUsed

Gets the flag associated with the response from the Azure Cosmos DB service whether this 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.

LazyIndexingProgress

Gets the progress of lazy indexing from the Azure Cosmos DB service.

public long LazyIndexingProgress { get; }

Property Value

long

An integer from 0 to 100 representing percentage completion of the lazy indexing process. Returns -1 if the lazy indexing progress header could not be found.

Remarks

Lazy indexing progress only applies to the collection with indexing mode Lazy.

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.

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 the diagnostics information for the current request to Azure Cosmos DB service.

public string RequestDiagnosticsString { get; }

Property Value

string

Remarks

This field is only valid when the request uses direct connectivity.

RequestLatency

Gets the end-to-end request latency for the current request to Azure Cosmos DB service.

public TimeSpan RequestLatency { get; }

Property Value

TimeSpan

Remarks

This field is only valid when the request uses direct connectivity.

ResponseHeaders

Gets the response headers from the Azure Cosmos DB service.

public NameValueCollection ResponseHeaders { get; }

Property Value

NameValueCollection

The response headers.

ResponseStream

Gets the underlying stream of the response from the Azure Cosmos DB service.

public Stream ResponseStream { get; }

Property Value

Stream

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.

StatusCode

Gets the HTTP status code associated with the response from the Azure Cosmos DB service.

public HttpStatusCode StatusCode { get; }

Property Value

HttpStatusCode

The HTTP status code associated with the response.

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

Gets 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

The 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.