Package com.linecorp.armeria.client

Class WebClientRequestPreparation

java.lang.Object

com.linecorp.armeria.common.AbstractHttpMessageBuilder

com.linecorp.armeria.common.AbstractHttpRequestBuilder

com.linecorp.armeria.client.WebClientRequestPreparation

All Implemented Interfaces:

RequestOptionsSetters, RequestPreparationSetters, HttpMessageSetters, HttpRequestSetters, PathAndQueryParamSetters, RequestMethodSetters

public final class WebClientRequestPreparation
extends AbstractHttpRequestBuilder

Prepares and executes a new HttpRequest for WebClient.

Method Summary

Modifier and Type	Method	Description
<T> TransformingRequestPreparation<HttpResponse,T>	as(ResponseAs<HttpResponse,T> responseAs)	Sets the specified ResponseAs that converts the HttpResponse into another.
FutureTransformingRequestPreparation<ResponseEntity<byte[]>>	asBytes()	Converts the content of the HttpResponse into bytes.
<T> FutureTransformingRequestPreparation<ResponseEntity<T>>	asEntity(FutureResponseAs<ResponseEntity<T>> responseAs)	Sets the specified ResponseAs that converts the HttpResponse into a ResponseEntity.
FutureTransformingRequestPreparation<ResponseEntity<Path>>	asFile(File file)	Writes the content of the HttpResponse to the File.
FutureTransformingRequestPreparation<ResponseEntity<Path>>	asFile(Path path)	Writes the content of the HttpResponse to the Path.
<T> FutureTransformingRequestPreparation<ResponseEntity<T>>	asJson(TypeReference<? extends T> typeRef)	Deserializes the JSON content of the HttpResponse into the specified Java type using the default ObjectMapper.
<T> FutureTransformingRequestPreparation<ResponseEntity<T>>	asJson(TypeReference<? extends T> typeRef, ObjectMapper mapper)	Deserializes the JSON content of the HttpResponse into the specified Java type using the specified ObjectMapper.
<T> FutureTransformingRequestPreparation<ResponseEntity<T>>	asJson(Class<? extends T> clazz)	Deserializes the JSON content of the HttpResponse into the specified non-container type using the default ObjectMapper.
<T> FutureTransformingRequestPreparation<ResponseEntity<T>>	asJson(Class<? extends T> clazz, ObjectMapper mapper)	Deserializes the JSON content of the HttpResponse into the specified non-container type using the specified ObjectMapper.
FutureTransformingRequestPreparation<ResponseEntity<String>>	asString()	Converts the content of the HttpResponse into a String.
<V> WebClientRequestPreparation	attr(AttributeKey<V> key, V value)	Associates the specified value with the given AttributeKey in this request.
WebClientRequestPreparation	content(MediaType contentType, byte[] content)	Sets the content for this message.
WebClientRequestPreparation	content(MediaType contentType, HttpData content)	Sets the content for this message.
WebClientRequestPreparation	content(MediaType contentType, CharSequence content)	Sets the content for this message.
WebClientRequestPreparation	content(MediaType contentType, String content)	Sets the content for this message.
WebClientRequestPreparation	content(MediaType contentType, String format, Object... content)	Sets the content for this message.
WebClientRequestPreparation	content(MediaType contentType, org.reactivestreams.Publisher<? extends HttpData> publisher)	Sets the Publisher for this message.
WebClientRequestPreparation	content(String content)	Sets the content as UTF-8 for this message.
WebClientRequestPreparation	content(String format, Object... content)	Sets the content as UTF-8 for this message.
WebClientRequestPreparation	contentJson(Object content)	Sets the content for this message.
WebClientRequestPreparation	cookie(Cookie cookie)	Sets a cookie for this request.
WebClientRequestPreparation	cookies(Iterable<? extends Cookie> cookies)	Sets multiple cookies for this request.
WebClientRequestPreparation	delete(String path)	Sets DELETE method and path.
WebClientRequestPreparation	disablePathParams()	Disables path parameters substitution.
WebClientRequestPreparation	exchangeType(ExchangeType exchangeType)	Sets the ExchangeType that determines whether to stream an HttpRequest or HttpResponse.
HttpResponse	execute()
WebClientRequestPreparation	get(String path)	Sets GET method and path.
WebClientRequestPreparation	head(String path)	Sets HEAD method and path.
WebClientRequestPreparation	header(CharSequence name, Object value)	Adds a header for this message.
WebClientRequestPreparation	headers(Iterable<? extends Map.Entry<? extends CharSequence,String>> headers)	Adds multiple headers for this message.
WebClientRequestPreparation	maxResponseLength(long maxResponseLength)	Sets the maximum allowed length of a server response in bytes.
WebClientRequestPreparation	method(HttpMethod method)	Sets the method for this request.
WebClientRequestPreparation	options(String path)	Sets OPTIONS method and path.
WebClientRequestPreparation	patch(String path)	Sets PATCH method and path.
WebClientRequestPreparation	path(String path)	Sets the path for this request.
WebClientRequestPreparation	pathParam(String name, Object value)	Sets a path param for this request.
WebClientRequestPreparation	pathParams(Map<String,?> pathParams)	Sets multiple path params for this request.
WebClientRequestPreparation	post(String path)	Sets POST method and path.
WebClientRequestPreparation	put(String path)	Sets PUT method and path.
WebClientRequestPreparation	queryParam(String name, Object value)	Adds a query param for this request.
WebClientRequestPreparation	queryParams(Iterable<? extends Map.Entry<? extends String,String>> queryParams)	Adds multiple query params for this request.
WebClientRequestPreparation	requestAutoAbortDelay(Duration delay)	Sets the amount of time to wait before aborting an HttpRequest when its corresponding HttpResponse is complete.
WebClientRequestPreparation	requestAutoAbortDelayMillis(long delayMillis)	Sets the amount of time in millis to wait before aborting an HttpRequest when its corresponding HttpResponse is complete.
WebClientRequestPreparation	requestOptions(RequestOptions requestOptions)	Sets the specified RequestOptions that could overwrite the previously configured values such as RequestOptionsSetters.responseTimeout(Duration), RequestOptionsSetters.writeTimeout(Duration), RequestOptionsSetters.maxResponseLength(long) and RequestOptionsSetters.attr(AttributeKey, Object).
WebClientRequestPreparation	responseTimeout(Duration responseTimeout)	Schedules the response timeout that is triggered when the Response is not fully received within the specified Duration since the Response started or Request was fully sent.
WebClientRequestPreparation	responseTimeoutMillis(long responseTimeoutMillis)	Schedules the response timeout that is triggered when the Response is not fully received within the specified responseTimeoutMillis since the Response started or Request was fully sent.
WebClientRequestPreparation	trace(String path)	Sets TRACE method and path.
WebClientRequestPreparation	trailers(Iterable<? extends Map.Entry<? extends CharSequence,String>> trailers)	Adds HTTP trailers for this message.
WebClientRequestPreparation	writeTimeout(Duration writeTimeout)	Sets the amount of time allowed until the initial write attempt of the current Request succeeds.
WebClientRequestPreparation	writeTimeoutMillis(long writeTimeoutMillis)	Sets the amount of time allowed until the initial write attempt of the current Request succeeds.

