ClientBuilder (filter-service-metrics 1.12 1.12 API)

java.lang.Object
- com.linecorp.armeria.client.ClientBuilder

```
public final class ClientBuilder
extends Object
```
Creates a new client that connects to the specified URI using the builder pattern. Use the factory methods in Clients if you do not have many options to override. If you are creating an WebClient, it is recommended to use the WebClientBuilder or factory methods in WebClient.
How are decorators and HTTP headers configured?

Unlike other options, when a user calls option(ClientOption, Object) or options() with a ClientOption.DECORATION or a ClientOption.HTTP_HEADERS, this builder will not simply replace the old option but merge the specified option into the previous option value. For example:
```
 ClientOptionsBuilder b = new ClientOptionsBuilder();
 b.option(ClientOption.HTTP_HEADERS, headersA);
 b.option(ClientOption.HTTP_HEADERS, headersB);
 b.option(ClientOption.DECORATION, decorationA);
 b.option(ClientOption.DECORATION, decorationB);

 ClientOptions opts = b.build();
 HttpHeaders httpHeaders = opts.httpHeaders();
 ClientDecoration decorations = opts.decoration();
 
```
httpHeaders will contain all HTTP headers of headersA and headersB. If headersA and headersB have the headers with the same name, the duplicate header in headerB will replace the one with the same name in headerA. Similarly, decorations will contain all decorators of decorationA and decorationB, but there will be no replacement but only addition.

Constructor Summary

Constructors
Constructor and Description
`ClientBuilder(Scheme scheme, Endpoint endpoint)` Creates a new `ClientBuilder` that builds the client that connects to the specified `Endpoint` with the `Scheme`.
`ClientBuilder(SessionProtocol protocol, Endpoint endpoint)` Creates a new `ClientBuilder` that builds the client that connects to the specified `Endpoint` with the `SessionProtocol`.
`ClientBuilder(String uri)` Creates a new `ClientBuilder` that builds the client that connects to the specified `uri`.
`ClientBuilder(String scheme, Endpoint endpoint)` Creates a new `ClientBuilder` that builds the client that connects to the specified `Endpoint` with the `scheme`.
`ClientBuilder(URI uri)` Creates a new `ClientBuilder` that builds the client that connects to the specified `URI`.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`B`	`addHttpHeader(CharSequence name, Object value)` Adds the specified HTTP header.
`B`	`addHttpHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> httpHeaders)` Adds the specified HTTP headers.
`<T> T`	`build(Class<T> clientType)` Returns a newly-created client which implements the specified `clientType`, based on the properties of this builder.
`B`	`contentPreview(int length)` Sets the `ContentPreviewerFactory` for creating a `ContentPreviewer` which produces the preview with the maximum `length` limit for a request and a response.
`B`	`contentPreview(int length, Charset defaultCharset)` Sets the `ContentPreviewerFactory` for creating a `ContentPreviewer` which produces the preview with the maximum `length` limit for a request and a response.
`B`	`contentPreviewerFactory(ContentPreviewerFactory factory)` Sets the `ContentPreviewerFactory` for a request and a response.
`B`	`decorator(DecoratingHttpClientFunction decorator)` Adds the specified HTTP-level `decorator`.
`B`	`decorator(Function<? super HttpClient,? extends HttpClient> decorator)` Adds the specified HTTP-level `decorator`.
`B`	`defaultMaxResponseLength(long maxResponseLength)` Deprecated. Use `maxResponseLength(long)`.
`B`	`defaultResponseTimeout(Duration responseTimeout)` Deprecated. Use `responseTimeout(Duration)`.
`B`	`defaultResponseTimeoutMillis(long responseTimeoutMillis)` Deprecated. Use `responseTimeoutMillis(long)`.
`B`	`defaultWriteTimeout(Duration writeTimeout)` Deprecated. Use `writeTimeout(Duration)`.
`B`	`defaultWriteTimeoutMillis(long writeTimeoutMillis)` Deprecated. Use `writeTimeoutMillis(long)`.
`ClientBuilder`	`factory(ClientFactory factory)` Sets the `ClientFactory` of the client.
`B`	`maxResponseLength(long maxResponseLength)` Sets the maximum allowed length of a server response in bytes.
`<T> B`	`option(ClientOption<T> option, T value)` Adds the specified `ClientOption` and its `value`.
`<T> B`	`option(ClientOptionValue<T> optionValue)` Adds the specified `ClientOptionValue`.
`B`	`options(ClientOptions options)` Adds the specified `ClientOptions`.
`B`	`options(ClientOptionValue<?>... options)` Adds the specified `ClientOptionValue`s.
`B`	`options(Iterable<ClientOptionValue<?>> options)` Adds the specified `ClientOptionValue`s.
`ClientBuilder`	`path(String path)` Sets the `path` of the client.
`B`	`requestContentPreviewerFactory(ContentPreviewerFactory factory)` Sets the `ContentPreviewerFactory` for a request.
`B`	`requestIdGenerator(Supplier<RequestId> requestIdGenerator)` Sets the `Supplier` that generates a `RequestId`.
`B`	`responseContentPreviewerFactory(ContentPreviewerFactory factory)` Sets the `ContentPreviewerFactory` for a response.
`B`	`responseTimeout(Duration responseTimeout)` Sets the timeout of a response.
`B`	`responseTimeoutMillis(long responseTimeoutMillis)` Sets the timeout of a response in milliseconds.
`B`	`rpcDecorator(DecoratingRpcClientFunction decorator)` Adds the specified RPC-level `decorator`.
`B`	`rpcDecorator(Function<? super RpcClient,? extends RpcClient> decorator)` Adds the specified RPC-level `decorator`.
`ClientBuilder`	`serializationFormat(SerializationFormat format)` Sets the `SerializationFormat` of the client.
`B`	`setHttpHeader(CharSequence name, Object value)` Sets the specified HTTP header.
`B`	`setHttpHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> httpHeaders)` Sets the specified HTTP headers.
`B`	`writeTimeout(Duration writeTimeout)` Sets the timeout of a socket write attempt.
`B`	`writeTimeoutMillis(long writeTimeoutMillis)` Sets the timeout of a socket write attempt in milliseconds.

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

