インターフェース WebClient.RequestBodySpec
- すべてのスーパーインターフェース:
WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>
- すべての既知のサブインターフェース:
WebClient.RequestBodyUriSpec
- 含まれているインターフェース:
- WebClient
public static interface WebClient.RequestBodySpec
extends WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>
交換に至るまでのリクエストヘッダーと本文を指定するための契約。
メソッドのサマリー
修飾子と型メソッド説明body
(ObjectSE producer, ParameterizedTypeReference<?> elementTypeRef) ReactiveAdapterRegistry
を介してPublisher
に解決できる任意のプロデューサーを使用できるようにするbody(Publisher, ParameterizedTypeReference)
のバリアント。body
(BodyInserter<?, ? super ClientHttpRequest> inserter) 指定された本文挿入子を使用して、リクエストの本文を設定します。<T,
P extends Publisher<T>>
WebClient.RequestHeadersSpec<?>パブリッシャーインサーターを使用したbody(BodyInserter)
のショートカット。<T,
P extends Publisher<T>>
WebClient.RequestHeadersSpec<?>body
(P publisher, ParameterizedTypeReference<T> elementTypeRef) ジェネリクスで要素型情報を提供できるbody(Publisher, Class)
のバリアント。値挿入子を使用したbody(BodyInserter)
のショートカット。<T> WebClient.RequestHeadersSpec<?>
bodyValue
(T body, ParameterizedTypeReference<T> bodyType) 値挿入子を使用したbody(BodyInserter)
のショートカット。contentLength
(long contentLength) Content-Length
ヘッダーで指定されているように、本文の長さをバイト単位で設定します。contentType
(MediaType contentType) Content-Type
ヘッダーで指定されているように、本文のメディア型を設定します。使用すべきではありません。インターフェース org.springframework.web.reactive.function.client.WebClient.RequestHeadersSpec から継承されたメソッド
accept, acceptCharset, attribute, attributes, context, cookie, cookies, exchange, exchangeToFlux, exchangeToMono, header, headers, httpRequest, ifModifiedSince, ifNoneMatch, retrieve
メソッドの詳細
contentLength
Content-Length
ヘッダーで指定されているように、本文の長さをバイト単位で設定します。- パラメーター:
contentLength
- コンテンツの長さ- 戻り値:
- このビルダー
- 関連事項:
contentType
Content-Type
ヘッダーで指定されているように、本文のメディア型を設定します。- パラメーター:
contentType
- コンテンツ型- 戻り値:
- このビルダー
- 関連事項:
bodyValue
値挿入子を使用したbody(BodyInserter)
のショートカット。例:Person person = ... ; Mono<Void> result = client.post() .uri("/persons/{id}", id) .contentType(MediaType.APPLICATION_JSON) .bodyValue(person) .retrieve() .bodyToMono(Void.class);
マルチパートリクエストの場合、
MultipartBodyBuilder
で準備されたMultiValueMap
を提供することを検討してください。- パラメーター:
body
- リクエストボディに書き込む値- 戻り値:
- このビルダー
- 例外:
IllegalArgumentExceptionSE
-body
がPublisher
またはReactiveAdapterRegistry
に知られているプロデューサーである場合- 導入:
- 5.2
- 関連事項:
bodyValue
値挿入子を使用したbody(BodyInserter)
のショートカット。例:List<Person> list = ... ; Mono<Void> result = client.post() .uri("/persons/{id}", id) .contentType(MediaType.APPLICATION_JSON) .bodyValue(list, new ParameterizedTypeReference<List<Person>>() {};) .retrieve() .bodyToMono(Void.class);
マルチパートリクエストの場合、
MultipartBodyBuilder
で準備されたMultiValueMap
を提供することを検討してください。- 型パラメーター:
T
- 体の種類- パラメーター:
body
- リクエストボディに書き込む値bodyType
- ジェネリクス型をキャプチャーするために使用されるボディの型- 戻り値:
- このビルダー
- 例外:
IllegalArgumentExceptionSE
-body
がPublisher
またはReactiveAdapterRegistry
に知られているプロデューサーである場合- 導入:
- 6.2
body
<T,P extends Publisher<T>> WebClient.RequestHeadersSpec<?> body(P publisher, ClassSE<T> elementClass) パブリッシャーインサーターを使用したbody(BodyInserter)
のショートカット。例:Mono<Person> personMono = ... ; Mono<Void> result = client.post() .uri("/persons/{id}", id) .contentType(MediaType.APPLICATION_JSON) .body(personMono, Person.class) .retrieve() .bodyToMono(Void.class);
- 型パラメーター:
T
- パブリッシャーに含まれる要素の型P
-Publisher
の型- パラメーター:
publisher
- リクエストに書き込むPublisher
elementClass
- 公開された要素の型- 戻り値:
- このビルダー
body
<T,P extends Publisher<T>> WebClient.RequestHeadersSpec<?> body(P publisher, ParameterizedTypeReference<T> elementTypeRef) ジェネリクスで要素型情報を提供できるbody(Publisher, Class)
のバリアント。- 型パラメーター:
T
- パブリッシャーに含まれる要素の型P
-Publisher
の型- パラメーター:
publisher
- リクエストに書き込むPublisher
elementTypeRef
- 公開された要素の型- 戻り値:
- このビルダー
body
- パラメーター:
producer
- リクエストに書き込むプロデューサーelementClass
- 生成される要素の型- 戻り値:
- このビルダー
- 導入:
- 5.2
body
WebClient.RequestHeadersSpec<?> body(ObjectSE producer, ParameterizedTypeReference<?> elementTypeRef) ReactiveAdapterRegistry
を介してPublisher
に解決できる任意のプロデューサーを使用できるようにするbody(Publisher, ParameterizedTypeReference)
のバリアント。- パラメーター:
producer
- リクエストに書き込むプロデューサーelementTypeRef
- 生成される要素の型- 戻り値:
- このビルダー
- 導入:
- 5.2
body
指定された本文挿入子を使用して、リクエストの本文を設定します。組み込みのBodyInserter
実装については、BodyInserters
を参照してください。- パラメーター:
inserter
- リクエスト本文に使用する本文挿入子- 戻り値:
- このビルダー
- 関連事項:
syncBody
使用すべきではありません。Spring Framework 5.2 現在、bodyValue(Object)
を推奨
bodyValue(Object)
を推奨