ServiceResponseBuilder<T,E> クラス

  • リファレンス
パッケージ:
com.microsoft.bot.restclient
Maven 成果物:
com.microsoft.bot:bot-connector:4.14.3
  • java.lang.Object
    • com.microsoft.bot.restclient.ServiceResponseBuilder<T,E>

型パラメーター

T

呼び出し元が REST 応答から期待する戻り値の型。

E

エラーが発生した場合にスローする例外。

実装

ResponseBuilder<T,E>

public final class ServiceResponseBuilder<T,E>
implements ResponseBuilder<T,E>

ServiceResponse<T>を構築するためのビルダー。

メソッドの概要

修飾子と型 メソッドと説明
ServiceResponseWithHeaders<T,THeader> <THeader>buildEmptyWithHeaders(Response<Void> response, Class<THeader> headerType)

REST 呼び出し応答、JSON 形式のヘッダー、および応答本文がない可能性のあるエラーから、ServiceResponseWithHeaders インスタンスを構築します。
ServiceResponseWithHeaders<T,THeader> <THeader>buildWithHeaders(Response<ResponseBody> response, Class<THeader> headerType)

REST 呼び出し応答、JSON 形式のヘッダー、および考えられるエラーから、サービス応答WithHeaders インスタンスを構築します。
ServiceResponse<T> build(Response<ResponseBody> response)

REST 呼び出し応答と考えられるエラーから ServiceResponse インスタンスを構築します。
ServiceResponse<T> buildEmpty(Response<Void> response)

REST 呼び出し応答と、応答本文がない可能性のあるエラーから、ServiceResponse インスタンスを構築します。
java.lang.Class<> exceptionType()
boolean isSuccessful(int statusCode)

返された状態コードがこのビルダーの成功と見なされるかどうかを確認します。
ServiceResponseBuilder<T,E> register(int statusCode, Type type)

応答状態コードから応答の宛先の種類へのマッピングを登録します。
ServiceResponseBuilder<T,E> registerAll(Map<Integer,Type> responseTypes)

応答状態コードから、Mapに格納されている応答宛先の種類へのすべてのマッピングを登録します。
ServiceResponseBuilder<T,E> registerError(Class<? extends RestException> type)

モデルでエラーの宛先の種類を登録します。
ServiceResponseBuilder<T,E> withThrowOnGet404(boolean throwOnGet404)

GET 呼び出しから 404 個の応答をスローするかどうかを指定します。

メソッドの継承元: java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

メソッドの詳細

<THeader>buildEmptyWithHeaders

public ServiceResponseWithHeaders buildEmptyWithHeaders(Response response, Class headerType)

REST 呼び出し応答、JSON 形式のヘッダー、および応答本文がない可能性のあるエラーから ServiceResponseWithHeaders インスタンスを構築します。

応答の状態コードが登録されている場合、応答は有効と見なされます。 状態コードが登録されていない場合、応答は無効と見なされます。 AutoRestException もスローされます。

パラメーター:

response
headerType

スロー:

java.io.IOException

<THeader>buildWithHeaders

public ServiceResponseWithHeaders buildWithHeaders(Response response, Class headerType)

REST 呼び出し応答、JSON 形式のヘッダー、および考えられるエラーから ServiceResponseWithHeaders インスタンスを構築します。

応答の状態コードが登録されている場合、応答は有効と見なされ、指定された宛先の型に逆シリアル化されます。 状態コードが登録されていない場合、応答は無効と見なされ、存在する場合は指定したエラーの種類に逆シリアル化されます。 AutoRestException もスローされます。

パラメーター:

response
headerType

スロー:

java.io.IOException

build

public ServiceResponse build(Response response)

REST 呼び出し応答と考えられるエラーから ServiceResponse インスタンスを構築します。

応答の状態コードが登録されている場合、応答は有効と見なされ、指定された宛先の型に逆シリアル化されます。 状態コードが登録されていない場合、応答は無効と見なされ、存在する場合は指定したエラーの種類に逆シリアル化されます。 AutoRestException もスローされます。

パラメーター:

response

スロー:

java.io.IOException

buildEmpty

public ServiceResponse buildEmpty(Response response)

REST 呼び出し応答と、応答本文がない可能性のあるエラーから ServiceResponse インスタンスを構築します。

応答の状態コードが登録されている場合、応答は有効と見なされます。 状態コードが登録されていない場合、応答は無効と見なされます。 AutoRestException もスローされます。

パラメーター:

response

スロー:

java.io.IOException

exceptionType

public Class exceptionType()

戻り値:

エラーが発生した場合にスローされる例外の種類。

isSuccessful

public boolean isSuccessful(int statusCode)

返された状態コードがこのビルダーの成功と見なされるかどうかを確認します。

パラメーター:

statusCode - チェックする状態コード

戻り値:

成功した場合は true、それ以外の場合は false。

register

public ServiceResponseBuilder register(int statusCode, Type type)

応答状態コードから応答の宛先の種類へのマッピングを登録します。

パラメーター:

statusCode
type

registerAll

public ServiceResponseBuilder registerAll(Map responseTypes)

応答状態コードから、Mapに格納されている応答宛先の種類へのすべてのマッピングを登録します。

パラメーター:

responseTypes - 応答状態コードから応答の種類へのマッピング。

戻り値:

同じビルダー インスタンス。

registerError

public ServiceResponseBuilder registerError(Class type)

モデルでエラーの宛先の種類を登録します。

パラメーター:

type

withThrowOnGet404

public ServiceResponseBuilder withThrowOnGet404(boolean throwOnGet404)

GET 呼び出しから 404 個の応答をスローするかどうかを指定します。

パラメーター:

throwOnGet404 - スローする場合は true。単に null を返す場合は false。 既定値は false です。

戻り値:

応答ビルダー自体

適用対象