RequestOptions (Armeria 1.9.2 API reference)

@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`.
`long`	`maxResponseLength()`	Returns the maximum length of the received `Response`.
`static RequestOptions`	`of()`	Returns an empty `RequestOptions`.
`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.
`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.
- 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 disables this option and 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 disables this option and 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 disables this option and the maximum response length of a client will be used instead.
- attrs
  
  Map<AttributeKey<?>,Object> attrs()
  
  Returns the Map of all attributes this RequestOptions contains.