Interface IStoredProcedureResponse<TValue>

Namespace

Microsoft.Azure.Documents.Client

Assembly

Microsoft.Azure.Documents.Client.dll

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

public interface IStoredProcedureResponse<TValue>

Type Parameters

TValue

The returned value type of the stored procedure.

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)

Properties

ActivityId

Gets the Activity ID of the request.

string ActivityId { get; }

Property Value

string

The Activity ID of the request.

Remarks

Every request is traced with a globally unique ID. Include activity ID in tracing application failures and when contacting Azure Cosmos DB support. This is exposed for mocking purposes for the Azure Cosmos DB service.

CurrentResourceQuotaUsage

Gets the delimited string containing the usage of each resource type within the collection.

string CurrentResourceQuotaUsage { get; }

Property Value

string

The delimited string containing the number of used units per resource type within the collection.

Remarks

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

MaxResourceQuota

Gets the delimited string containing the quota of each resource type within the collection.

string MaxResourceQuota { get; }

Property Value

string

The delimited string containing the number of used units per resource type within the collection.

Remarks

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

RequestCharge

Gets the number of normalized request units (RUs) charged.

double RequestCharge { get; }

Property Value

double

The number of normalized request units (RUs) charged.

Remarks

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

Response

Gets the response of a stored procedure, serialized into the given type.

TValue Response { get; }

Property Value

TValue

The response of a stored procedure, serialized into the given type.

Remarks

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

ResponseHeaders

Gets the headers associated with the response.

NameValueCollection ResponseHeaders { get; }

Property Value

NameValueCollection

Headers associated with the response.

Remarks

Provides access to all HTTP response headers returned from the Azure Cosmos DB API. This is exposed for mocking purposes for the Azure Cosmos DB service.

ScriptLog

Gets the output from stored procedure console.log() statements.

string ScriptLog { get; }

Property Value

string

Output from console.log() statements in a stored procedure.

Remarks

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

See Also

EnableScriptLogging

SessionToken

Gets the token for use with session consistency requests.

string SessionToken { get; }

Property Value

string

The token for use with session consistency requests.

Remarks

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

StatusCode

Gets the request completion status code.

HttpStatusCode StatusCode { get; }

Property Value

HttpStatusCode

The request completion status code

Remarks

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