Package com.linecorp.armeria.client.kubernetes.endpoints

Class KubernetesEndpointGroupBuilder

java.lang.Object

com.linecorp.armeria.client.endpoint.AbstractDynamicEndpointGroupBuilder

com.linecorp.armeria.client.kubernetes.endpoints.KubernetesEndpointGroupBuilder

All Implemented Interfaces:

DynamicEndpointGroupSetters

@UnstableApi
public final class KubernetesEndpointGroupBuilder
extends AbstractDynamicEndpointGroupBuilder

A builder for creating a new KubernetesEndpointGroup.

Method Summary

Modifier and Type	Method	Description
KubernetesEndpointGroupBuilder	allowEmptyEndpoints(boolean allowEmptyEndpoints)	Sets whether to allow an empty Endpoint list.
KubernetesEndpointGroup	build()	Returns a newly-created KubernetesEndpointGroup based on the properties of this builder.
KubernetesEndpointGroupBuilder	namespace(String namespace)	Sets the namespace of a Kubernetes cluster.
KubernetesEndpointGroupBuilder	nodeAddressFilter(Predicate<? super io.fabric8.kubernetes.api.model.NodeAddress> nodeAddressFilter)	Sets the Predicate to filter the addresses of a Kubernetes node.
KubernetesEndpointGroupBuilder	portName(String portName)	Sets the name of the port from which NodePort should be fetched from.
KubernetesEndpointGroupBuilder	selectionStrategy(EndpointSelectionStrategy selectionStrategy)	Sets the EndpointSelectionStrategy of the KubernetesEndpointGroupBuilder.
KubernetesEndpointGroupBuilder	selectionTimeout(Duration selectionTimeout)	Sets the timeout to wait until a successful Endpoint selection.
KubernetesEndpointGroupBuilder	selectionTimeoutMillis(long selectionTimeoutMillis)	Sets the timeout to wait until a successful Endpoint selection.
KubernetesEndpointGroupBuilder	serviceName(String serviceName)	Sets the target service name from which Endpoints should be fetched.

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

namespace

public KubernetesEndpointGroupBuilder namespace(String namespace)

Sets the namespace of a Kubernetes cluster.

serviceName

public KubernetesEndpointGroupBuilder serviceName(String serviceName)

Sets the target service name from which Endpoints should be fetched.

portName

public KubernetesEndpointGroupBuilder portName(String portName)

Sets the name of the port from which NodePort should be fetched from. If not set, the first node port will be used.

nodeAddressFilter

public KubernetesEndpointGroupBuilder nodeAddressFilter(Predicate<? super io.fabric8.kubernetes.api.model.NodeAddress> nodeAddressFilter)

Sets the Predicate to filter the addresses of a Kubernetes node. The first selected NodeAddress of a node will be used to create the Endpoint. If unspecified, the default is to select an InternalIP address that is not empty.

selectionStrategy

public KubernetesEndpointGroupBuilder selectionStrategy(EndpointSelectionStrategy selectionStrategy)

Sets the EndpointSelectionStrategy of the KubernetesEndpointGroupBuilder.

allowEmptyEndpoints

public KubernetesEndpointGroupBuilder allowEmptyEndpoints(boolean allowEmptyEndpoints)

Sets whether to allow an empty Endpoint list. If unspecified, the default is false that disallows an empty Endpoint list.

Specified by:

allowEmptyEndpoints in interface DynamicEndpointGroupSetters

Overrides:

allowEmptyEndpoints in class AbstractDynamicEndpointGroupBuilder

selectionTimeout

public KubernetesEndpointGroupBuilder selectionTimeout(Duration selectionTimeout)

Description copied from interface: DynamicEndpointGroupSetters

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

Specified by:

selectionTimeout in interface DynamicEndpointGroupSetters

Overrides:

selectionTimeout in class AbstractDynamicEndpointGroupBuilder

selectionTimeoutMillis

public KubernetesEndpointGroupBuilder selectionTimeoutMillis(long selectionTimeoutMillis)

Description copied from interface: DynamicEndpointGroupSetters

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

Specified by:

selectionTimeoutMillis in interface DynamicEndpointGroupSetters

Overrides:

selectionTimeoutMillis in class AbstractDynamicEndpointGroupBuilder

build

public KubernetesEndpointGroup build()

Returns a newly-created KubernetesEndpointGroup based on the properties of this builder.