インターフェース ClientResponse

メソッドの詳細

• statusCode

  HttpStatusCode statusCode()

  HTTP ステータスコードを HttpStatusCode 値として返します。

  戻り値:

  HttpStatusCode 値としての HTTP ステータス (非 null)

• rawStatusCode

  @DeprecatedSE(since="6.0", forRemoval=true) default int rawStatusCode()

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  statusCode() を推奨し、7.0 から削除

  このレスポンスの生のステータスコードを返します。

  戻り値:

  整数値としての HTTP ステータス

  導入:

  5.1

• headers

  ClientResponse.Headers headers()

  このレスポンスのヘッダーを返します。

• cookies

  MultiValueMap<StringSE,ResponseCookie> cookies()

  このレスポンスの Cookie を返します。

• strategies

  ExchangeStrategies strategies()

  このレスポンスの本文を変換するために使用される戦略を返します。

• request

  HttpRequest request()

  レスポンスに関連付けられたリクエストを返します。

  導入:

  6.1

• body

  <T> T body(BodyExtractor<T,? super ClientHttpResponse> extractor)

  指定された BodyExtractor で本体を抽出します。

  型パラメーター:

  T - 返される本体の型

  パラメーター:

  extractor - レスポンスから読み取る BodyExtractor 

  戻り値:

  抽出されたボディ

• bodyToMono

  <T> reactor.core.publisher.Mono<T> bodyToMono(ClassSE<? extends T> elementClass)

  本体を Mono に抽出します。

  型パラメーター:

  T - 要素型

  パラメーター:

  elementClass - Mono の要素のクラス

  戻り値:

  指定された型 T の本体を含む mono

• bodyToMono

  <T> reactor.core.publisher.Mono<T> bodyToMono(ParameterizedTypeReference<T> elementTypeRef)

  本体を Mono に抽出します。

  型パラメーター:

  T - 要素型

  パラメーター:

  elementTypeRef - Mono の要素の型参照

  戻り値:

  指定された型 T の本体を含む mono

• bodyToFlux

  <T> reactor.core.publisher.Flux<T> bodyToFlux(ClassSE<? extends T> elementClass)

  本体を Flux に抽出します。

  型パラメーター:

  T - 要素型

  パラメーター:

  elementClass - Flux の要素のクラス

  戻り値:

  指定された型 T の本体を含む flux

• bodyToFlux

  <T> reactor.core.publisher.Flux<T> bodyToFlux(ParameterizedTypeReference<T> elementTypeRef)

  本体を Flux に抽出します。

  型パラメーター:

  T - 要素型

  パラメーター:

  elementTypeRef - Flux の要素の型参照

  戻り値:

  指定された型 T の本体を含む flux

• releaseBody

  reactor.core.publisher.Mono<VoidSE> releaseBody()

  このレスポンスの本文を解放します。

  戻り値:

  完了シグナル

  導入:

  5.2

  関連事項:

  • DataBufferUtils.release(DataBuffer)

• toEntity

  <T> reactor.core.publisher.Mono<ResponseEntity<T>> toEntity(ClassSE<T> bodyClass)

  このレスポンスを遅延 ResponseEntity として返します。

  型パラメーター:

  T - レスポンス本体型

  パラメーター:

  bodyClass - 予想されるレスポンス本文型

  戻り値:

  Mono と ResponseEntity

• toEntity

  <T> reactor.core.publisher.Mono<ResponseEntity<T>> toEntity(ParameterizedTypeReference<T> bodyTypeReference)

  このレスポンスを遅延 ResponseEntity として返します。

  型パラメーター:

  T - レスポンス本体型

  パラメーター:

  bodyTypeReference - 予想されるレスポンス本文の種類を説明する型参照

  戻り値:

  Mono と ResponseEntity

• toEntityList

  <T> reactor.core.publisher.Mono<ResponseEntity<ListSE<T>>> toEntityList(ClassSE<T> elementClass)

  このレスポンスを ResponseEntity の遅延リストとして返します。

  型パラメーター:

  T - リスト内の要素の型

  パラメーター:

  elementClass - 予想されるレスポンス本文リスト要素クラス

  戻り値:

   ResponseEntity のリストを持つ Mono 

