StoredProcedureResponse<TValue> Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents the response returned from a database stored procedure in the Azure Cosmos DB service. Wraps the response body and headers.
public class StoredProcedureResponse<TValue> : Microsoft.Azure.Documents.Client.IStoredProcedureResponse<TValue>
type StoredProcedureResponse<'Value> = class
interface IStoredProcedureResponse<'Value>
Public Class StoredProcedureResponse(Of TValue)
Implements IStoredProcedureResponse(Of TValue)
Type Parameters
- TValue
The returned value type of the stored procedure.
- Inheritance
-
StoredProcedureResponse<TValue>
- Implements
Remarks
Stored procedures can return any string output via the getContext().getResponse().setBody() method. This response body could be a serialized JSON object, or any other type. Within the .NET SDK, you can deserialize the response into a corresponding TValue type.
Constructors
StoredProcedureResponse<TValue>() |
Constructor exposed for mocking purposes in Azure Cosmos DB service. |
Properties
ActivityId |
Gets the Activity ID of the request from the Azure Cosmos DB service. |
CurrentResourceQuotaUsage |
Gets the delimited string containing the usage of each resource type within the collection from the Azure Cosmos DB service. |
IsRUPerMinuteUsed |
Gets the flag associated with the response from the Azure Cosmos DB service whether this stored procedure request is served from Request Units(RUs)/minute capacity or not. |
MaxResourceQuota |
Gets the delimited string containing the quota of each resource type within the collection from the Azure Cosmos DB service. |
RequestCharge |
Gets the number of normalized Azure Cosmos DB request units (RUs) charged from Azure Cosmos DB service. |
RequestDiagnosticsString |
Gets the diagnostics information for the current request to Azure Cosmos DB service. |
Response |
Gets the response of a stored procedure, serialized into the given type from the Azure Cosmos DB service. |
ResponseHeaders |
Gets the headers associated with the response from the Azure Cosmos DB service. |
ScriptLog |
Gets the output from stored procedure console.log() statements. |
SessionToken |
Gets the token for use with session consistency requests from the Azure Cosmos DB service. |
StatusCode |
Gets the request completion status code from the Azure Cosmos DB service. |
Operators
Implicit(StoredProcedureResponse<TValue> to TValue) |
Gets the resource implicitly from Azure Cosmos DB service. |