kotlin-client/com.couchbase.client.kotlin/Bucket/ping

ping

suspend fun ping(common: CommonOptions = CommonOptions.Default, services: Set<ServiceType> = emptySet(), reportId: String = UUID.randomUUID().toString()): PingResult
Content copied to clipboard

Pings services in the Couchbase cluster.

This operation performs I/O against services and endpoints to assess their health. If you do not wish to perform I/O, consider using [Cluster.diagnostics] instead.

Parameters

services

The services to ping, or an empty set to ping all services (the default).

reportId

An arbitrary ID to assign to the report.