- Constructor Detail
  - ClientBuilder
```
public ClientBuilder(String uri)
```
    Creates a new ClientBuilder that builds the client that connects to the specified uri.
  - ClientBuilder
```
public ClientBuilder(URI uri)
```
    Creates a new ClientBuilder that builds the client that connects to the specified URI.
  - ClientBuilder
```
public ClientBuilder(String scheme,
                     Endpoint endpoint)
```
    Creates a new ClientBuilder that builds the client that connects to the specified Endpoint with the scheme.
  - ClientBuilder
```
public ClientBuilder(Scheme scheme,
                     Endpoint endpoint)
```
    Creates a new ClientBuilder that builds the client that connects to the specified Endpoint with the Scheme.
  - ClientBuilder
```
public ClientBuilder(SessionProtocol protocol,
                     Endpoint endpoint)
```
    Creates a new ClientBuilder that builds the client that connects to the specified Endpoint with the SessionProtocol.
- Method Detail
  - factory
```
public ClientBuilder factory(ClientFactory factory)
```
    Sets the ClientFactory of the client. The default is ClientFactory.ofDefault().
  - path
```
public ClientBuilder path(String path)
```
    Sets the path of the client.
  - serializationFormat
```
public ClientBuilder serializationFormat(SerializationFormat format)
```
    Sets the SerializationFormat of the client. The default is SerializationFormat.NONE.
  - build
```
public <T> T build(Class<T> clientType)
```
    Returns a newly-created client which implements the specified clientType, based on the properties of this builder.
    
    Throws:
    
    IllegalArgumentException - if the scheme of the uri specified in ClientBuilder(String) or the specified clientType is unsupported for the scheme
  - options
```
public B options(ClientOptions options)
```
    Adds the specified ClientOptions.
  - options
```
public B options(ClientOptionValue<?>... options)
```
    Adds the specified ClientOptionValues.
  - options
```
public B options(Iterable<ClientOptionValue<?>> options)
```
    Adds the specified ClientOptionValues.
  - option
```
public <T> B option(ClientOption<T> option,
                    T value)
```
    Adds the specified ClientOption and its value.
  - option
```
public <T> B option(ClientOptionValue<T> optionValue)
```
    Adds the specified ClientOptionValue.
  - defaultWriteTimeout
```
@Deprecated
public B defaultWriteTimeout(Duration writeTimeout)
```
    Deprecated. Use writeTimeout(Duration).
    
    Sets the timeout of a socket write attempt.
    
    Parameters:
    
    writeTimeout - the timeout. 0 disables the timeout.
  - defaultWriteTimeoutMillis
```
@Deprecated
public B defaultWriteTimeoutMillis(long writeTimeoutMillis)
```
    Deprecated. Use writeTimeoutMillis(long).
    
    Sets the timeout of a socket write attempt in milliseconds.
    
    Parameters:
    
    writeTimeoutMillis - the timeout in milliseconds. 0 disables the timeout.
  - writeTimeout
```
public B writeTimeout(Duration writeTimeout)
```
    Sets the timeout of a socket write attempt.
    
    Parameters:
    
    writeTimeout - the timeout. 0 disables the timeout.
  - writeTimeoutMillis
```
public B writeTimeoutMillis(long writeTimeoutMillis)
```
    Sets the timeout of a socket write attempt in milliseconds.
    
    Parameters:
    
    writeTimeoutMillis - the timeout in milliseconds. 0 disables the timeout.
  - defaultResponseTimeout
```
@Deprecated
public B defaultResponseTimeout(Duration responseTimeout)
```
    Deprecated. Use responseTimeout(Duration).
    
    Sets the timeout of a response.
    
    Parameters:
    
    responseTimeout - the timeout. 0 disables the timeout.
  - defaultResponseTimeoutMillis
```
@Deprecated
public B defaultResponseTimeoutMillis(long responseTimeoutMillis)
```
    Deprecated. Use responseTimeoutMillis(long).
    
    Sets the timeout of a response in milliseconds.
    
    Parameters:
    
    responseTimeoutMillis - the timeout in milliseconds. 0 disables the timeout.
  - responseTimeout
