ClientOptions (filter-service-metrics 1.13 1.13 API)

java.lang.Object
- com.linecorp.armeria.common.util.AbstractOptions
- - com.linecorp.armeria.client.ClientOptions

public final class ClientOptions
extends AbstractOptions

A set of ClientOptions and their respective values.

Field Summary

Fields
Modifier and Type Field and Description

static ClientOptions DEFAULT
Deprecated.
Use of().

Fields
Modifier and Type	Field and Description
`static ClientOptions`	`DEFAULT` Deprecated. Use `of()`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Map<ClientOption<Object>,ClientOptionValue<Object>>`	`asMap()` Converts this `ClientOptions` to a `Map`.
`static ClientOptionsBuilder`	`builder()` Returns a newly created `ClientOptionsBuilder`.
`ClientDecoration`	`decoration()` Returns the `Function`s that decorate the components of a client.
`long`	`defaultMaxResponseLength()` Deprecated. Use `maxResponseLength()`.
`long`	`defaultResponseTimeoutMillis1()` Deprecated. Use `responseTimeoutMillis()`.
`long`	`defaultWriteTimeoutMillis()` Deprecated. Use `writeTimeoutMillis()`.
`Function<? super Endpoint,? extends EndpointGroup>`	`endpointRemapper()` Returns the `Function` that remaps a target `Endpoint` into an `EndpointGroup`.
`ClientFactory`	`factory()` Returns the `ClientFactory` used for creating a client.
`<T> T`	`get(ClientOption<T> option)` Returns the value of the specified `ClientOption`.
`<T> T`	`getOrElse(ClientOption<T> option, T defaultValue)` Returns the value of the specified `ClientOption`.
`<T> T`	`getOrNull(ClientOption<T> option)` Returns the value of the specified `ClientOption`.
`HttpHeaders`	`httpHeaders()` Returns the additional HTTP headers to send with requests.
`long`	`maxResponseLength()` Returns the maximum allowed length of a server response.
`static ClientOptions`	`of()` Returns the `ClientOptions` with the default options only.
`static ClientOptions`	`of(ClientOptions baseOptions, ClientOptions options)` Merges the specified two `ClientOptions` into one.
`static ClientOptions`	`of(ClientOptions baseOptions, ClientOptionValue<?>... options)` Merges the specified `ClientOptions` and `ClientOptionValue`s.
`static ClientOptions`	`of(ClientOptions baseOptions, Iterable<ClientOptionValue<?>> options)` Merges the specified `ClientOptions` and `ClientOptionValue`s.
`static ClientOptions`	`of(ClientOptionValue<?>... options)` Returns the `ClientOptions` with the specified `ClientOptionValue`s.
`static ClientOptions`	`of(Iterable<ClientOptionValue<?>> options)` Returns the `ClientOptions` with the specified `ClientOptionValue`s.
`Supplier<RequestId>`	`requestIdGenerator()` Returns the `Supplier` that generates a `RequestId`.
`long`	`responseTimeoutMillis()` Returns the timeout of a server reply to a client call.
`ClientOptionsBuilder`	`toBuilder()` Returns a new `ClientOptionsBuilder` created from this `ClientOptions`.
`long`	`writeTimeoutMillis()` Returns the timeout of a socket write.

Methods inherited from class com.linecorp.armeria.common.util.AbstractOptions
asMap0, get0, getOrElse0, getOrNull0, toString

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

- Field Detail
  - DEFAULT
```
@Deprecated
public static final ClientOptions DEFAULT
```
    Deprecated. Use of().
    
    The default ClientOptions.
- Method Detail
  - of
```
public static ClientOptions of()
```
    Returns the ClientOptions with the default options only.
  - of
```
public static ClientOptions of(ClientOptionValue<?>... options)
```
    Returns the ClientOptions with the specified ClientOptionValues.
  - of
```
public static ClientOptions of(Iterable<ClientOptionValue<?>> options)
```
    Returns the ClientOptions with the specified ClientOptionValues.
  - of
```
public static ClientOptions of(ClientOptions baseOptions,
                               ClientOptionValue<?>... options)
