Class PingResult

java.lang.Object
com.couchbase.client.core.diagnostics.PingResult

public class PingResult extends Object
  • Constructor Details

    • PingResult

      @Internal public PingResult(Map<ServiceType,List<EndpointPingReport>> endpoints, String sdk, String id)
      Creates the new ping report.

      Note that this is internal API and should not be called at the application level.

      Parameters:
      endpoints - the health of each individual endpoint.
      sdk - the sdk identifier.
      id - the report ID.
  • Method Details

    • id

      public String id()
      The ID of this report.
      Returns:
      the ID, either automatically generated or the one provided by the user.
    • version

      public int version()
      The version of this report (useful when exporting to JSON).
      Returns:
      the version format of this report.
    • sdk

      public String sdk()
      The identifier of this SDK (useful when exporting to JSON).
      Returns:
      the identifier of this SDK.
    • endpoints

      public Map<ServiceType,List<EndpointPingReport>> endpoints()
      Returns the diagnostic reports of each individual endpoint.
    • exportToJson

      public String exportToJson()
      Exports this report into the standard JSON format which is consistent across different SDKs.
      Returns:
      the report encoded as JSON.
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object