/azure-docs-sdk-dotnet

Permalink
Switch branches/tags
Nothing to show
Find file
azure-docs-sdk-dotnet/xml/Microsoft.Azure.Documents.Client/IStoredProcedureResponse`1.xml
Fetching contributors…
Cannot retrieve contributors at this time
Raw Blame History
293 lines (293 sloc) 13 KB
<Type Name="IStoredProcedureResponse&lt;TValue&gt;" FullName="Microsoft.Azure.Documents.Client.IStoredProcedureResponse&lt;TValue&gt;">
<TypeSignature Language="C#" Value="public interface IStoredProcedureResponse&lt;TValue&gt;" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IStoredProcedureResponse`1&lt;TValue&gt;" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Documents.Client.IStoredProcedureResponse`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>
<Interfaces />
<Docs>
<typeparam name="TValue">The returned value type of the stored procedure.</typeparam>
<summary>
Interface exposed for mocking purposes for the Azure DocumentDB database service.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<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.IStoredProcedureResponse`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.
</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 DocumentDB support.
This is exposed for mocking purposes for the Azure DocumentDB database service.
</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.IStoredProcedureResponse`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.
</summary>
<value>The delimited string containing the number of used units per resource type within the collection.</value>
<remarks>
This is exposed for mocking purposes for the Azure DocumentDB database service.
</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.IStoredProcedureResponse`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.
</summary>
<value>The delimited string containing the number of used units per resource type within the collection.</value>
<remarks>
This is exposed for mocking purposes for the Azure DocumentDB database service.
</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.IStoredProcedureResponse`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 request units (RUs) charged.
</summary>
<value>
The number of normalized request units (RUs) charged.
</value>
<remarks>
This is exposed for mocking purposes for the Azure DocumentDB database service.
</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.IStoredProcedureResponse`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.
</summary>
<value>The response of a stored procedure, serialized into the given type.</value>
<remarks>
This is exposed for mocking purposes for the Azure DocumentDB database service.
</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.IStoredProcedureResponse`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.
</summary>
<value>
Headers associated with the response.
</value>
<remarks>
Provides access to all HTTP response headers returned from the
DocumentDB API.
This is exposed for mocking purposes for the Azure DocumentDB database service.
</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.IStoredProcedureResponse`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>
This is exposed for mocking purposes for the Azure DocumentDB database service.
</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.IStoredProcedureResponse`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.
</summary>
<value>
The token for use with session consistency requests.
</value>
<remarks>
This is exposed for mocking purposes for the Azure DocumentDB database service.
</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.IStoredProcedureResponse`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.
</summary>
<value>The request completion status code</value>
<remarks>
This is exposed for mocking purposes for the Azure DocumentDB database service.
</remarks>
</Docs>
</Member>
</Members>
</Type>