org.springframework.web.reactive.function.client

Interface WebClient.RequestBodySpec

All Superinterfaces:

WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>

All Known Subinterfaces:

WebClient.RequestBodyUriSpec

Enclosing interface:

WebClient

public static interface WebClient.RequestBodySpec
extends WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>

Method Summary

Modifier and Type	Method and Description
WebClient.RequestHeadersSpec<?>	body(BodyInserter<?,? super ClientHttpRequest> inserter) Set the body of the request to the given BodyInserter.
<T,P extends org.reactivestreams.Publisher<T>> WebClient.RequestHeadersSpec<?>	body(P publisher, Class<T> elementClass) Set the body of the request to the given asynchronous Publisher.
<T,P extends org.reactivestreams.Publisher<T>> WebClient.RequestHeadersSpec<?>	body(P publisher, ParameterizedTypeReference<T> typeReference) Set the body of the request to the given asynchronous Publisher.
WebClient.RequestBodySpec	contentLength(long contentLength) Set the length of the body in bytes, as specified by the Content-Length header.
WebClient.RequestBodySpec	contentType(MediaType contentType) Set the media type of the body, as specified by the Content-Type header.
WebClient.RequestHeadersSpec<?>	syncBody(Object body) Set the body of the request to the given synchronous Object.

Methods inherited from interface org.springframework.web.reactive.function.client.WebClient.RequestHeadersSpec

accept, acceptCharset, attribute, attributes, cookie, cookies, exchange, header, headers, ifModifiedSince, ifNoneMatch, retrieve

Method Detail

contentLength

WebClient.RequestBodySpec contentLength(long contentLength)

Set the length of the body in bytes, as specified by the Content-Length header.

Parameters:

contentLength - the content length

Returns:

this builder

See Also:

HttpHeaders.setContentLength(long)

contentType

WebClient.RequestBodySpec contentType(MediaType contentType)

Set the media type of the body, as specified by the Content-Type header.

Parameters:

contentType - the content type

Returns:

this builder

See Also:

HttpHeaders.setContentType(MediaType)

body

WebClient.RequestHeadersSpec<?> body(BodyInserter<?,? super ClientHttpRequest> inserter)

Set the body of the request to the given BodyInserter.

Parameters:

inserter - the BodyInserter that writes to the request

Returns:

this builder

body

<T,P extends org.reactivestreams.Publisher<T>> WebClient.RequestHeadersSpec<?> body(P publisher,
                                                                                    ParameterizedTypeReference<T> typeReference)

Set the body of the request to the given asynchronous Publisher.

This method is a convenient shortcut for body(BodyInserter) with a BodyInserters.fromPublisher(P, java.lang.Class<T>) Publisher body inserter}.

Type Parameters:

T - the type of the elements contained in the publisher

P - the type of the Publisher

Parameters:

publisher - the Publisher to write to the request

typeReference - the type reference of elements contained in the publisher

Returns:

this builder

body

<T,P extends org.reactivestreams.Publisher<T>> WebClient.RequestHeadersSpec<?> body(P publisher,
                                                                                    Class<T> elementClass)

Set the body of the request to the given asynchronous Publisher.

This method is a convenient shortcut for body(BodyInserter) with a BodyInserters.fromPublisher(P, java.lang.Class<T>) Publisher body inserter}.

Type Parameters:

T - the type of the elements contained in the publisher

P - the type of the Publisher

Parameters:

publisher - the Publisher to write to the request

elementClass - the class of elements contained in the publisher

Returns:

this builder

syncBody

WebClient.RequestHeadersSpec<?> syncBody(Object body)

Set the body of the request to the given synchronous Object.

This method is a convenient shortcut for body(BodyInserter) with a Object body inserter.

Parameters:

body - the Object to write to the request

Returns:

this builder