Package com.linecorp.armeria.client.consul

Class ConsulEndpointGroupBuilder

java.lang.Object

com.linecorp.armeria.client.endpoint.AbstractDynamicEndpointGroupBuilder

com.linecorp.armeria.client.consul.ConsulEndpointGroupBuilder

All Implemented Interfaces:

DynamicEndpointGroupSetters, ConsulConfigSetters

@UnstableApi
public final class ConsulEndpointGroupBuilder
extends AbstractDynamicEndpointGroupBuilder
implements ConsulConfigSetters

A builder class for ConsulEndpointGroup.

Examples

 ConsulEndpointGroup endpointGroup = ConsulEndpointGroup.builder(consulUri, "myService")
                                                        .build();
 List<Endpoint> endpoints = endpointGroup.endpoints();
 sb.serverListener(listener);
 

Method Summary

Modifier and Type	Method	Description
ConsulEndpointGroupBuilder	allowEmptyEndpoints(boolean allowEmptyEndpoints)	Sets whether to allow an empty Endpoint list.
ConsulEndpointGroup	build()	Returns a newly-created ConsulEndpointGroup.
ConsulEndpointGroupBuilder	consulApiVersion(String consulApiVersion)	Sets the specified Consul's API version.
ConsulEndpointGroupBuilder	consulToken(String consulToken)	Sets the specified token for Consul's API.
ConsulEndpointGroupBuilder	datacenter(String datacenter)	Sets which datacenter to query.
ConsulEndpointGroupBuilder	filter(String filter)	Filters the endpoints using the Consul filter.
ConsulEndpointGroupBuilder	registryFetchInterval(Duration registryFetchInterval)	Sets the interval between fetching registry requests.
ConsulEndpointGroupBuilder	registryFetchIntervalMillis(long registryFetchIntervalMillis)	Sets the interval between fetching registry requests in milliseconds.
ConsulEndpointGroupBuilder	selectionStrategy(EndpointSelectionStrategy selectionStrategy)	Sets the EndpointSelectionStrategy of the ConsulEndpointGroup.
ConsulEndpointGroupBuilder	selectionTimeout(Duration selectionTimeout)	Sets the timeout to wait until a successful Endpoint selection.
ConsulEndpointGroupBuilder	selectionTimeoutMillis(long selectionTimeoutMillis)	Sets the timeout to wait until a successful Endpoint selection.
ConsulEndpointGroupBuilder	useHealthEndpoints(boolean useHealthyEndpoints)	Sets whether to use Health HTTP endpoint.

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

selectionTimeoutMillis, shouldAllowEmptyEndpoints

Methods inherited from class java.lang.Object

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

Method Details

selectionStrategy

public ConsulEndpointGroupBuilder selectionStrategy(EndpointSelectionStrategy selectionStrategy)

Sets the EndpointSelectionStrategy of the ConsulEndpointGroup.

registryFetchInterval

public ConsulEndpointGroupBuilder registryFetchInterval(Duration registryFetchInterval)

Sets the interval between fetching registry requests. If not set, 10000L milliseconds is used by default.

registryFetchIntervalMillis

public ConsulEndpointGroupBuilder registryFetchIntervalMillis(long registryFetchIntervalMillis)

Sets the interval between fetching registry requests in milliseconds. If not set, 10000L is used by default.

useHealthEndpoints

public ConsulEndpointGroupBuilder useHealthEndpoints(boolean useHealthyEndpoints)

Sets whether to use Health HTTP endpoint. Make sure that your target endpoints are health-checked by Consul before enabling this feature.

See Also:

• ConsulUpdatingListenerBuilder.checkUri(URI)

datacenter

public ConsulEndpointGroupBuilder datacenter(String datacenter)

Sets which datacenter to query. If not set, the datacenter of the local agent is used by default.

filter

public ConsulEndpointGroupBuilder filter(String filter)

Filters the endpoints using the Consul filter. If not set, all endpoints are returned.

consulApiVersion

public ConsulEndpointGroupBuilder consulApiVersion(String consulApiVersion)

Description copied from interface: ConsulConfigSetters

Sets the specified Consul's API version.

Specified by:

consulApiVersion in interface ConsulConfigSetters

Parameters:

consulApiVersion - the version of Consul API service, default: "v1"

consulToken

public ConsulEndpointGroupBuilder consulToken(String consulToken)

Description copied from interface: ConsulConfigSetters

Sets the specified token for Consul's API.

Specified by:

consulToken in interface ConsulConfigSetters

Parameters:

consulToken - the token for accessing Consul API, default: null

build

public ConsulEndpointGroup build()

Returns a newly-created ConsulEndpointGroup.

allowEmptyEndpoints

public ConsulEndpointGroupBuilder allowEmptyEndpoints(boolean allowEmptyEndpoints)

Description copied from interface: DynamicEndpointGroupSetters

Sets whether to allow an empty Endpoint list. If unspecified, an empty Endpoint list is allowed.

Specified by:

allowEmptyEndpoints in interface DynamicEndpointGroupSetters

Overrides:

allowEmptyEndpoints in class AbstractDynamicEndpointGroupBuilder

selectionTimeout

public ConsulEndpointGroupBuilder selectionTimeout(Duration selectionTimeout)

Sets the timeout to wait until a successful Endpoint selection. Duration.ZERO disables the timeout. If unspecified, Flags.defaultResponseTimeoutMillis() is used by default.

Specified by:

selectionTimeout in interface DynamicEndpointGroupSetters

Overrides:

selectionTimeout in class AbstractDynamicEndpointGroupBuilder

selectionTimeoutMillis

public ConsulEndpointGroupBuilder selectionTimeoutMillis(long selectionTimeoutMillis)

Sets the timeout to wait until a successful Endpoint selection. 0 disables the timeout. If unspecified, Flags.defaultResponseTimeoutMillis() is used by default.

Specified by:

selectionTimeoutMillis in interface DynamicEndpointGroupSetters

Overrides:

selectionTimeoutMillis in class AbstractDynamicEndpointGroupBuilder