/azure-docs-sdk-dotnet

Permalink
Switch branches/tags
Nothing to show
Find file
azure-docs-sdk-dotnet/xml/Microsoft.Azure.Documents/QueryMetrics.xml
Fetching contributors…
Cannot retrieve contributors at this time
Raw Blame History
294 lines (294 sloc) 13.5 KB
<Type Name="QueryMetrics" FullName="Microsoft.Azure.Documents.QueryMetrics">
<TypeSignature Language="C#" Value="public sealed class QueryMetrics" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit QueryMetrics extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Documents.QueryMetrics" />
<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>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Query metrics in the Azure DocumentDB database service.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="IndexHitRatio">
<MemberSignature Language="C#" Value="public double IndexHitRatio { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 IndexHitRatio" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.QueryMetrics.IndexHitRatio" />
<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 index hit ratio by query in the Azure DocumentDB database service.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="op_Addition">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Documents.QueryMetrics op_Addition (Microsoft.Azure.Documents.QueryMetrics m1, Microsoft.Azure.Documents.QueryMetrics m2);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname class Microsoft.Azure.Documents.QueryMetrics op_Addition(class Microsoft.Azure.Documents.QueryMetrics m1, class Microsoft.Azure.Documents.QueryMetrics m2) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.QueryMetrics.op_Addition(Microsoft.Azure.Documents.QueryMetrics,Microsoft.Azure.Documents.QueryMetrics)" />
<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>Microsoft.Azure.Documents.QueryMetrics</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="m1" Type="Microsoft.Azure.Documents.QueryMetrics" />
<Parameter Name="m2" Type="Microsoft.Azure.Documents.QueryMetrics" />
</Parameters>
<Docs>
<param name="m1">The first <see cref="T:Microsoft.Azure.Documents.QueryMetrics" /> instance</param>
<param name="m2">The second <see cref="T:Microsoft.Azure.Documents.QueryMetrics" /> instance</param>
<summary>
Add two specified <see cref="T:Microsoft.Azure.Documents.QueryMetrics" /> instances
</summary>
<returns>A new <see cref="T:Microsoft.Azure.Documents.QueryMetrics" /> instance that is the sum of two <see cref="T:Microsoft.Azure.Documents.QueryMetrics" /> instances</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OutputDocumentCount">
<MemberSignature Language="C#" Value="public long OutputDocumentCount { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 OutputDocumentCount" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.QueryMetrics.OutputDocumentCount" />
<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.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the number of documents returned by query in the Azure DocumentDB database service.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="QueryEngineTimes">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Documents.QueryEngineTimes QueryEngineTimes { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Documents.QueryEngineTimes QueryEngineTimes" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.QueryMetrics.QueryEngineTimes" />
<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>Microsoft.Azure.Documents.QueryEngineTimes</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the <see cref="T:Microsoft.Azure.Documents.QueryEngineTimes" /> instance in the Azure DocumentDB database service.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="QueryPreparationTimes">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Documents.QueryPreparationTimes QueryPreparationTimes { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Documents.QueryPreparationTimes QueryPreparationTimes" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.QueryMetrics.QueryPreparationTimes" />
<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>Microsoft.Azure.Documents.QueryPreparationTimes</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the <see cref="T:Microsoft.Azure.Documents.QueryPreparationTimes" /> instance in the Azure DocumentDB database service.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Retries">
<MemberSignature Language="C#" Value="public long Retries { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 Retries" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.QueryMetrics.Retries" />
<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.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets number of reties in the Azure DocumentDB database service.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RetrievedDocumentCount">
<MemberSignature Language="C#" Value="public long RetrievedDocumentCount { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 RetrievedDocumentCount" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.QueryMetrics.RetrievedDocumentCount" />
<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.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the number of documents retrieved during query in the Azure DocumentDB database service.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RetrievedDocumentSize">
<MemberSignature Language="C#" Value="public long RetrievedDocumentSize { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 RetrievedDocumentSize" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.QueryMetrics.RetrievedDocumentSize" />
<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.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the size of documents retrieved in bytes during query in the Azure DocumentDB database service.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.QueryMetrics.ToString" />
<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>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Gets the stringified <see cref="T:Microsoft.Azure.Documents.QueryMetrics" /> instance in the Azure DocumentDB database service.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TotalTime">
<MemberSignature Language="C#" Value="public TimeSpan TotalTime { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan TotalTime" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.QueryMetrics.TotalTime" />
<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.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the total query time in the Azure DocumentDB database service.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>