Package com.azure.cosmos

Class CosmosDiagnostics

java.lang.Object
com.azure.cosmos.CosmosDiagnostics
public final class CosmosDiagnostics extends Object
This class represents response diagnostic statistics associated with a request to Azure Cosmos DB

  • Method Details

    • toString

      public String toString()
      Retrieves Response Diagnostic String
      Overrides:
      toString in class Object
      Returns:
      Response Diagnostic String

    • getDiagnosticsContext

      public CosmosDiagnosticsContext getDiagnosticsContext()
      Returns the associated CosmosDiagnosticsContext or null if not associated with any context yet.
      Returns:
      the associated CosmosDiagnosticsContext or null if not associated with any context yet.

    • getDuration

      public Duration getDuration()
      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:
      request completion duration

    • getRegionsContacted

      @Beta(value=V4_9_0, warningText="Preview API - subject to change in non-backwards compatible way") @Deprecated public Set<URI> getRegionsContacted()
      Deprecated.
      Regions contacted for this request
      Returns:
      set of regions contacted for this request

    • getContactedRegionNames

      public Set<String> getContactedRegionNames()
      Regions contacted for this request
      Returns:
      set of regions contacted for this request

    • getUserAgent

      public String getUserAgent()
      Gets the UserAgent header value used by the client issueing this operation
      Returns:
      the UserAgent header value used for the client that issued this operation