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<TE>

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<T,THeader> <THeader>buildWithHeaders(Response<ResponseBody> response, Class<THeader> headerType)

Созданиеответа службыс помощью экземпляра заголовковиз ответа на вызов REST, заголовка в формате JSON и возможной ошибки.
ServiceResponse<T> build(Response<ResponseBody> response)

Создайте экземпляр ответа службыиз ответа на вызов REST и возможную ошибку.
ServiceResponse<T> buildEmpty(Response<Void> response)

Создайте экземпляр ответа службыиз ответа на вызов REST и возможную ошибку, которая не содержит текста ответа.
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)

Указывает, следует ли вызывать 404 ответы из вызова GET.

Методы, унаследованные от 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)

Создание экземпляра ServiceResponseWithHeaders из ответа на вызов REST, заголовка в формате JSON и возможной ошибки, которая не содержит текст отклика.

Если код состояния в ответе зарегистрирован, ответ будет считаться допустимым. Если код состояния не зарегистрирован, ответ будет считаться недопустимым. Исключение AutoRestException также возникает.

Параметры:

response
headerType

Активизирует исключение:

java.io.IOException

<THeader>buildWithHeaders

public ServiceResponseWithHeaders buildWithHeaders(Response response, Class headerType)

Создание экземпляра ServiceResponseWithHeaders из ответа на вызов REST, заголовка в формате JSON и возможной ошибки.

Если код состояния в ответе зарегистрирован, ответ будет считаться допустимым и десериализированным в указанный тип назначения. Если код состояния не зарегистрирован, ответ будет считаться недопустимым и десериализирован в указанный тип ошибки, если есть один. Исключение AutoRestException также возникает.

Параметры:

response
headerType

Активизирует исключение:

java.io.IOException

build

public ServiceResponse build(Response response)

Создайте экземпляр ServiceResponse из ответа на вызов REST и возможную ошибку.

Если код состояния в ответе зарегистрирован, ответ будет считаться допустимым и десериализированным в указанный тип назначения. Если код состояния не зарегистрирован, ответ будет считаться недопустимым и десериализирован в указанный тип ошибки, если есть один. Исключение AutoRestException также возникает.

Параметры:

response

Активизирует исключение:

java.io.IOException

buildEmpty

public ServiceResponse buildEmpty(Response response)

Создайте экземпляр ServiceResponse из ответа на вызов REST и возможную ошибку, которая не имеет текста ответа.

Если код состояния в ответе зарегистрирован, ответ будет считаться допустимым. Если код состояния не зарегистрирован, ответ будет считаться недопустимым. Исключение 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)

Указывает, следует ли вызывать 404 ответы из вызова GET.

Параметры:

throwOnGet404 - Значение true, если выбросить; Значение false, чтобы просто вернуть значение NULL. Значение по умолчанию — false.

Возвращаемое значение:

сам построитель ответов

Применяется к