Package com.linecorp.armeria.client

Interface RequestOptions

@UnstableApi
public interface RequestOptions

A RequestOptions for an HttpRequest.

Method Summary

Modifier and Type	Method	Description
Map<AttributeKey<?>,Object>	attrs()	Returns the Map of all attributes this RequestOptions contains.
static RequestOptionsBuilder	builder()	Returns a newly created RequestOptionsBuilder.
static RequestOptionsBuilder	builder(RequestOptions requestOptions)	Returns a newly created RequestOptionsBuilder with the specified RequestOptions.
@Nullable ExchangeType	exchangeType()	Returns the ExchangeType that determines whether to stream an HttpRequest or HttpResponse.
long	maxResponseLength()	Returns the maximum length of the received Response.
static RequestOptions	of()	Returns an empty RequestOptions.
@Nullable Long	requestAutoAbortDelayMillis()	Returns the amount of time to wait before aborting an HttpRequest when its corresponding HttpResponse is complete.
long	responseTimeoutMillis()	Returns the amount of time allowed until receiving the Response completely since the transfer of the Response started or the Request was fully sent.
default RequestOptionsBuilder	toBuilder()	Returns a new builder created from the properties of this RequestOptions.
long	writeTimeoutMillis()	Returns the amount of time allowed until the initial write attempt of the current Request succeeds.

Method Details

of

static RequestOptions of()

Returns an empty RequestOptions.

builder

static RequestOptionsBuilder builder()

Returns a newly created RequestOptionsBuilder.

builder

static RequestOptionsBuilder builder(RequestOptions requestOptions)

Returns a newly created RequestOptionsBuilder with the specified RequestOptions.

toBuilder

default RequestOptionsBuilder toBuilder()

Returns a new builder created from the properties of this RequestOptions.

responseTimeoutMillis

long responseTimeoutMillis()

Returns the amount of time allowed until receiving the Response completely since the transfer of the Response started or the Request was fully sent. 0 disables the limit. -1 means the response timeout of a client will be used instead.

writeTimeoutMillis

long writeTimeoutMillis()

Returns the amount of time allowed until the initial write attempt of the current Request succeeds. 0 disables the limit. -1 means the write timeout of a client will be used instead.

maxResponseLength

long maxResponseLength()

Returns the maximum length of the received Response. 0 disables the limit. -1 means the maximum response length of a client will be used instead.

requestAutoAbortDelayMillis

@Nullable
@Nullable Long requestAutoAbortDelayMillis()

Returns the amount of time to wait before aborting an HttpRequest when its corresponding HttpResponse is complete. null means the request auto abort delay of a client will be used instead.

attrs

Map<AttributeKey<?>,Object> attrs()

Returns the Map of all attributes this RequestOptions contains.

exchangeType

@Nullable
@Nullable ExchangeType exchangeType()

Returns the ExchangeType that determines whether to stream an HttpRequest or HttpResponse. ExchangeType.BIDI_STREAMING is assumed if this method returns null.

Note that an HttpRequest will be aggregated before being written if ExchangeType.UNARY or ExchangeType.RESPONSE_STREAMING is set.