Methods inherited from class com.linecorp.armeria.common.AbstractHttpRequestBuilder

buildRequest

Methods inherited from class com.linecorp.armeria.common.AbstractHttpMessageBuilder

publisher, trailer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.linecorp.armeria.common.HttpMessageSetters

trailer

Method Details

execute

public HttpResponse execute()

as

@UnstableApi
public <T>
TransformingRequestPreparation<HttpResponse,T> as(ResponseAs<HttpResponse,T> responseAs)

Sets the specified ResponseAs that converts the HttpResponse into another.

asEntity

@UnstableApi
public <T>
FutureTransformingRequestPreparation<ResponseEntity<T>> asEntity(FutureResponseAs<ResponseEntity<T>> responseAs)

Sets the specified ResponseAs that converts the HttpResponse into a ResponseEntity.

asBytes

@UnstableApi
public FutureTransformingRequestPreparation<ResponseEntity<byte[]>> asBytes()

Converts the content of the HttpResponse into bytes. For example:

 WebClient client = WebClient.of("https://api.example.com");
 CompletableFuture<ResponseEntity<byte[]>> response =
     client.prepare()
           .get("/v1/items/1")
           .asBytes()
           .execute();
 

asString

@UnstableApi
public FutureTransformingRequestPreparation<ResponseEntity<String>> asString()

