AbstractHealthCheckedEndpointGroupBuilder (filter-service-metrics 1.13 1.13 API)

java.lang.Object
- com.linecorp.armeria.client.endpoint.healthcheck.AbstractHealthCheckedEndpointGroupBuilder

Direct Known Subclasses:

HealthCheckedEndpointGroupBuilder
```
public abstract class AbstractHealthCheckedEndpointGroupBuilder
extends Object
```
A skeletal builder implementation for creating a new HealthCheckedEndpointGroup.

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractHealthCheckedEndpointGroupBuilder(EndpointGroup delegate)
Creates a new AbstractHealthCheckedEndpointGroupBuilder.

Constructors
Modifier	Constructor and Description
`protected`	`AbstractHealthCheckedEndpointGroupBuilder(EndpointGroup delegate)` Creates a new `AbstractHealthCheckedEndpointGroupBuilder`.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`HealthCheckedEndpointGroup`	`build()` Returns a newly created `HealthCheckedEndpointGroup` based on the properties set so far.
`AbstractHealthCheckedEndpointGroupBuilder`	`clientFactory(ClientFactory clientFactory)` Sets the `ClientFactory` to use when making health check requests.
`AbstractHealthCheckedEndpointGroupBuilder`	`clientOptions(ClientOptions clientOptions)` Sets the `ClientOptions` of the `Client` that sends health check requests.
`AbstractHealthCheckedEndpointGroupBuilder`	`healthCheckPort(int port)` Deprecated. Use `port(int)`.
`AbstractHealthCheckedEndpointGroupBuilder`	`maxEndpointCount(int maxEndpointCount)` Sets the maximum endpoint count of target selected candidates.
`AbstractHealthCheckedEndpointGroupBuilder`	`maxEndpointRatio(double maxEndpointRatio)` Sets the maximum endpoint ratio of target selected candidates.
`protected abstract 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.
`AbstractHealthCheckedEndpointGroupBuilder`	`port(int port)` Sets the port where a health check request will be sent instead of the original port number specified by `EndpointGroup`'s `Endpoint`s.
`AbstractHealthCheckedEndpointGroupBuilder`	`protocol(SessionProtocol protocol)` Sets the `SessionProtocol` to be used when making health check requests.
`AbstractHealthCheckedEndpointGroupBuilder`	`retryBackoff(Backoff retryBackoff)` Sets the backoff between health check requests.
`AbstractHealthCheckedEndpointGroupBuilder`	`retryInterval(Duration retryInterval)` Sets the interval between health check requests.
`AbstractHealthCheckedEndpointGroupBuilder`	`retryIntervalMillis(long retryIntervalMillis)` Sets the interval between health check requests in milliseconds.
`AbstractHealthCheckedEndpointGroupBuilder`	`withClientOptions(Function<? super ClientOptionsBuilder,ClientOptionsBuilder> configurator)` Sets the `Function` that customizes a `Client` that sends health check requests.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractHealthCheckedEndpointGroupBuilder
```
protected AbstractHealthCheckedEndpointGroupBuilder(EndpointGroup delegate)
```
    Creates a new AbstractHealthCheckedEndpointGroupBuilder.
    
    Parameters:
    
    delegate - the EndpointGroup which provides the candidate Endpoints
- Method Detail
  - clientFactory
```
public AbstractHealthCheckedEndpointGroupBuilder clientFactory(ClientFactory clientFactory)
```
    Sets the ClientFactory to use when making health check requests. This should generally be the same as the ClientFactory used when creating a Client stub using the EndpointGroup.
  - protocol
```
public AbstractHealthCheckedEndpointGroupBuilder protocol(SessionProtocol protocol)
```
    Sets the SessionProtocol to be used when making health check requests.
  - healthCheckPort
```
@Deprecated
public AbstractHealthCheckedEndpointGroupBuilder healthCheckPort(int port)
```
    Deprecated. Use port(int).
    
    Sets the port where a health check request will be sent instead of the original port number specified by EndpointGroup's Endpoints. This property is useful when your server listens to health check requests on a different port.
  - port
```
public AbstractHealthCheckedEndpointGroupBuilder port(int port)
```
    Sets the port where a health check request will be sent instead of the original port number specified by EndpointGroup's Endpoints. This property is useful when your server listens to health check requests on a different port.
  - retryInterval
```
public AbstractHealthCheckedEndpointGroupBuilder retryInterval(Duration retryInterval)
```
    Sets the interval between health check requests. Must be positive.
  - retryIntervalMillis
```
public AbstractHealthCheckedEndpointGroupBuilder retryIntervalMillis(long retryIntervalMillis)
```
    Sets the interval between health check requests in milliseconds. Must be positive.
  - retryBackoff
```
public AbstractHealthCheckedEndpointGroupBuilder retryBackoff(Backoff retryBackoff)
```
    Sets the backoff between health check requests.
  - clientOptions
```
public AbstractHealthCheckedEndpointGroupBuilder clientOptions(ClientOptions clientOptions)
```
    Sets the ClientOptions of the Client that sends health check requests. This method can be useful if you already have an Armeria client and want to reuse its configuration, such as using the same decorators.
```
 WebClient myClient = ...;
 // Use the same settings and decorators with `myClient` when sending health check requests.
 builder.clientOptions(myClient.options());
 
```
  - withClientOptions
```
public AbstractHealthCheckedEndpointGroupBuilder withClientOptions(Function<? super ClientOptionsBuilder,ClientOptionsBuilder> configurator)
```
    Sets the Function that customizes a Client that sends health check requests.
```
 builder.withClientOptions(b -> {
     return b.setHttpHeader(HttpHeaders.AUTHORIZATION,
                            "bearer my-access-token")
             .responseTimeout(Duration.ofSeconds(3));
 });
 
```
  - maxEndpointRatio
```
public AbstractHealthCheckedEndpointGroupBuilder maxEndpointRatio(double maxEndpointRatio)
```
    Sets the maximum endpoint ratio of target selected candidates.
    
    See Also:
    
    PartialHealthCheckStrategyBuilder.maxEndpointRatio(double)
  - maxEndpointCount
```
public AbstractHealthCheckedEndpointGroupBuilder maxEndpointCount(int maxEndpointCount)
```
    Sets the maximum endpoint count of target selected candidates.
    
    See Also:
    
    PartialHealthCheckStrategyBuilder.maxEndpointCount(int)
  - build
```
public HealthCheckedEndpointGroup build()
```
    Returns a newly created HealthCheckedEndpointGroup based on the properties set so far.
  - newCheckerFactory
```
protected abstract 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. The Function must update the health of the Endpoint with a value between [0, 1] via HealthCheckerContext.updateHealth(double). HealthCheckedEndpointGroup will call AsyncCloseable.closeAsync() on the AsyncCloseable returned by the Function when it needs to stop sending health check requests.

Class AbstractHealthCheckedEndpointGroupBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractHealthCheckedEndpointGroupBuilder

Method Detail

clientFactory

protocol

healthCheckPort

port

retryInterval

retryIntervalMillis

retryBackoff

clientOptions

withClientOptions

maxEndpointRatio

maxEndpointCount

build

newCheckerFactory