HealthCheckedEndpointGroupBuilder (filter-service-metrics 1.13 1.13 API)

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

public final class HealthCheckedEndpointGroupBuilder
extends AbstractHealthCheckedEndpointGroupBuilder

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

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`HealthCheckedEndpointGroupBuilder`	`clientFactory(ClientFactory clientFactory)` Sets the `ClientFactory` to use when making health check requests.
`HealthCheckedEndpointGroupBuilder`	`clientOptions(ClientOptions options)` Sets the `ClientOptions` of the `Client` that sends health check requests.
`HealthCheckedEndpointGroupBuilder`	`healthCheckPort(int port)` Deprecated.
`HealthCheckedEndpointGroupBuilder`	`maxEndpointCount(int maxEndpointCount)` Sets the maximum endpoint count of target selected candidates.
`HealthCheckedEndpointGroupBuilder`	`maxEndpointRatio(double maxEndpointRatio)` Sets the maximum endpoint ratio of target selected candidates.
`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`	`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.
`HealthCheckedEndpointGroupBuilder`	`protocol(SessionProtocol protocol)` Sets the `SessionProtocol` to be used when making health check requests.
`HealthCheckedEndpointGroupBuilder`	`retryBackoff(Backoff retryBackoff)` Sets the backoff between health check requests.
`HealthCheckedEndpointGroupBuilder`	`retryInterval(Duration retryInterval)` Sets the interval between health check requests.
`HealthCheckedEndpointGroupBuilder`	`useGet(boolean useGet)` Sets whether to use HTTP `GET` method instead of `HEAD` when sending a health check request.
`HealthCheckedEndpointGroupBuilder`	`withClientOptions(Function<? super ClientOptionsBuilder,ClientOptionsBuilder> configurator)` Sets the `Function` that customizes a `Client` that sends health check requests.

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

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

- Method Detail
  - 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.
  - clientFactory
```
public HealthCheckedEndpointGroupBuilder clientFactory(ClientFactory clientFactory)
```
    Description copied from class: AbstractHealthCheckedEndpointGroupBuilder
    
    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.
    
    Overrides:
    
    clientFactory in class AbstractHealthCheckedEndpointGroupBuilder
  - protocol
```
public HealthCheckedEndpointGroupBuilder protocol(SessionProtocol protocol)
```
    Description copied from class: AbstractHealthCheckedEndpointGroupBuilder
    
    Sets the SessionProtocol to be used when making health check requests.
    
    Overrides:
    
    protocol in class AbstractHealthCheckedEndpointGroupBuilder
  - healthCheckPort
```
@Deprecated
public HealthCheckedEndpointGroupBuilder healthCheckPort(int port)
```
    Deprecated.
    
    Description copied from class: AbstractHealthCheckedEndpointGroupBuilder
    
    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.
    
    Overrides:
    
    healthCheckPort in class AbstractHealthCheckedEndpointGroupBuilder
  - port
```
public HealthCheckedEndpointGroupBuilder port(int port)
```
    Description copied from class: AbstractHealthCheckedEndpointGroupBuilder
    
    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.
    
    Overrides:
    
    port in class AbstractHealthCheckedEndpointGroupBuilder
  - retryInterval
```
public HealthCheckedEndpointGroupBuilder retryInterval(Duration retryInterval)
```
    Description copied from class: AbstractHealthCheckedEndpointGroupBuilder
    
    Sets the interval between health check requests. Must be positive.
    
    Overrides:
    
    retryInterval in class AbstractHealthCheckedEndpointGroupBuilder
  - retryBackoff
```
public HealthCheckedEndpointGroupBuilder retryBackoff(Backoff retryBackoff)
```
    Description copied from class: AbstractHealthCheckedEndpointGroupBuilder
    
    Sets the backoff between health check requests.
    
    Overrides:
    
    retryBackoff in class AbstractHealthCheckedEndpointGroupBuilder
  - clientOptions
```
public HealthCheckedEndpointGroupBuilder clientOptions(ClientOptions options)
```
    Description copied from class: AbstractHealthCheckedEndpointGroupBuilder
    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());
 
```
    Overrides:
    
    clientOptions in class AbstractHealthCheckedEndpointGroupBuilder
  - withClientOptions
```
public HealthCheckedEndpointGroupBuilder withClientOptions(Function<? super ClientOptionsBuilder,ClientOptionsBuilder> configurator)
```
    Description copied from class: AbstractHealthCheckedEndpointGroupBuilder
    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));
 });
 
```
    Overrides:
    
    withClientOptions in class AbstractHealthCheckedEndpointGroupBuilder
  - 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). 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
  - maxEndpointRatio
```
public HealthCheckedEndpointGroupBuilder maxEndpointRatio(double maxEndpointRatio)
```
    Description copied from class: AbstractHealthCheckedEndpointGroupBuilder
    
    Sets the maximum endpoint ratio of target selected candidates.
    
    Overrides:
    
    maxEndpointRatio in class AbstractHealthCheckedEndpointGroupBuilder
    
    See Also:
    
    PartialHealthCheckStrategyBuilder.maxEndpointRatio(double)
  - maxEndpointCount
```
public HealthCheckedEndpointGroupBuilder maxEndpointCount(int maxEndpointCount)
```
    Description copied from class: AbstractHealthCheckedEndpointGroupBuilder
    
    Sets the maximum endpoint count of target selected candidates.
    
    Overrides:
    
    maxEndpointCount in class AbstractHealthCheckedEndpointGroupBuilder
    
    See Also:
    
    PartialHealthCheckStrategyBuilder.maxEndpointCount(int)

Class HealthCheckedEndpointGroupBuilder

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

useGet

clientFactory

protocol

healthCheckPort

port

retryInterval

retryBackoff

clientOptions

withClientOptions

newCheckerFactory

maxEndpointRatio

maxEndpointCount