Converts the content of the HttpResponse into a String. For example:

 WebClient client = WebClient.of("https://api.example.com");
 CompletableFuture<ResponseEntity<String>> response =
     client.prepare()
           .get("/v1/items/1")
           .asString()
           .execute();
 

asFile

@UnstableApi
public FutureTransformingRequestPreparation<ResponseEntity<Path>> asFile(Path path)

Writes the content of the HttpResponse to the Path. For example:

 WebClient client = WebClient.of("https://api.example.com");
 CompletableFuture<ResponseEntity<Path>> response =
     client.prepare()
           .get("/v1/items/1")
           .asFile(Paths.get("..."))
           .execute();
 

asFile

@UnstableApi
public FutureTransformingRequestPreparation<ResponseEntity<Path>> asFile(File file)

Writes the content of the HttpResponse to the File. For example:

 WebClient client = WebClient.of("https://api.example.com");
 CompletableFuture<ResponseEntity<File>> response =
     client.prepare()
           .get("/v1/items/1")
           .asFile(new File("..."))
           .execute();
 

asJson

@UnstableApi
public <T>
FutureTransformingRequestPreparation<ResponseEntity<T>> asJson(Class<? extends T> clazz)

Deserializes the JSON content of the HttpResponse into the specified non-container type using the default ObjectMapper. For example:

 WebClient client = WebClient.of("https://api.example.com");
 CompletableFuture<ResponseEntity<MyObject>> response =
     client.prepare()
           .get("/v1/items/1")
           .asJson(MyObject.class)
           .execute();
 

Note that this method should NOT be used if the result type is a container such as Collection or Map. Use asJson(TypeReference) for the container type.

Throws:

InvalidHttpResponseException - if the HttpStatus of the response is not success or fails to decode the response body into the result type.

See Also:

• JacksonObjectMapperProvider

asJson

@UnstableApi
public <T>
FutureTransformingRequestPreparation<ResponseEntity<T>> asJson(Class<? extends T> clazz,
 ObjectMapper mapper)

Deserializes the JSON content of the HttpResponse into the specified non-container type using the specified ObjectMapper. For example:

 ObjectMapper mapper = ...;
 WebClient client = WebClient.of("https://api.example.com");
 CompletableFuture<ResponseEntity<MyObject>> response =
     client.prepare()
           .get("/v1/items/1")
           .asJson(MyObject.class, mapper)
           .execute();
 

Note that this method should NOT be used if the result type is a container such as Collection or Map. Use asJson(TypeReference, ObjectMapper) for the container type.

Throws:

InvalidHttpResponseException - if the HttpStatus of the response is not success or fails to decode the response body into the result type.

asJson

@UnstableApi
public <T>
FutureTransformingRequestPreparation<ResponseEntity<T>> asJson(TypeReference<? extends T> typeRef)

Deserializes the JSON content of the HttpResponse into the specified Java type using the default ObjectMapper. This method is useful when you want to deserialize the content into a container type such as List and Map. For example:

 WebClient client = WebClient.of("https://api.example.com");
 CompletableFuture<ResponseEntity<List<MyObject>>> response =
     client.prepare()
           .get("/v1/items/1")
           .asJson(new TypeReference<List<MyObject>> {})
           .execute();
 

Throws:

InvalidHttpResponseException - if the HttpStatus of the response is not success or fails to decode the response body into the result type.

See Also:

• JacksonObjectMapperProvider

asJson

@UnstableApi
public <T>
FutureTransformingRequestPreparation<ResponseEntity<T>> asJson(TypeReference<? extends T> typeRef,
 ObjectMapper mapper)

Deserializes the JSON content of the HttpResponse into the specified Java type using the specified ObjectMapper. This method is useful when you want to deserialize the content into a container type such as List and Map. For example:

 ObjectMapper mapper = ...;
 WebClient client = WebClient.of("https://api.example.com");
 CompletableFuture<ResponseEntity<List<MyObject>>> response =
     client.prepare()
           .get("/v1/items/1")
           .asJson(new TypeReference<List<MyObject>> {}, mapper)
           .execute();
 

