/azure-docs-sdk-dotnet

Permalink
Switch branches/tags
Nothing to show
Find file
azure-docs-sdk-dotnet/xml/Microsoft.Azure.Documents.Client/StoredProcedureResponse`1.xml
Fetching contributors…
Cannot retrieve contributors at this time
Raw Blame History
367 lines (367 sloc) 17.2 KB
<Type Name="StoredProcedureResponse&lt;TValue&gt;" FullName="Microsoft.Azure.Documents.Client.StoredProcedureResponse&lt;TValue&gt;">
<TypeSignature Language="C#" Value="public class StoredProcedureResponse&lt;TValue&gt; : Microsoft.Azure.Documents.Client.IStoredProcedureResponse&lt;TValue&gt;" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit StoredProcedureResponse`1&lt;TValue&gt; extends System.Object implements class Microsoft.Azure.Documents.Client.IStoredProcedureResponse`1&lt;!TValue&gt;" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Documents.Client.StoredProcedureResponse`1" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeParameters>
<TypeParameter Name="TValue" />
</TypeParameters>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Azure.Documents.Client.IStoredProcedureResponse&lt;TValue&gt;</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<typeparam name="TValue">The returned value type of the stored procedure.</typeparam>
<summary>
Represents the response returned from a database stored procedure in the Azure DocumentDB database service. Wraps the response body and headers.
</summary>
<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.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public StoredProcedureResponse ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Client.StoredProcedureResponse`1.#ctor" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Constructor exposed for mocking purposes in Azure DocumentDB database service.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ActivityId">
<MemberSignature Language="C#" Value="public string ActivityId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ActivityId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Client.StoredProcedureResponse`1.ActivityId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the Activity ID of the request from the Azure DocumentDB database service.
</summary>
<value>
The Activity ID of the request.
</value>
<remarks>Every request is traced with a globally unique ID. Include activity ID in tracing application failures and when contacting Azure DocumentDB support</remarks>
</Docs>
</Member>
<Member MemberName="CurrentResourceQuotaUsage">
<MemberSignature Language="C#" Value="public string CurrentResourceQuotaUsage { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string CurrentResourceQuotaUsage" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Client.StoredProcedureResponse`1.CurrentResourceQuotaUsage" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the delimited string containing the usage of each resource type within the collection from the Azure DocumentDB database service.
</summary>
<value>The delimited string containing the number of used units per resource type within the collection.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsRUPerMinuteUsed">
<MemberSignature Language="C#" Value="public bool IsRUPerMinuteUsed { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsRUPerMinuteUsed" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Client.StoredProcedureResponse`1.IsRUPerMinuteUsed" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the flag associated with the response from the Azure DocumentDB database service whether this stored procedure request is served from Request Units(RUs)/minute capacity or not.
</summary>
<value>
True if this request is served from RUs/minute capacity. Otherwise, false.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxResourceQuota">
<MemberSignature Language="C#" Value="public string MaxResourceQuota { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string MaxResourceQuota" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Client.StoredProcedureResponse`1.MaxResourceQuota" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the delimited string containing the quota of each resource type within the collection from the Azure DocumentDB database service.
</summary>
<value>The delimited string containing the number of used units per resource type within the collection.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="op_Implicit">
<MemberSignature Language="C#" Value="public static TValue op_Implicit (Microsoft.Azure.Documents.Client.StoredProcedureResponse&lt;TValue&gt; source);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname !TValue op_Implicit(class Microsoft.Azure.Documents.Client.StoredProcedureResponse`1&lt;!TValue&gt; source) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Client.StoredProcedureResponse`1.op_Implicit(Microsoft.Azure.Documents.Client.StoredProcedureResponse{`0})~`0" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TValue</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="source" Type="Microsoft.Azure.Documents.Client.StoredProcedureResponse&lt;TValue&gt;" />
</Parameters>
<Docs>
<param name="source">Stored procedure response.</param>
<summary>
Gets the resource implicitly from Azure DocumentDB database service.
</summary>
<returns>The returned resource.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RequestCharge">
<MemberSignature Language="C#" Value="public double RequestCharge { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 RequestCharge" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Client.StoredProcedureResponse`1.RequestCharge" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the number of normalized Azure DocumentDB request units (RUs) charged from Azure DocumentDB database service.
</summary>
<value>
The number of normalized Azure DocumentDB request units (RUs) charged.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Response">
<MemberSignature Language="C#" Value="public TValue Response { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance !TValue Response" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Client.StoredProcedureResponse`1.Response" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TValue</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the response of a stored procedure, serialized into the given type from the Azure DocumentDB database service.
</summary>
<value>The response of a stored procedure, serialized into the given type.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ResponseHeaders">
<MemberSignature Language="C#" Value="public System.Collections.Specialized.NameValueCollection ResponseHeaders { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Specialized.NameValueCollection ResponseHeaders" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Client.StoredProcedureResponse`1.ResponseHeaders" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Specialized.NameValueCollection</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the headers associated with the response from the Azure DocumentDB database service.
</summary>
<value>
Headers associated with the response.
</value>
<remarks>
Provides access to all HTTP response headers returned from the
DocumentDB API.
</remarks>
</Docs>
</Member>
<Member MemberName="ScriptLog">
<MemberSignature Language="C#" Value="public string ScriptLog { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ScriptLog" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Client.StoredProcedureResponse`1.ScriptLog" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the output from stored procedure console.log() statements.
</summary>
<value>
Output from console.log() statements in a stored procedure.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SessionToken">
<MemberSignature Language="C#" Value="public string SessionToken { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string SessionToken" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Client.StoredProcedureResponse`1.SessionToken" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the token for use with session consistency requests from the Azure DocumentDB database service.
</summary>
<value>
The token for use with session consistency requests.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StatusCode">
<MemberSignature Language="C#" Value="public System.Net.HttpStatusCode StatusCode { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Net.HttpStatusCode StatusCode" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Client.StoredProcedureResponse`1.StatusCode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.HttpStatusCode</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the request completion status code from the Azure DocumentDB database service.
</summary>
<value>The request completion status code</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>