• toEntityList

  <T> reactor.core.publisher.Mono<ResponseEntity<ListSE<T>>> toEntityList(ParameterizedTypeReference<T> elementTypeRef)

  このレスポンスを ResponseEntity の遅延リストとして返します。

  型パラメーター:

  T - リスト内の要素の型

  パラメーター:

  elementTypeRef - 予想されるレスポンス本文リスト要素の参照型

  戻り値:

   ResponseEntity のリストを持つ Mono 

• toBodilessEntity

  reactor.core.publisher.Mono<ResponseEntity<VoidSE>> toBodilessEntity()

  このレスポンスを、ステータスとヘッダーは含むが本体は含まない遅延 ResponseEntity として返します。このメソッドを呼び出すと、レスポンスの本文が解放されます。

  戻り値:

  Mono とボディレス ResponseEntity

  導入:

  5.2

• createException

  reactor.core.publisher.Mono<WebClientResponseException> createException()

  レスポンスステータス、ヘッダー、本文、元のリクエストを含む WebClientResponseException を作成します。

  戻り値:

  作成された例外を持つ Mono 

  導入:

  5.2

• createError

  <T> reactor.core.publisher.Mono<T> createError()

  WebClientResponseException で終了する Mono を作成し、レスポンスステータス、ヘッダー、本文、元のリクエストを含めます。

  型パラメーター:

  T - 具体化された型

  戻り値:

  WebClientResponseException で失敗する Mono。

  導入:

  6.0

  関連事項:

  • createException()

• logPrefix

  StringSE logPrefix()

  この交換のメッセージを相関させるために使用するログメッセージプレフィックスを返します。

  接頭辞は ClientRequest.logPrefix() に基づいており、それ自体が LOG_ID_ATTRIBUTE リクエスト属性の値に基づいており、さらに "[" と "]" で囲まれています。

  戻り値:

  ログメッセージプレフィックス、または LOG_ID_ATTRIBUTE が設定されていない場合は空の文字列

  導入:

  5.2.3

• mutate

  default ClientResponse.Builder mutate()

  ビルダーを返して、このレスポンスを変更します。たとえば、ステータス、ヘッダー、Cookie を変更したり、本文を置き換えたり変換したりします。

  戻り値:

  レスポンスを変更するビルダー

  導入:

  5.3

• from

  @DeprecatedSE static ClientResponse.Builder from(ClientResponse other)

  使用すべきではありません。

  5.3 以降では、インスタンスベースの mutate() が使用されます。

  指定されたレスポンスのステータス、ヘッダー、Cookie を使用してビルダーを作成します。

  注意 : 返されるビルダーの本体はデフォルトで Flux.empty() であることに注意してください。元のレスポンスから 1 つを引き継ぐには、otherResponse.bodyToFlux(DataBuffer.class) を使用するか、単にインスタンスベースの mutate() メソッドを使用します。

  パラメーター:

  other - ステータス、ヘッダー、Cookie をコピーするレスポンス

  戻り値:

  作成されたビルダー

• create

  static ClientResponse.Builder create(HttpStatusCode statusCode)

  指定されたステータスコードで、本文を読み取るためのデフォルトの戦略を使用して、レスポンスビルダーを作成します。

  パラメーター:

  statusCode - ステータスコード

  戻り値:

  作成されたビルダー

• create

  static ClientResponse.Builder create(HttpStatusCode statusCode, ExchangeStrategies strategies)

  指定されたステータスコードと本文を読み取るための戦略を使用して、レスポンスビルダーを作成します。

  パラメーター:

  statusCode - ステータスコード

  strategies - 戦略

  戻り値:

  作成されたビルダー

• create

  static ClientResponse.Builder create(int statusCode, ExchangeStrategies strategies)

  指定された生のステータスコードと本文を読み取るための戦略を使用して、レスポンスビルダーを作成します。

  パラメーター:

  statusCode - ステータスコード

  strategies - 戦略

  戻り値:

  作成されたビルダー

  導入:

  5.1.9

• create

  static ClientResponse.Builder create(HttpStatusCode statusCode, ListSE<HttpMessageReader<?>> messageReaders)

  指定されたステータスコードとメッセージ本文リーダーを使用して、レスポンスビルダーを作成します。

  パラメーター:

  statusCode - ステータスコード

  messageReaders - メッセージリーダー

  戻り値:

  作成されたビルダー