Throws:

InvalidHttpResponseException - if the HttpStatus of the response is not success or fails to decode the response body into the result type.

requestOptions

public WebClientRequestPreparation requestOptions(RequestOptions requestOptions)

Description copied from interface: RequestPreparationSetters

Sets the specified RequestOptions that could overwrite the previously configured values such as RequestOptionsSetters.responseTimeout(Duration), RequestOptionsSetters.writeTimeout(Duration), RequestOptionsSetters.maxResponseLength(long) and RequestOptionsSetters.attr(AttributeKey, Object).

Specified by:

requestOptions in interface RequestPreparationSetters

responseTimeout

public WebClientRequestPreparation responseTimeout(Duration responseTimeout)

Description copied from interface: RequestOptionsSetters

Schedules the response timeout that is triggered when the Response is not fully received within the specified Duration since the Response started or Request was fully sent. Duration.ZERO disables the limit.

Specified by:

responseTimeout in interface RequestOptionsSetters

responseTimeoutMillis

public WebClientRequestPreparation responseTimeoutMillis(long responseTimeoutMillis)

Description copied from interface: RequestOptionsSetters

Schedules the response timeout that is triggered when the Response is not fully received within the specified responseTimeoutMillis since the Response started or Request was fully sent. 0 disables the limit.

Specified by:

responseTimeoutMillis in interface RequestOptionsSetters

writeTimeout

public WebClientRequestPreparation writeTimeout(Duration writeTimeout)

Description copied from interface: RequestOptionsSetters

Sets the amount of time allowed until the initial write attempt of the current Request succeeds. Duration.ZERO disables the limit.

Specified by:

writeTimeout in interface RequestOptionsSetters

writeTimeoutMillis

public WebClientRequestPreparation writeTimeoutMillis(long writeTimeoutMillis)

Description copied from interface: RequestOptionsSetters

Sets the amount of time allowed until the initial write attempt of the current Request succeeds. 0 disables the limit.

Specified by:

writeTimeoutMillis in interface RequestOptionsSetters

maxResponseLength

public WebClientRequestPreparation maxResponseLength(long maxResponseLength)

Description copied from interface: RequestOptionsSetters

Sets the maximum allowed length of a server response in bytes. 0 disables the limit.

Specified by:

maxResponseLength in interface RequestOptionsSetters

requestAutoAbortDelay

public WebClientRequestPreparation requestAutoAbortDelay(Duration delay)

Description copied from interface: RequestOptionsSetters

Sets the amount of time to wait before aborting an HttpRequest when its corresponding HttpResponse is complete. This may be useful when you want to send additional data even after the response is complete. Specify Duration.ZERO to abort the HttpRequest immediately. Any negative value will not abort the request automatically. There is no delay by default.

Specified by:

requestAutoAbortDelay in interface RequestOptionsSetters

requestAutoAbortDelayMillis

public WebClientRequestPreparation requestAutoAbortDelayMillis(long delayMillis)

Description copied from interface: RequestOptionsSetters

Sets the amount of time in millis to wait before aborting an HttpRequest when its corresponding HttpResponse is complete. This may be useful when you want to send additional data even after the response is complete. Specify 0 to abort the HttpRequest immediately. Any negative value will not abort the request automatically. There is no delay by default.

Specified by:

requestAutoAbortDelayMillis in interface RequestOptionsSetters

attr

public <V> WebClientRequestPreparation attr(AttributeKey<V> key,
 @Nullable
 V value)

Description copied from interface: RequestOptionsSetters

Associates the specified value with the given AttributeKey in this request. If this context previously contained a mapping for the AttributeKey, the old value is replaced by the specified value.

Specified by:

attr in interface RequestOptionsSetters

exchangeType

public WebClientRequestPreparation exchangeType(ExchangeType exchangeType)

Description copied from interface: RequestOptionsSetters

Sets the ExchangeType that determines whether to stream an HttpRequest or HttpResponse. Note that an HttpRequest will be aggregated before being written if ExchangeType.UNARY or ExchangeType.RESPONSE_STREAMING is set. If unspecified, the Clients try to infer a proper ExchangeType depending on the content type of a request and a response. Here are examples:

