Package com.linecorp.armeria.client.endpoint.healthcheck

Class HealthCheckedEndpointGroupBuilder

java.lang.Object

com.linecorp.armeria.client.endpoint.AbstractDynamicEndpointGroupBuilder<HealthCheckedEndpointGroupBuilder>

com.linecorp.armeria.client.endpoint.healthcheck.AbstractHealthCheckedEndpointGroupBuilder<HealthCheckedEndpointGroupBuilder>

com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroupBuilder

All Implemented Interfaces:

DynamicEndpointGroupSetters<HealthCheckedEndpointGroupBuilder>

public final class HealthCheckedEndpointGroupBuilder
extends AbstractHealthCheckedEndpointGroupBuilder<HealthCheckedEndpointGroupBuilder>

A builder for creating a new HealthCheckedEndpointGroup that sends HTTP health check requests.

Method Summary

Modifier and Type	Method	Description
protected Function<? super HealthCheckerContext,? extends AsyncCloseable>	newCheckerFactory()	Returns the Function that starts to send health check requests to the Endpoint specified in a given HealthCheckerContext when invoked.
HealthCheckedEndpointGroupBuilder	useGet(boolean useGet)	Sets whether to use HTTP GET method instead of HEAD when sending a health check request.

Methods inherited from class com.linecorp.armeria.client.endpoint.healthcheck.AbstractHealthCheckedEndpointGroupBuilder

auth, build, clientFactory, clientOptions, maxEndpointCount, maxEndpointRatio, port, protocol, retryBackoff, retryInterval, retryIntervalMillis, selectionTimeout, selectionTimeout, selectionTimeoutMillis, selectionTimeoutMillis, withClientOptions

Methods inherited from class com.linecorp.armeria.client.endpoint.AbstractDynamicEndpointGroupBuilder

allowEmptyEndpoints, selectionTimeoutMillis, self, shouldAllowEmptyEndpoints

Methods inherited from class java.lang.Object

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

Method Details

useGet

public HealthCheckedEndpointGroupBuilder useGet(boolean useGet)

Sets whether to use HTTP GET method instead of HEAD when sending a health check request. By default, HEAD method is used. This can be useful when the health check requests are failing due to a bad request or an authorization failure and you want to learn why.

newCheckerFactory

protected Function<? super HealthCheckerContext,? extends AsyncCloseable> newCheckerFactory()

Description copied from class: AbstractHealthCheckedEndpointGroupBuilder

Returns the Function that starts to send health check requests to the Endpoint specified in a given HealthCheckerContext when invoked. The Function must update the health of the Endpoint with a value between [0, 1] via HealthCheckerContext.updateHealth(double, ClientRequestContext, ResponseHeaders, Throwable). HealthCheckedEndpointGroup will call AsyncCloseable.closeAsync() on the AsyncCloseable returned by the Function when it needs to stop sending health check requests.

Specified by:

newCheckerFactory in class AbstractHealthCheckedEndpointGroupBuilder<HealthCheckedEndpointGroupBuilder>