ServiceResponseBuilder<T,E> Classe

  • Referência
Pacote:
com.microsoft.bot.restclient
Artefato Maven:
com.microsoft.bot:bot-connector:4.14.3
  • java.lang.Object
    • com.microsoft.bot.restclient.ServiceResponseBuilder<T,E>

Parâmetros de tipo

T

O tipo de retorno que o chamador espera da resposta REST.

E

a exceção a ser gerada em caso de erro.

Implementações

ResponseBuilder<T,E>

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

O construtor para construir um ServiceResponse<T>.

Resumo do método

Modificador e tipo Método e descrição
ServiceResponseWithHeaders<T,THeader> <THeader>buildEmptyWithHeaders(Response<Void> response, Class<THeader> headerType)

Crie umde resposta dede serviço cominstância de cabeçalhos de uma resposta de chamada REST, um cabeçalho no formato JSON e um possível erro, que não tem um corpo de resposta.
ServiceResponseWithHeaders<T,THeader> <THeader>buildWithHeaders(Response<ResponseBody> response, Class<THeader> headerType)

Crie umde resposta dede serviço cominstância de cabeçalhos de uma resposta de chamada REST, um cabeçalho no formato JSON e um possível erro.
ServiceResponse<T> build(Response<ResponseBody> response)

Crie uma instância do ServiceResponse a partir de uma resposta de chamada REST e um possível erro.
ServiceResponse<T> buildEmpty(Response<Void> response)

Crie uma instância do ServiceResponse com base em uma resposta de chamada REST e um possível erro, que não tem um corpo de resposta.
java.lang.Class<> exceptionType()
boolean isSuccessful(int statusCode)

Verifique se o código de status retornado será considerado um sucesso para este construtor.
ServiceResponseBuilder<T,E> register(int statusCode, Type type)

Registre um mapeamento de um código de status de resposta para um tipo de destino de resposta.
ServiceResponseBuilder<T,E> registerAll(Map<Integer,Type> responseTypes)

Registre todos os mapeamentos de um código de status de resposta para um tipo de destino de resposta armazenado em um Map.
ServiceResponseBuilder<T,E> registerError(Class<? extends RestException> type)

Registre um tipo de destino para erros com modelos.
ServiceResponseBuilder<T,E> withThrowOnGet404(boolean throwOnGet404)

Especifica se é necessário gerar 404 respostas de uma chamada GET.

Métodos herdados de 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

Detalhes do método

<THeader>buildEmptyWithHeaders

public ServiceResponseWithHeaders buildEmptyWithHeaders(Response response, Class headerType)

Crie uma instância ServiceResponseWithHeaders a partir de uma resposta de chamada REST, um cabeçalho no formato JSON e um possível erro, que não tem um corpo de resposta.

Se o código de status na resposta for registrado, a resposta será considerada válida. Se o código de status não estiver registrado, a resposta será considerada inválida. Uma AutoRestException também é gerada.

Parâmetros:

response
headerType

Gera:

java.io.IOException

<THeader>buildWithHeaders

public ServiceResponseWithHeaders buildWithHeaders(Response response, Class headerType)

Crie uma instância ServiceResponseWithHeaders a partir de uma resposta de chamada REST, um cabeçalho no formato JSON e um possível erro.

Se o código de status na resposta for registrado, a resposta será considerada válida e desserializada no tipo de destino especificado. Se o código de status não estiver registrado, a resposta será considerada inválida e desserializada no tipo de erro especificado se houver um. Uma AutoRestException também é gerada.

Parâmetros:

response
headerType

Gera:

java.io.IOException

build

public ServiceResponse build(Response response)

Crie uma instância do ServiceResponse com base em uma resposta de chamada REST e um possível erro.

Se o código de status na resposta for registrado, a resposta será considerada válida e desserializada no tipo de destino especificado. Se o código de status não estiver registrado, a resposta será considerada inválida e desserializada no tipo de erro especificado se houver um. Uma AutoRestException também é gerada.

Parâmetros:

response

Gera:

java.io.IOException

buildEmpty

public ServiceResponse buildEmpty(Response response)

Crie uma instância do ServiceResponse com base em uma resposta de chamada REST e um possível erro, que não tem um corpo de resposta.

Se o código de status na resposta for registrado, a resposta será considerada válida. Se o código de status não estiver registrado, a resposta será considerada inválida. Uma AutoRestException também é gerada.

Parâmetros:

response

Gera:

java.io.IOException

exceptionType

public Class exceptionType()

Retornos:

o tipo de exceção a ser gerado em caso de erro.

isSuccessful

public boolean isSuccessful(int statusCode)

Verifique se o código de status retornado será considerado um sucesso para este construtor.

Parâmetros:

statusCode - o código de status a ser verificado

Retornos:

true se for um sucesso, false caso contrário.

register

public ServiceResponseBuilder register(int statusCode, Type type)

Registre um mapeamento de um código de status de resposta para um tipo de destino de resposta.

Parâmetros:

statusCode
type

registerAll

public ServiceResponseBuilder registerAll(Map responseTypes)

Registre todos os mapeamentos de um código de status de resposta para um tipo de destino de resposta armazenado em um Map.

Parâmetros:

responseTypes - o mapeamento de códigos de status de resposta para tipos de resposta.

Retornos:

a mesma instância do construtor.

registerError

public ServiceResponseBuilder registerError(Class type)

Registre um tipo de destino para erros com modelos.

Parâmetros:

type

withThrowOnGet404

public ServiceResponseBuilder withThrowOnGet404(boolean throwOnGet404)

Especifica se é necessário gerar 404 respostas de uma chamada GET.

Parâmetros:

throwOnGet404 - true se para lançar; false para simplesmente retornar nulo. O padrão é false.

Retornos:

o próprio construtor de respostas

Aplica-se a