com.linecorp.armeria.client

Interface ClientBuilderParams

All Known Subinterfaces:

WebClient

All Known Implementing Classes:

UserClient

public interface ClientBuilderParams

Provides the construction parameters of a client.

Method Summary

Modifier and Type	Method and Description
String	absolutePathRef() Returns the String that consists of path, query string and fragment.
Class<?>	clientType() Returns the type of the client.
EndpointGroup	endpointGroup() Returns the EndpointGroup of the client.
default ClientFactory	factory() Deprecated. Use options() to get ClientOption.FACTORY.
static ClientBuilderParams	of(Scheme scheme, EndpointGroup endpointGroup, String path, Class<?> type, ClientOptions options) Returns a newly created ClientBuilderParams from the specified properties.
static ClientBuilderParams	of(URI uri, Class<?> type, ClientOptions options) Returns a newly created ClientBuilderParams from the specified properties.
ClientOptions	options() Returns the options of the client.
Scheme	scheme() Returns the Scheme of the client.
URI	uri() Returns the endpoint URI of the client.

Method Detail

of

static ClientBuilderParams of(URI uri,
                              Class<?> type,
                              ClientOptions options)

Returns a newly created ClientBuilderParams from the specified properties.

of

static ClientBuilderParams of(Scheme scheme,
                              EndpointGroup endpointGroup,
                              String path,
                              Class<?> type,
                              ClientOptions options)

Returns a newly created ClientBuilderParams from the specified properties.

factory

@Deprecated
default ClientFactory factory()

Deprecated. Use options() to get ClientOption.FACTORY.

Returns the ClientFactory who created the client.

scheme

Scheme scheme()

Returns the Scheme of the client.

endpointGroup

EndpointGroup endpointGroup()

Returns the EndpointGroup of the client.

absolutePathRef

String absolutePathRef()

Returns the String that consists of path, query string and fragment.

uri

URI uri()

Returns the endpoint URI of the client.

clientType

Class<?> clientType()

Returns the type of the client.

options

ClientOptions options()

Returns the options of the client.