Package com.couchbase.client.core.diagnostics

Class HealthPinger

java.lang.Object

com.couchbase.client.core.diagnostics.HealthPinger

@Internal
public class HealthPinger
extends Object

The HealthPinger allows to "ping" individual services with real operations for their health.

This can be used by up the stack code to assert the given state of a connected cluster and/or bucket.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HealthPinger.PingTarget

Constructor Summary

Constructors

Constructor	Description
HealthPinger()

Method Summary

Modifier and Type	Method	Description
static Mono<PingResult>	ping(Core core, Optional<Duration> timeout, RetryStrategy retryStrategy, Set<ServiceType> serviceTypes, Optional<String> reportId, boolean clusterLevel)	Performs a service ping against all or (if given) the services provided.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HealthPinger

public HealthPinger()

Method Detail

ping

@Internal
public static Mono<PingResult> ping(Core core,
                                    Optional<Duration> timeout,
                                    RetryStrategy retryStrategy,
                                    Set<ServiceType> serviceTypes,
                                    Optional<String> reportId,
                                    boolean clusterLevel)

Performs a service ping against all or (if given) the services provided.

Parameters:

core - the core instance against to check.

timeout - the timeout for each individual and total ping report.

retryStrategy - the retry strategy to use for each ping.

serviceTypes - if present, limits the queried services for the given types.

Returns:

a mono that completes once all pings have been completed as well.