Interface IResourceResponseBase

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 interface IResourceResponseBase

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)

Remarks

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

Properties

ActivityId

Gets the activity ID for the request.

string ActivityId { get; }

Property Value

string

The activity ID for the request.

Remarks

This is exposed for mocking purposes for the Azure Cosmos DB service.

CollectionQuota

Gets the maximum quota for collection resources within an account.

long CollectionQuota { get; }

Property Value

long

The maximum quota for the account.

Remarks

This is exposed for mocking purposes for the Azure Cosmos DB service.

CollectionSizeQuota

Maximum size of a collection in kilobytes.

long CollectionSizeQuota { get; }

Property Value

long

Quota in kilobytes.

Remarks

This is exposed for mocking purposes for the Azure Cosmos DB service.

CollectionSizeUsage

Current size of a collection in kilobytes.

long CollectionSizeUsage { get; }

Property Value

long

Current collection size in kilobytes.

Remarks

This is exposed for mocking purposes for the Azure Cosmos DB service.

CollectionUsage

The current number of collection resources within the account.

long CollectionUsage { get; }

Property Value

long

The number of collections.

Remarks

This is exposed for mocking purposes for the Azure Cosmos DB service.

ContentLocation

The content parent location, for example, dbs/foo/colls/bar

string ContentLocation { get; }

Property Value

string

Remarks

This is exposed for mocking purposes for the Azure Cosmos DB service.

CurrentResourceQuotaUsage

Gets the current size of this entity.

string CurrentResourceQuotaUsage { get; }

Property Value

string

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

Remarks

This is exposed for mocking purposes for the Azure Cosmos DB service.

DatabaseQuota

Gets the maximum quota for database resources within the account.

long DatabaseQuota { get; }

Property Value

long

The maximum quota for the account.

Remarks

This is exposed for mocking purposes for the Azure Cosmos DB service.

DatabaseUsage

The current number of database resources within the account.

long DatabaseUsage { get; }

Property Value

long

The number of databases.

Remarks

This is exposed for mocking purposes for the Azure Cosmos DB service.

DocumentQuota

Maximum size of a documents within a collection in kilobytes.

long DocumentQuota { get; }

Property Value

long

Quota in kilobytes.

Remarks

This is exposed for mocking purposes for the Azure Cosmos DB service.

DocumentUsage

Current size of documents within a collection in kilobytes.

long DocumentUsage { get; }

Property Value

long

Current documents size in kilobytes.

Remarks

This is exposed for mocking purposes for the Azure Cosmos DB service.

IndexTransformationProgress

Gets the progress of an index transformation, if one is underway.

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. This is exposed for mocking purposes for the Azure Cosmos DB service.

LazyIndexingProgress

Gets the progress of lazy indexing.

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. This is exposed for mocking purposes for the Azure Cosmos DB service.

MaxResourceQuota

Gets the maximum size limit for this entity.

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.

Remarks

This is exposed for mocking purposes for the Azure Cosmos DB service.

PermissionQuota

Gets the maximum quota for permission resources within an account.

long PermissionQuota { get; }

Property Value

long

The maximum quota for the account.

Remarks

This is exposed for mocking purposes for the Azure Cosmos DB service.

PermissionUsage

The current number of permission resources within the account.

long PermissionUsage { get; }

Property Value

long

The number of permissions.

Remarks

This is exposed for mocking purposes for the Azure Cosmos DB service.

RequestCharge

Gets the request charge for this request.

double RequestCharge { get; }

Property Value

double

The request charge measured in reqest units.

Remarks

This is exposed for mocking purposes for the Azure Cosmos DB service.

ResponseHeaders

Gets the response headers.

NameValueCollection ResponseHeaders { get; }

Property Value

NameValueCollection

The response headers.

Remarks

This is exposed for mocking purposes for the Azure Cosmos DB service.

ResponseStream

Gets the underlying stream of the response.

Stream ResponseStream { get; }

Property Value

Stream

Remarks

This is exposed for mocking purposes for the Azure Cosmos DB service.

SessionToken

Gets the session token for use in sesssion consistency reads.

string SessionToken { get; }

Property Value

string

The session token for use in session consistency.

Remarks

This is exposed for mocking purposes for the Azure Cosmos DB service.

StatusCode

Gets the HTTP status code associated with the response.

HttpStatusCode StatusCode { get; }

Property Value

HttpStatusCode

The HTTP status code associated with the response.

Remarks

This is exposed for mocking purposes for the Azure Cosmos DB service.

StoredProceduresQuota

Gets the maximum quota of stored procedures for a collection.

long StoredProceduresQuota { get; }

Property Value

long

The maximum quota.

Remarks

This is exposed for mocking purposes for the Azure Cosmos DB service.

StoredProceduresUsage

The current number of stored procedures for a collection.

long StoredProceduresUsage { get; }

Property Value

long

Current number of stored procedures.

Remarks

This is exposed for mocking purposes for the Azure Cosmos DB service.

TriggersQuota

Gets the maximum quota of triggers for a collection.

long TriggersQuota { get; }

Property Value

long

The maximum quota.

Remarks

This is exposed for mocking purposes for the Azure Cosmos DB service.

TriggersUsage

The current number of triggers for a collection.

long TriggersUsage { get; }

Property Value

long

Current number of triggers.

Remarks

This is exposed for mocking purposes for the Azure Cosmos DB service.

UserDefinedFunctionsQuota

Gets the maximum quota of user defined functions for a collection.

long UserDefinedFunctionsQuota { get; }

Property Value

long

Maximum quota.

Remarks

This is exposed for mocking purposes for the Azure Cosmos DB service.

UserDefinedFunctionsUsage

The current number of user defined functions for a collection.

long UserDefinedFunctionsUsage { get; }

Property Value

long

Current number of user defined functions.

Remarks

This is exposed for mocking purposes for the Azure Cosmos DB service.

UserQuota

Gets the maximum quota for user resources within an account.

long UserQuota { get; }

Property Value

long

The maximum quota for the account.

Remarks

This is exposed for mocking purposes for the Azure Cosmos DB service.

UserUsage

The current number of user resources within the account.

long UserUsage { get; }

Property Value

long

The number of users.

Remarks

This is exposed for mocking purposes for the Azure Cosmos DB service.