azure-docs-sdk-java/docs-ref-autogen/com.azure.cosmos.CosmosDiagnosticsRequestInfo.yml

### YamlMime:JavaType
uid: "com.azure.cosmos.CosmosDiagnosticsRequestInfo"
fullName: "com.azure.cosmos.CosmosDiagnosticsRequestInfo"
name: "CosmosDiagnosticsRequestInfo"
nameWithType: "CosmosDiagnosticsRequestInfo"
summary: "This class represents diagnostic information for transport requests (calls to a replica in direct mode, calls to the Gateway for example to get metadata like physical addresses of replica for a partition."
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 **CosmosDiagnosticsRequestInfo**"
methods:
- uid: "com.azure.cosmos.CosmosDiagnosticsRequestInfo.getActivityId()"
  fullName: "com.azure.cosmos.CosmosDiagnosticsRequestInfo.getActivityId()"
  name: "getActivityId()"
  nameWithType: "CosmosDiagnosticsRequestInfo.getActivityId()"
  summary: "Gets the Activity used to track this request in the Cosmos DB service."
  syntax: "public String getActivityId()"
  desc: "Gets the Activity used to track this request in the Cosmos DB service."
  returns:
    description: "the Activity used to track this request in the Cosmos DB service."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.cosmos.CosmosDiagnosticsRequestInfo.getBackendLatency()"
  fullName: "com.azure.cosmos.CosmosDiagnosticsRequestInfo.getBackendLatency()"
  name: "getBackendLatency()"
  nameWithType: "CosmosDiagnosticsRequestInfo.getBackendLatency()"
  summary: "Gets the backend latency if available or null when backend latency isn't available for a request"
  syntax: "public Duration getBackendLatency()"
  desc: "Gets the backend latency if available or null when backend latency isn't available for a request"
  returns:
    description: "the backend latency if available or null when backend latency isn't available for a request"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
- uid: "com.azure.cosmos.CosmosDiagnosticsRequestInfo.getDuration()"
  fullName: "com.azure.cosmos.CosmosDiagnosticsRequestInfo.getDuration()"
  name: "getDuration()"
  nameWithType: "CosmosDiagnosticsRequestInfo.getDuration()"
  summary: "Gets the total duration for processing this request."
  syntax: "public Duration getDuration()"
  desc: "Gets the total duration for processing this request."
  returns:
    description: "the total duration for processing this request."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
- uid: "com.azure.cosmos.CosmosDiagnosticsRequestInfo.getPartitionId()"
  fullName: "com.azure.cosmos.CosmosDiagnosticsRequestInfo.getPartitionId()"
  name: "getPartitionId()"
  nameWithType: "CosmosDiagnosticsRequestInfo.getPartitionId()"
  summary: "Gets the identifier for the physical partition/shard this request was processed in or null when the request was not targeting a replica/partition directly."
  syntax: "public String getPartitionId()"
  desc: "Gets the identifier for the physical partition/shard this request was processed in or null when the request was not targeting a replica/partition directly."
  returns:
    description: "the identifier for the physical partition/shard this request was processed in or null when the request\n was not targeting a replica/partition directly."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.cosmos.CosmosDiagnosticsRequestInfo.getPartitionKeyRangeId()"
  fullName: "com.azure.cosmos.CosmosDiagnosticsRequestInfo.getPartitionKeyRangeId()"
  name: "getPartitionKeyRangeId()"
  nameWithType: "CosmosDiagnosticsRequestInfo.getPartitionKeyRangeId()"
  summary: "Gets the Partition<wbr>Key<wbr>Range<wbr>Id for the physical partition/shard this request was processed in or null when the request was not targeting a replica/partition directly."
  syntax: "public String getPartitionKeyRangeId()"
  desc: "Gets the PartitionKeyRangeId for the physical partition/shard this request was processed in or null when the request was not targeting a replica/partition directly."
  returns:
    description: "the PartitionKeyRangeId for the physical partition/shard this request was processed in or null when the request\n was not targeting a replica/partition directly."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.cosmos.CosmosDiagnosticsRequestInfo.getRequestPipelineEvents()"
  fullName: "com.azure.cosmos.CosmosDiagnosticsRequestInfo.getRequestPipelineEvents()"
  name: "getRequestPipelineEvents()"
  nameWithType: "CosmosDiagnosticsRequestInfo.getRequestPipelineEvents()"
  summary: "Gets more granular information about different stages of the request pipeline."
  syntax: "public Collection<CosmosDiagnosticsRequestEvent> getRequestPipelineEvents()"
  desc: "Gets more granular information about different stages of the request pipeline."
  returns:
    description: "more granular information about different stages of the request pipeline."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a>&lt;<xref href=\"com.azure.cosmos.CosmosDiagnosticsRequestEvent?alt=com.azure.cosmos.CosmosDiagnosticsRequestEvent&text=CosmosDiagnosticsRequestEvent\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.cosmos.CosmosDiagnosticsRequestInfo.getRequestType()"
  fullName: "com.azure.cosmos.CosmosDiagnosticsRequestInfo.getRequestType()"
  name: "getRequestType()"
  nameWithType: "CosmosDiagnosticsRequestInfo.getRequestType()"
  summary: "Gets the type of request"
  syntax: "public String getRequestType()"
  desc: "Gets the type of request"
  returns:
    description: "the type of the request"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.cosmos.CosmosDiagnosticsRequestInfo.getStartTime()"
  fullName: "com.azure.cosmos.CosmosDiagnosticsRequestInfo.getStartTime()"
  name: "getStartTime()"
  nameWithType: "CosmosDiagnosticsRequestInfo.getStartTime()"
  summary: "Gets the start time of the request."
  syntax: "public Instant getStartTime()"
  desc: "Gets the start time of the request."
  returns:
    description: "the start time of the request."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Instant.html\">Instant</a>"
type: "class"
desc: "This class represents diagnostic information for transport requests (calls to a replica in direct mode, calls to the Gateway for example to get metadata like physical addresses of replica for a partition."
metadata: {}
package: "com.azure.cosmos"
artifact: com.azure:azure-cosmos:4.63.4