インターフェース RestClient.ResponseSpec
- 含まれているインターフェース:
- RestClient
public static interface RestClient.ResponseSpec
交換後のレスポンス操作を指定するための契約。
ネストされたクラスのサマリー
方法の概要
修飾子と型メソッド説明<T> T
ボディを指定された型のオブジェクトとして抽出します。<T> T
body
(ParameterizedTypeReference<T> bodyType) ボディを指定された型のオブジェクトとして抽出します。onStatus
(PredicateSE<HttpStatusCode> statusPredicate, RestClient.ResponseSpec.ErrorHandler errorHandler) 特定のエラーステータスコードをエラーハンドラーにマップする関数を提供します。onStatus
(ResponseErrorHandler errorHandler) 特定のエラーステータスコードをエラーハンドラーにマップする関数を提供します。本体なしでResponseEntity
を返します。<T> ResponseEntity<T>
指定された型のオブジェクトにデコードされた本体を持つResponseEntity
を返します。<T> ResponseEntity<T>
toEntity
(ParameterizedTypeReference<T> bodyType) 指定された型のオブジェクトにデコードされた本体を持つResponseEntity
を返します。
メソッドの詳細
onStatus
RestClient.ResponseSpec onStatus(PredicateSE<HttpStatusCode> statusPredicate, RestClient.ResponseSpec.ErrorHandler errorHandler) 特定のエラーステータスコードをエラーハンドラーにマップする関数を提供します。デフォルトでは、一致するステータスハンドラーがない場合、ステータスコード>= 400 のレスポンスは
RestClientResponseException
をスローします。errorHandler
からスローされたIOExceptions
SE、UncheckedIOExceptions
SE、HttpMessageNotReadableExceptions
はRestClientException
でラップされることに注意してください。- パラメーター:
statusPredicate
- レスポンスを一致させるerrorHandler
- 必ずではありませんが、通常は例外をスローするハンドラー- 戻り値:
- このビルダー
onStatus
特定のエラーステータスコードをエラーハンドラーにマップする関数を提供します。デフォルトでは、一致するステータスハンドラーがない場合、ステータスコード>= 400 のレスポンスは
RestClientResponseException
をスローします。errorHandler
からスローされたIOExceptions
SE、UncheckedIOExceptions
SE、HttpMessageNotReadableExceptions
はRestClientException
でラップされることに注意してください。- パラメーター:
errorHandler
- エラーハンドラー- 戻り値:
- このビルダー
body
ボディを指定された型のオブジェクトとして抽出します。- 型パラメーター:
T
- ボディ型- パラメーター:
bodyType
- 戻り値の型- 戻り値:
- 本文、またはレスポンス本文が利用できない場合は
null
- 例外:
RestClientResponseException
- デフォルトでは、ステータスコード 4xx または 5xx のレスポンスを受信したときに実行されます。onStatus(Predicate, ErrorHandler)
を使用して、エラーレスポンス処理をカスタマイズします。
body
ボディを指定された型のオブジェクトとして抽出します。- 型パラメーター:
T
- ボディ型- パラメーター:
bodyType
- 戻り値の型- 戻り値:
- 本文、またはレスポンス本文が利用できない場合は
null
- 例外:
RestClientResponseException
- デフォルトでは、ステータスコード 4xx または 5xx のレスポンスを受信したときに実行されます。onStatus(Predicate, ErrorHandler)
を使用して、エラーレスポンス処理をカスタマイズします。
toEntity
指定された型のオブジェクトにデコードされた本体を持つResponseEntity
を返します。- 型パラメーター:
T
- レスポンス本体型- パラメーター:
bodyType
- 予想されるレスポンス本文型- 戻り値:
- デコードされたボディを持つ
ResponseEntity
- 例外:
RestClientResponseException
- デフォルトでは、ステータスコード 4xx または 5xx のレスポンスを受信したときに実行されます。onStatus(Predicate, ErrorHandler)
を使用して、エラーレスポンス処理をカスタマイズします。
toEntity
指定された型のオブジェクトにデコードされた本体を持つResponseEntity
を返します。- 型パラメーター:
T
- レスポンス本体型- パラメーター:
bodyType
- 予想されるレスポンス本文型- 戻り値:
- デコードされたボディを持つ
ResponseEntity
- 例外:
RestClientResponseException
- デフォルトでは、ステータスコード 4xx または 5xx のレスポンスを受信したときに実行されます。onStatus(Predicate, ErrorHandler)
を使用して、エラーレスポンス処理をカスタマイズします。
toBodilessEntity
ResponseEntity<VoidSE> toBodilessEntity()本体なしでResponseEntity
を返します。- 戻り値:
ResponseEntity
- 例外:
RestClientResponseException
- デフォルトでは、ステータスコード 4xx または 5xx のレスポンスを受信したときに実行されます。onStatus(Predicate, ErrorHandler)
を使用して、エラーレスポンス処理をカスタマイズします。