azure-docs-sdk-java/archive/docs-ref-autogen/com.microsoft.azure.cosmosd...

190 строки
12 KiB
YAML

### YamlMime:JavaType
constructors:
- fullName: com.microsoft.azure.cosmosdb.QueryMetrics.QueryMetrics(List<String> activities, long retrievedDocumentCount, long retrievedDocumentSize, long outputDocumentCount, long outputDocumentSize, long indexHitCount, Duration totalQueryExecutionTime, QueryPreparationTimes queryPreparationTimes, Duration indexLookupTime, Duration documentLoadTime, Duration vmExecutionTime, RuntimeExecutionTimes runtimeExecutionTimes, Duration documentWriteTime, ClientSideMetrics clientSideMetrics)
name: QueryMetrics(List<String> activities, long retrievedDocumentCount, long retrievedDocumentSize, long outputDocumentCount, long outputDocumentSize, long indexHitCount, Duration totalQueryExecutionTime, QueryPreparationTimes queryPreparationTimes, Duration indexLookupTime, Duration documentLoadTime, Duration vmExecutionTime, RuntimeExecutionTimes runtimeExecutionTimes, Duration documentWriteTime, ClientSideMetrics clientSideMetrics)
nameWithType: QueryMetrics.QueryMetrics(List<String> activities, long retrievedDocumentCount, long retrievedDocumentSize, long outputDocumentCount, long outputDocumentSize, long indexHitCount, Duration totalQueryExecutionTime, QueryPreparationTimes queryPreparationTimes, Duration indexLookupTime, Duration documentLoadTime, Duration vmExecutionTime, RuntimeExecutionTimes runtimeExecutionTimes, Duration documentWriteTime, ClientSideMetrics clientSideMetrics)
parameters:
- name: activities
type: <xref href="List%3CString%3E?alt=List%3CString%3E&text=List%3CString%3E" data-throw-if-not-resolved="False"/>
- name: retrievedDocumentCount
type: <xref href="long?alt=long&text=long" data-throw-if-not-resolved="False"/>
- name: retrievedDocumentSize
type: <xref href="long?alt=long&text=long" data-throw-if-not-resolved="False"/>
- name: outputDocumentCount
type: <xref href="long?alt=long&text=long" data-throw-if-not-resolved="False"/>
- name: outputDocumentSize
type: <xref href="long?alt=long&text=long" data-throw-if-not-resolved="False"/>
- name: indexHitCount
type: <xref href="long?alt=long&text=long" data-throw-if-not-resolved="False"/>
- name: totalQueryExecutionTime
type: <xref href="Duration?alt=Duration&text=Duration" data-throw-if-not-resolved="False"/>
- name: queryPreparationTimes
type: <xref href="com.microsoft.azure.cosmosdb.QueryPreparationTimes?alt=com.microsoft.azure.cosmosdb.QueryPreparationTimes&text=QueryPreparationTimes" data-throw-if-not-resolved="False"/>
- name: indexLookupTime
type: <xref href="Duration?alt=Duration&text=Duration" data-throw-if-not-resolved="False"/>
- name: documentLoadTime
type: <xref href="Duration?alt=Duration&text=Duration" data-throw-if-not-resolved="False"/>
- name: vmExecutionTime
type: <xref href="Duration?alt=Duration&text=Duration" data-throw-if-not-resolved="False"/>
- name: runtimeExecutionTimes
type: <xref href="com.microsoft.azure.cosmosdb.RuntimeExecutionTimes?alt=com.microsoft.azure.cosmosdb.RuntimeExecutionTimes&text=RuntimeExecutionTimes" data-throw-if-not-resolved="False"/>
- name: documentWriteTime
type: <xref href="Duration?alt=Duration&text=Duration" data-throw-if-not-resolved="False"/>
- name: clientSideMetrics
type: <xref href="ClientSideMetrics?alt=ClientSideMetrics&text=ClientSideMetrics" data-throw-if-not-resolved="False"/>
syntax: public QueryMetrics(List<String> activities, long retrievedDocumentCount, long retrievedDocumentSize, long outputDocumentCount, long outputDocumentSize, long indexHitCount, Duration totalQueryExecutionTime, QueryPreparationTimes queryPreparationTimes, Duration indexLookupTime, Duration documentLoadTime, Duration vmExecutionTime, RuntimeExecutionTimes runtimeExecutionTimes, Duration documentWriteTime, ClientSideMetrics clientSideMetrics)
uid: com.microsoft.azure.cosmosdb.QueryMetrics.QueryMetrics(List<String>,long,long,long,long,long,Duration,QueryPreparationTimes,Duration,Duration,Duration,RuntimeExecutionTimes,Duration,ClientSideMetrics)
fields:
- field:
type: <xref href="com.microsoft.azure.cosmosdb.QueryMetrics?alt=com.microsoft.azure.cosmosdb.QueryMetrics&text=QueryMetrics" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.azure.cosmosdb.QueryMetrics.ZERO
name: ZERO
nameWithType: QueryMetrics.ZERO
syntax: "public static QueryMetrics ZERO= new QueryMetrics(\n new ArrayList<>(), \n 0, \n 0, \n 0, \n 0, \n 0, \n Duration.ZERO,\n QueryPreparationTimes.ZERO,\n Duration.ZERO,\n Duration.ZERO,\n Duration.ZERO,\n RuntimeExecutionTimes.ZERO,\n Duration.ZERO,\n ClientSideMetrics.ZERO)"
uid: com.microsoft.azure.cosmosdb.QueryMetrics.ZERO
inheritances:
- <xref href="java.lang.Object" data-throw-if-not-resolved="False"/>
methods:
- fullName: com.microsoft.azure.cosmosdb.QueryMetrics.add(QueryMetrics... queryMetricsArgs)
name: add(QueryMetrics... queryMetricsArgs)
nameWithType: QueryMetrics.add(QueryMetrics... queryMetricsArgs)
parameters:
- name: queryMetricsArgs
type: <xref href="QueryMetrics...?alt=QueryMetrics...&text=QueryMetrics..." data-throw-if-not-resolved="False"/>
returns:
type: <xref href="com.microsoft.azure.cosmosdb.QueryMetrics?alt=com.microsoft.azure.cosmosdb.QueryMetrics&text=QueryMetrics" data-throw-if-not-resolved="False"/>
syntax: public QueryMetrics add(QueryMetrics... queryMetricsArgs)
uid: com.microsoft.azure.cosmosdb.QueryMetrics.add(QueryMetrics...)
- fullName: com.microsoft.azure.cosmosdb.QueryMetrics.getDocumentLoadTime()
name: getDocumentLoadTime()
nameWithType: QueryMetrics.getDocumentLoadTime()
returns:
description: <p>the documentLoadTime </p>
type: <xref href="Duration?alt=Duration&text=Duration" data-throw-if-not-resolved="False"/>
syntax: public Duration getDocumentLoadTime()
uid: com.microsoft.azure.cosmosdb.QueryMetrics.getDocumentLoadTime()
- fullName: com.microsoft.azure.cosmosdb.QueryMetrics.getDocumentWriteTime()
name: getDocumentWriteTime()
nameWithType: QueryMetrics.getDocumentWriteTime()
returns:
description: <p>the documentWriteTime </p>
type: <xref href="Duration?alt=Duration&text=Duration" data-throw-if-not-resolved="False"/>
syntax: public Duration getDocumentWriteTime()
uid: com.microsoft.azure.cosmosdb.QueryMetrics.getDocumentWriteTime()
- fullName: com.microsoft.azure.cosmosdb.QueryMetrics.getIndexHitDocumentCount()
name: getIndexHitDocumentCount()
nameWithType: QueryMetrics.getIndexHitDocumentCount()
returns:
description: <p>the indexHitDocumentCount </p>
type: <xref href="long?alt=long&text=long" data-throw-if-not-resolved="False"/>
syntax: public long getIndexHitDocumentCount()
uid: com.microsoft.azure.cosmosdb.QueryMetrics.getIndexHitDocumentCount()
- fullName: com.microsoft.azure.cosmosdb.QueryMetrics.getIndexHitRatio()
name: getIndexHitRatio()
nameWithType: QueryMetrics.getIndexHitRatio()
returns:
description: <p>the IndexHitRatio </p>
type: <xref href="double?alt=double&text=double" data-throw-if-not-resolved="False"/>
summary: >-
<p>Gets the index hit ratio by query in the Azure Cosmos database service.</p>
<p></p>
syntax: public double getIndexHitRatio()
uid: com.microsoft.azure.cosmosdb.QueryMetrics.getIndexHitRatio()
- fullName: com.microsoft.azure.cosmosdb.QueryMetrics.getIndexLookupTime()
name: getIndexLookupTime()
nameWithType: QueryMetrics.getIndexLookupTime()
returns:
description: <p>the indexLookupTime </p>
type: <xref href="Duration?alt=Duration&text=Duration" data-throw-if-not-resolved="False"/>
syntax: public Duration getIndexLookupTime()
uid: com.microsoft.azure.cosmosdb.QueryMetrics.getIndexLookupTime()
- fullName: com.microsoft.azure.cosmosdb.QueryMetrics.getOutputDocumentCount()
name: getOutputDocumentCount()
nameWithType: QueryMetrics.getOutputDocumentCount()
returns:
description: <p>the outputDocumentCount </p>
type: <xref href="long?alt=long&text=long" data-throw-if-not-resolved="False"/>
syntax: public long getOutputDocumentCount()
uid: com.microsoft.azure.cosmosdb.QueryMetrics.getOutputDocumentCount()
- fullName: com.microsoft.azure.cosmosdb.QueryMetrics.getOutputDocumentSize()
name: getOutputDocumentSize()
nameWithType: QueryMetrics.getOutputDocumentSize()
returns:
description: <p>the outputDocumentSize </p>
type: <xref href="long?alt=long&text=long" data-throw-if-not-resolved="False"/>
syntax: public long getOutputDocumentSize()
uid: com.microsoft.azure.cosmosdb.QueryMetrics.getOutputDocumentSize()
- fullName: com.microsoft.azure.cosmosdb.QueryMetrics.getQueryPreparationTimes()
name: getQueryPreparationTimes()
nameWithType: QueryMetrics.getQueryPreparationTimes()
returns:
description: <p>the queryPreparationTimes </p>
type: <xref href="com.microsoft.azure.cosmosdb.QueryPreparationTimes?alt=com.microsoft.azure.cosmosdb.QueryPreparationTimes&text=QueryPreparationTimes" data-throw-if-not-resolved="False"/>
syntax: public QueryPreparationTimes getQueryPreparationTimes()
uid: com.microsoft.azure.cosmosdb.QueryMetrics.getQueryPreparationTimes()
- fullName: com.microsoft.azure.cosmosdb.QueryMetrics.getRetries()
name: getRetries()
nameWithType: QueryMetrics.getRetries()
returns:
description: <p>number of reties in the Azure Cosmos database service. </p>
type: <xref href="long?alt=long&text=long" data-throw-if-not-resolved="False"/>
syntax: public long getRetries()
uid: com.microsoft.azure.cosmosdb.QueryMetrics.getRetries()
- fullName: com.microsoft.azure.cosmosdb.QueryMetrics.getRetrievedDocumentCount()
name: getRetrievedDocumentCount()
nameWithType: QueryMetrics.getRetrievedDocumentCount()
returns:
description: <p>the retrievedDocumentCount </p>
type: <xref href="long?alt=long&text=long" data-throw-if-not-resolved="False"/>
syntax: public long getRetrievedDocumentCount()
uid: com.microsoft.azure.cosmosdb.QueryMetrics.getRetrievedDocumentCount()
- fullName: com.microsoft.azure.cosmosdb.QueryMetrics.getRetrievedDocumentSize()
name: getRetrievedDocumentSize()
nameWithType: QueryMetrics.getRetrievedDocumentSize()
returns:
description: <p>the retrievedDocumentSize </p>
type: <xref href="long?alt=long&text=long" data-throw-if-not-resolved="False"/>
syntax: public long getRetrievedDocumentSize()
uid: com.microsoft.azure.cosmosdb.QueryMetrics.getRetrievedDocumentSize()
- fullName: com.microsoft.azure.cosmosdb.QueryMetrics.getRuntimeExecutionTimes()
name: getRuntimeExecutionTimes()
nameWithType: QueryMetrics.getRuntimeExecutionTimes()
returns:
description: <p>the runtimeExecutionTimes </p>
type: <xref href="com.microsoft.azure.cosmosdb.RuntimeExecutionTimes?alt=com.microsoft.azure.cosmosdb.RuntimeExecutionTimes&text=RuntimeExecutionTimes" data-throw-if-not-resolved="False"/>
syntax: public RuntimeExecutionTimes getRuntimeExecutionTimes()
uid: com.microsoft.azure.cosmosdb.QueryMetrics.getRuntimeExecutionTimes()
- fullName: com.microsoft.azure.cosmosdb.QueryMetrics.getTotalQueryExecutionTime()
name: getTotalQueryExecutionTime()
nameWithType: QueryMetrics.getTotalQueryExecutionTime()
returns:
description: <p>the totalQueryExecutionTime </p>
type: <xref href="Duration?alt=Duration&text=Duration" data-throw-if-not-resolved="False"/>
syntax: public Duration getTotalQueryExecutionTime()
uid: com.microsoft.azure.cosmosdb.QueryMetrics.getTotalQueryExecutionTime()
- fullName: com.microsoft.azure.cosmosdb.QueryMetrics.getVMExecutionTime()
name: getVMExecutionTime()
nameWithType: QueryMetrics.getVMExecutionTime()
returns:
description: <p>the vmExecutionTime </p>
type: <xref href="Duration?alt=Duration&text=Duration" data-throw-if-not-resolved="False"/>
syntax: public Duration getVMExecutionTime()
uid: com.microsoft.azure.cosmosdb.QueryMetrics.getVMExecutionTime()
- fullName: com.microsoft.azure.cosmosdb.QueryMetrics.toString()
name: toString()
nameWithType: QueryMetrics.toString()
returns:
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
syntax: public String toString()
uid: com.microsoft.azure.cosmosdb.QueryMetrics.toString()
nameWithType: QueryMetrics
syntax: public class QueryMetrics
type: class
uid: com.microsoft.azure.cosmosdb.QueryMetrics
fullName: com.microsoft.azure.cosmosdb.QueryMetrics
name: QueryMetrics
package: com.microsoft.azure.cosmosdb
summary: <p>Query metrics in the Azure Cosmos database service. This metric represents a moving average for a set of queries whose metrics have been aggregated together. </p>
metadata: {}