WebClient

 WebClient client = WebClient.of("https://armeria.dev");

 try (ClientRequestContextCaptor captor = Clients.newContextCaptor()) {
     client.prepare()
           .post("/api/v1/items")
           .contentJson(new Item(...)) // A non-streaming request type.
           .asString()                 // A non-streaming response type.
           .execute();
     assert captor.get().exchangeType() == ExchangeType.UNARY;
 }

 try (ClientRequestContextCaptor captor = Clients.newContextCaptor()) {
     client.get("/api/v1/items")   // A non-streaming request type.
           .aggregate();           // A return type is not specified; Assuming that response streaming
                                   // is enabled.
     assert captor.get().exchangeType() == ExchangeType.RESPONSE_STREAMING;
 }

 try (ClientRequestContextCaptor captor = Clients.newContextCaptor()) {
     client.prepare()
           .post("/api/v1/items")
           .content(MediaType.JSON_LINES, StreamMessage.of(...)) // A streaming request type.
           .asFile(Path.get("/path/to/destination"))             // A streaming response type.
           .execute();
     assert captor.get().exchangeType() == ExchangeType.BIDI_STREAMING;
 }
 

BlockingWebClient

Since a request and a response of BlockingWebClient are fully aggregated, ExchangeType.UNARY is only supported.

 try (ClientRequestContextCaptor captor = Clients.newContextCaptor()) {
     AggregatedHttpResponse response = client.blocking().get("/api/v1/items");
     assert captor.get().exchangeType() == ExchangeType.UNARY;
 }
 

gRPC clients

An ExchangeType is automatically inferred from the io.grpc.MethodDescriptor.MethodType.

 try (ClientRequestContextCaptor captor = Clients.newContextCaptor()) {
     Response response = grpcClient.unaryCall(...);
     assert captor.get().exchangeType() == ExchangeType.UNARY;
 }
 

Thrift clients

Thrift protocols do not support streaming. ExchangeType.UNARY is only supported.

Specified by:

exchangeType in interface RequestOptionsSetters

get

public WebClientRequestPreparation get(String path)

Description copied from interface: RequestMethodSetters

Sets GET method and path.

Specified by:

get in interface RequestMethodSetters

Overrides:

get in class AbstractHttpRequestBuilder

post

public WebClientRequestPreparation post(String path)

Description copied from interface: RequestMethodSetters

Sets POST method and path.

Specified by:

post in interface RequestMethodSetters

Overrides:

post in class AbstractHttpRequestBuilder

put

public WebClientRequestPreparation put(String path)

Description copied from interface: RequestMethodSetters

Sets PUT method and path.

Specified by:

put in interface RequestMethodSetters

Overrides:

put in class AbstractHttpRequestBuilder

delete

public WebClientRequestPreparation delete(String path)

Description copied from interface: RequestMethodSetters

Sets DELETE method and path.

Specified by:

delete in interface RequestMethodSetters

Overrides:

delete in class AbstractHttpRequestBuilder

patch

public WebClientRequestPreparation patch(String path)

Description copied from interface: RequestMethodSetters

Sets PATCH method and path.

Specified by:

patch in interface RequestMethodSetters

Overrides:

patch in class AbstractHttpRequestBuilder

options

public WebClientRequestPreparation options(String path)

Description copied from interface: RequestMethodSetters

Sets OPTIONS method and path.

Specified by:

options in interface RequestMethodSetters

Overrides:

options in class AbstractHttpRequestBuilder

head

public WebClientRequestPreparation head(String path)

Description copied from interface: RequestMethodSetters

Sets HEAD method and path.

Specified by:

head in interface RequestMethodSetters

Overrides:

head in class AbstractHttpRequestBuilder

trace

public WebClientRequestPreparation trace(String path)

Description copied from interface: RequestMethodSetters

Sets TRACE method and path.

Specified by:

trace in interface RequestMethodSetters

Overrides:

trace in class AbstractHttpRequestBuilder

method

public WebClientRequestPreparation method(HttpMethod method)

Description copied from interface: RequestMethodSetters

Sets the method for this request.

Specified by:

method in interface RequestMethodSetters

Overrides:

