91 строка
5.9 KiB
YAML
91 строка
5.9 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.cosmos.CosmosDiagnostics"
|
|
fullName: "com.azure.cosmos.CosmosDiagnostics"
|
|
name: "CosmosDiagnostics"
|
|
nameWithType: "CosmosDiagnostics"
|
|
summary: "This class represents response diagnostic statistics associated with a request to Azure Cosmos DB"
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **CosmosDiagnostics**"
|
|
methods:
|
|
- uid: "com.azure.cosmos.CosmosDiagnostics.getContactedRegionNames()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnostics.getContactedRegionNames()"
|
|
name: "getContactedRegionNames()"
|
|
nameWithType: "CosmosDiagnostics.getContactedRegionNames()"
|
|
summary: "Regions contacted for this request"
|
|
syntax: "public Set<String> getContactedRegionNames()"
|
|
desc: "Regions contacted for this request"
|
|
returns:
|
|
description: "set of regions contacted for this request"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Set.html\">Set</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- uid: "com.azure.cosmos.CosmosDiagnostics.getDiagnosticsContext()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnostics.getDiagnosticsContext()"
|
|
name: "getDiagnosticsContext()"
|
|
nameWithType: "CosmosDiagnostics.getDiagnosticsContext()"
|
|
summary: "Returns the associated Cosmos<wbr>Diagnostics<wbr>Context or null if not associated with any context yet."
|
|
syntax: "public CosmosDiagnosticsContext getDiagnosticsContext()"
|
|
desc: "Returns the associated CosmosDiagnosticsContext or null if not associated with any context yet."
|
|
returns:
|
|
description: "the associated CosmosDiagnosticsContext or null if not associated with any context yet."
|
|
type: "<xref href=\"com.azure.cosmos.CosmosDiagnosticsContext?alt=com.azure.cosmos.CosmosDiagnosticsContext&text=CosmosDiagnosticsContext\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.CosmosDiagnostics.getDuration()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnostics.getDuration()"
|
|
name: "getDuration()"
|
|
nameWithType: "CosmosDiagnostics.getDuration()"
|
|
summary: "Retrieves duration related to the completion of the request."
|
|
syntax: "public Duration getDuration()"
|
|
desc: "Retrieves duration related to the completion of the request. This represents end to end duration of an operation including all the retries. This is meant for point operation only, for query please use toString() to get full query diagnostics."
|
|
returns:
|
|
description: "request completion duration"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- uid: "com.azure.cosmos.CosmosDiagnostics.getRegionsContacted()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnostics.getRegionsContacted()"
|
|
name: "getRegionsContacted()"
|
|
nameWithType: "CosmosDiagnostics.getRegionsContacted()"
|
|
summary: "Regions contacted for this request"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public Set<URI> getRegionsContacted()"
|
|
desc: "Regions contacted for this request"
|
|
returns:
|
|
description: "set of regions contacted for this request"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Set.html\">Set</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/net/URI.html\">URI</a>>"
|
|
- uid: "com.azure.cosmos.CosmosDiagnostics.getUserAgent()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnostics.getUserAgent()"
|
|
name: "getUserAgent()"
|
|
nameWithType: "CosmosDiagnostics.getUserAgent()"
|
|
summary: "Gets the User<wbr>Agent header value used by the client issueing this operation"
|
|
syntax: "public String getUserAgent()"
|
|
desc: "Gets the UserAgent header value used by the client issueing this operation"
|
|
returns:
|
|
description: "the UserAgent header value used for the client that issued this operation"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.cosmos.CosmosDiagnostics.toString()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnostics.toString()"
|
|
name: "toString()"
|
|
nameWithType: "CosmosDiagnostics.toString()"
|
|
summary: "Retrieves Response Diagnostic String"
|
|
overridden: "java.lang.Object.toString()"
|
|
syntax: "public String toString()"
|
|
desc: "Retrieves Response Diagnostic String"
|
|
returns:
|
|
description: "Response Diagnostic String"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
type: "class"
|
|
desc: "This class represents response diagnostic statistics associated with a request to Azure Cosmos DB"
|
|
metadata: {}
|
|
package: "com.azure.cosmos"
|
|
artifact: com.azure:azure-cosmos:4.63.3
|