```
public B responseTimeout(Duration responseTimeout)
```
    Sets the timeout of a response.
    
    Parameters:
    
    responseTimeout - the timeout. 0 disables the timeout.
  - responseTimeoutMillis
```
public B responseTimeoutMillis(long responseTimeoutMillis)
```
    Sets the timeout of a response in milliseconds.
    
    Parameters:
    
    responseTimeoutMillis - the timeout in milliseconds. 0 disables the timeout.
  - defaultMaxResponseLength
```
@Deprecated
public B defaultMaxResponseLength(long maxResponseLength)
```
    Deprecated. Use maxResponseLength(long).
    
    Sets the maximum allowed length of a server response in bytes.
    
    Parameters:
    
    maxResponseLength - the maximum length in bytes. 0 disables the limit.
  - maxResponseLength
```
public B maxResponseLength(long maxResponseLength)
```
    Sets the maximum allowed length of a server response in bytes.
    
    Parameters:
    
    maxResponseLength - the maximum length in bytes. 0 disables the limit.
  - requestContentPreviewerFactory
```
public B requestContentPreviewerFactory(ContentPreviewerFactory factory)
```
    Sets the ContentPreviewerFactory for a request.
  - responseContentPreviewerFactory
```
public B responseContentPreviewerFactory(ContentPreviewerFactory factory)
```
    Sets the ContentPreviewerFactory for a response.
  - contentPreviewerFactory
```
public B contentPreviewerFactory(ContentPreviewerFactory factory)
```
    Sets the ContentPreviewerFactory for a request and a response.
  - contentPreview
```
public B contentPreview(int length,
                        Charset defaultCharset)
```
    Sets the ContentPreviewerFactory for creating a ContentPreviewer which produces the preview with the maximum length limit for a request and a response. The previewer is enabled only if the content type of a request/response meets any of the following conditions:
    - when it matches text/* or application/x-www-form-urlencoded
    - when its charset has been specified
    - when its subtype is "xml" or "json"
    - when its subtype ends with "+xml" or "+json"
    Parameters:
    
    length - the maximum length of the preview
    
    defaultCharset - the default charset used when a charset is not specified in the "content-type" header
  - contentPreview
```
public B contentPreview(int length)
```
    Sets the ContentPreviewerFactory for creating a ContentPreviewer which produces the preview with the maximum length limit for a request and a response. The previewer is enabled only if the content type of a request/response meets any of the following conditions:
    - when it matches text/* or application/x-www-form-urlencoded
    - when its charset has been specified
    - when its subtype is "xml" or "json"
    - when its subtype ends with "+xml" or "+json"
    Parameters:
    
    length - the maximum length of the preview.
  - requestIdGenerator
```
public B requestIdGenerator(Supplier<RequestId> requestIdGenerator)
```
    Sets the Supplier that generates a RequestId.
  - decorator
```
public B decorator(Function<? super HttpClient,? extends HttpClient> decorator)
```
    Adds the specified HTTP-level decorator.
    
    Parameters:
    
    decorator - the Function that transforms an HttpClient to another
  - decorator
```
public B decorator(DecoratingHttpClientFunction decorator)
```
    Adds the specified HTTP-level decorator.
    
    Parameters:
    
    decorator - the DecoratingHttpClientFunction that intercepts an invocation
  - rpcDecorator
```
public B rpcDecorator(Function<? super RpcClient,? extends RpcClient> decorator)
```
    Adds the specified RPC-level decorator.
    
    Parameters:
    
    decorator - the Function that transforms an RpcClient to another
  - rpcDecorator
```
public B rpcDecorator(DecoratingRpcClientFunction decorator)
```
    Adds the specified RPC-level decorator.
    
    Parameters:
    
    decorator - the DecoratingRpcClientFunction that intercepts an invocation
  - addHttpHeader
```
public B addHttpHeader(CharSequence name,
                       Object value)
```
    Adds the specified HTTP header.
  - addHttpHeaders
```
public B addHttpHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> httpHeaders)
```
    Adds the specified HTTP headers.
  - setHttpHeader
```
public B setHttpHeader(CharSequence name,
                       Object value)
```
    Sets the specified HTTP header.
  - setHttpHeaders
```
public B setHttpHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> httpHeaders)
```
    Sets the specified HTTP headers.

Class ClientBuilder

How are decorators and HTTP headers configured?

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClientBuilder

ClientBuilder

ClientBuilder

ClientBuilder

ClientBuilder

Method Detail

factory

path

serializationFormat

build

options

options

options

option

option

defaultWriteTimeout

defaultWriteTimeoutMillis

writeTimeout

writeTimeoutMillis

defaultResponseTimeout

defaultResponseTimeoutMillis

responseTimeout

responseTimeoutMillis

defaultMaxResponseLength

maxResponseLength

requestContentPreviewerFactory

responseContentPreviewerFactory

contentPreviewerFactory

contentPreview

contentPreview

requestIdGenerator

decorator

decorator

rpcDecorator

rpcDecorator

addHttpHeader

addHttpHeaders

setHttpHeader

setHttpHeaders