```
    Merges the specified ClientOptions and ClientOptionValues.
    
    Returns:
    
    the merged ClientOptions
  - of
```
public static ClientOptions of(ClientOptions baseOptions,
                               Iterable<ClientOptionValue<?>> options)
```
    Merges the specified ClientOptions and ClientOptionValues.
    
    Returns:
    
    the merged ClientOptions
  - of
```
public static ClientOptions of(ClientOptions baseOptions,
                               ClientOptions options)
```
    Merges the specified two ClientOptions into one.
    
    Returns:
    
    the merged ClientOptions
  - builder
```
public static ClientOptionsBuilder builder()
```
    Returns a newly created ClientOptionsBuilder.
  - get
```
public <T> T get(ClientOption<T> option)
```
    Returns the value of the specified ClientOption.
    
    Returns:
    
    the value of the specified ClientOption
    
    Throws:
    
    NoSuchElementException - if no value is set for the specified ClientOption.
  - getOrNull
```
public <T> T getOrNull(ClientOption<T> option)
```
    Returns the value of the specified ClientOption.
    
    Returns:
    
    the value of the ClientOption, or null if the specified ClientOption is not set.
  - getOrElse
```
public <T> T getOrElse(ClientOption<T> option,
                       T defaultValue)
```
    Returns the value of the specified ClientOption.
    
    Returns:
    
    the value of the ClientOption, or defaultValue if the specified ClientOption is not set.
  - asMap
```
public Map<ClientOption<Object>,ClientOptionValue<Object>> asMap()
```
    Converts this ClientOptions to a Map.
  - factory
```
public ClientFactory factory()
```
    Returns the ClientFactory used for creating a client.
  - defaultWriteTimeoutMillis
```
@Deprecated
public long defaultWriteTimeoutMillis()
```
    Deprecated. Use writeTimeoutMillis().
    
    Returns the timeout of a socket write.
  - writeTimeoutMillis
```
public long writeTimeoutMillis()
```
    Returns the timeout of a socket write.
  - defaultResponseTimeoutMillis1
```
@Deprecated
public long defaultResponseTimeoutMillis1()
```
    Deprecated. Use responseTimeoutMillis().
    
    Returns the timeout of a server reply to a client call.
  - responseTimeoutMillis
```
public long responseTimeoutMillis()
```
    Returns the timeout of a server reply to a client call.
  - defaultMaxResponseLength
```
@Deprecated
public long defaultMaxResponseLength()
```
    Deprecated. Use maxResponseLength().
    
    Returns the maximum allowed length of a server response.
  - maxResponseLength
```
public long maxResponseLength()
```
    Returns the maximum allowed length of a server response.
  - decoration
```
public ClientDecoration decoration()
```
    Returns the Functions that decorate the components of a client.
  - httpHeaders
```
public HttpHeaders httpHeaders()
```
    Returns the additional HTTP headers to send with requests. Used only when the underlying SessionProtocol is HTTP.
  - requestIdGenerator
```
public Supplier<RequestId> requestIdGenerator()
```
    Returns the Supplier that generates a RequestId.
  - endpointRemapper
```
public Function<? super Endpoint,? extends EndpointGroup> endpointRemapper()
```
    Returns the Function that remaps a target Endpoint into an EndpointGroup.
    
    See Also:
    
    ClientBuilder.endpointRemapper(Function)
  - toBuilder
```
public ClientOptionsBuilder toBuilder()
```
    Returns a new ClientOptionsBuilder created from this ClientOptions.

Class ClientOptions

Field Summary

Method Summary

Methods inherited from class com.linecorp.armeria.common.util.AbstractOptions

Methods inherited from class java.lang.Object

Field Detail

DEFAULT

Method Detail

of

of

of

of

of

of

builder

get

getOrNull

getOrElse

asMap

factory

defaultWriteTimeoutMillis

writeTimeoutMillis

defaultResponseTimeoutMillis1

responseTimeoutMillis

defaultMaxResponseLength

maxResponseLength

decoration

httpHeaders

requestIdGenerator

endpointRemapper

toBuilder