method in class AbstractHttpRequestBuilder

See Also:

• HttpMethod

path

public WebClientRequestPreparation path(String path)

Description copied from interface: RequestMethodSetters

Sets the path for this request.

Specified by:

path in interface RequestMethodSetters

Overrides:

path in class AbstractHttpRequestBuilder

content

public WebClientRequestPreparation content(String content)

Description copied from interface: HttpMessageSetters

Sets the content as UTF-8 for this message.

Specified by:

content in interface HttpMessageSetters

Specified by:

content in interface HttpRequestSetters

Overrides:

content in class AbstractHttpRequestBuilder

content

public WebClientRequestPreparation content(MediaType contentType,
 CharSequence content)

Description copied from interface: HttpMessageSetters

Sets the content for this message.

Specified by:

content in interface HttpMessageSetters

Specified by:

content in interface HttpRequestSetters

Overrides:

content in class AbstractHttpRequestBuilder

content

public WebClientRequestPreparation content(MediaType contentType,
 String content)

Description copied from interface: HttpMessageSetters

Sets the content for this message.

Specified by:

content in interface HttpMessageSetters

Specified by:

content in interface HttpRequestSetters

Overrides:

content in class AbstractHttpRequestBuilder

content

@FormatMethod
public WebClientRequestPreparation content(@FormatString
 String format,
 Object... content)

Description copied from interface: HttpMessageSetters

Sets the content as UTF-8 for this message. The content is formatted by String.format(Locale, String, Object...) with English locale.

Specified by:

content in interface HttpMessageSetters

Specified by:

content in interface HttpRequestSetters

Overrides:

content in class AbstractHttpRequestBuilder

content

@FormatMethod
public WebClientRequestPreparation content(MediaType contentType,
 @FormatString
 String format,
 Object... content)

Description copied from interface: HttpMessageSetters

Sets the content for this message. The content is formatted by String.format(Locale, String, Object...) with English locale.

Specified by:

content in interface HttpMessageSetters

Specified by:

content in interface HttpRequestSetters

Overrides:

content in class AbstractHttpRequestBuilder

content

public WebClientRequestPreparation content(MediaType contentType,
 byte[] content)

Description copied from interface: HttpMessageSetters

Sets the content for this message. The content will be wrapped using HttpData.wrap(byte[]), so any changes made to content will be reflected in the request.

Specified by:

content in interface HttpMessageSetters

Specified by:

content in interface HttpRequestSetters

Overrides:

content in class AbstractHttpRequestBuilder

content

public WebClientRequestPreparation content(MediaType contentType,
 HttpData content)

Description copied from interface: HttpMessageSetters

Sets the content for this message.

Specified by:

content in interface HttpMessageSetters

Specified by:

content in interface HttpRequestSetters

Overrides:

content in class AbstractHttpRequestBuilder

content

public WebClientRequestPreparation content(MediaType contentType,
 org.reactivestreams.Publisher<? extends HttpData> publisher)

Description copied from interface: HttpMessageSetters

Sets the Publisher for this message.

Specified by:

content in interface HttpMessageSetters

Specified by:

content in interface HttpRequestSetters

Overrides:

content in class AbstractHttpRequestBuilder

contentJson

public WebClientRequestPreparation contentJson(Object content)

Description copied from interface: HttpMessageSetters

Sets the content for this message. The content is converted into JSON format using the default ObjectMapper.

Specified by:

contentJson in interface HttpMessageSetters

Specified by:

contentJson in interface HttpRequestSetters

Overrides:

contentJson in class AbstractHttpRequestBuilder

header

public WebClientRequestPreparation header(CharSequence name,
 Object value)

Description copied from interface: HttpMessageSetters

Adds a header for this message.

Specified by:

header in interface HttpMessageSetters

Specified by:

header in interface HttpRequestSetters

Overrides:

header in class AbstractHttpRequestBuilder

headers

public WebClientRequestPreparation headers(Iterable<? extends Map.Entry<? extends CharSequence,String>> headers)

Description copied from interface: HttpMessageSetters

Adds multiple headers for this message.

Specified by:

headers in interface HttpMessageSetters

Specified by:

headers in interface HttpRequestSetters

Overrides:

headers in class AbstractHttpRequestBuilder

See Also:

• HttpHeaders

trailers

public WebClientRequestPreparation trailers(Iterable<? extends Map.Entry<? extends CharSequence,String>> trailers)

Description copied from interface: HttpMessageSetters

Adds HTTP trailers for this message.

Specified by:

trailers in interface HttpMessageSetters

Specified by:

trailers in interface HttpRequestSetters

Overrides:

trailers in class AbstractHttpRequestBuilder

pathParam

public WebClientRequestPreparation pathParam(String name,
 Object value)

Description copied from interface: HttpRequestSetters

Sets a path param for this request. For example:

 HttpRequest.builder()
            .get("/{foo}")
            .pathParam("foo", "bar")
            .build(); // GET `/bar`
 

Specified by:

pathParam in interface HttpRequestSetters

Specified by:

pathParam in interface PathAndQueryParamSetters

Overrides:

pathParam in class AbstractHttpRequestBuilder

pathParams

public WebClientRequestPreparation pathParams(Map<String,?> pathParams)

Description copied from interface: HttpRequestSetters

Sets multiple path params for this request. For example:

 HttpRequest.builder()
            .get("/{foo}/:bar")
            .pathParams(Map.of("foo", 1, "bar", 2))
            .build(); // GET `/1/2`
 

Specified by:

pathParams in interface HttpRequestSetters

Specified by:

pathParams in interface PathAndQueryParamSetters

Overrides:

pathParams in class AbstractHttpRequestBuilder

disablePathParams

public WebClientRequestPreparation disablePathParams()

Description copied from interface: HttpRequestSetters

Disables path parameters substitution. If path parameter is not disabled and a parameter's, specified using {} or :, value is not found, an IllegalStateException is thrown.

Specified by:

disablePathParams in interface HttpRequestSetters

Specified by:

disablePathParams in interface PathAndQueryParamSetters

Overrides:

disablePathParams in class AbstractHttpRequestBuilder

queryParam

public WebClientRequestPreparation queryParam(String name,
 Object value)

Description copied from interface: HttpRequestSetters

Adds a query param for this request. For example:

 HttpRequest.builder()
            .get("/endpoint")
            .queryParam("foo", "bar")
            .build(); // GET `/endpoint?foo=bar`
 

Specified by:

queryParam in interface HttpRequestSetters

Specified by:

queryParam in interface PathAndQueryParamSetters

Overrides:

queryParam in class AbstractHttpRequestBuilder

queryParams

public WebClientRequestPreparation queryParams(Iterable<? extends Map.Entry<? extends String,String>> queryParams)

Description copied from interface: HttpRequestSetters

Adds multiple query params for this request. For example:

 HttpRequest.builder()
            .get("/endpoint")
            .queryParams(QueryParams.of("from", "foo", "limit", 10))
            .build(); // GET `/endpoint?from=foo&limit=10`
 

Specified by:

queryParams in interface HttpRequestSetters

Specified by:

queryParams in interface PathAndQueryParamSetters

Overrides:

queryParams in class AbstractHttpRequestBuilder

See Also:

• QueryParams

cookie

public WebClientRequestPreparation cookie(Cookie cookie)

Description copied from interface: HttpRequestSetters

Sets a cookie for this request. For example:

 HttpRequest.builder()
            .get("/")
            .cookie(Cookie.ofSecure("cookie", "foo"))
            .build();
 

Specified by:

cookie in interface HttpMessageSetters

Specified by:

cookie in interface HttpRequestSetters

Overrides:

cookie in class AbstractHttpRequestBuilder

See Also:

• Cookie

cookies

public WebClientRequestPreparation cookies(Iterable<? extends Cookie> cookies)

Description copied from interface: HttpRequestSetters

Sets multiple cookies for this request. For example:

 HttpRequest.builder()
            .get("/")
            .cookies(Cookies.ofSecure(Cookie.ofSecure("cookie1", "foo"),
                                      Cookie.ofSecure("cookie2", "bar")))
            .build();
 

Specified by:

cookies in interface HttpMessageSetters

Specified by:

cookies in interface HttpRequestSetters

Overrides:

cookies in class AbstractHttpRequestBuilder

See Also:

• Cookies