ServiceResponseBuilder<T,E> Clase

  • Referencia
Paquete:
com.microsoft.bot.restclient
Artefacto Maven:
com.microsoft.bot:bot-connector:4.14.3
  • java.lang.Object
    • com.microsoft.bot.restclient.ServiceResponseBuilder<T,E>

Parámetros de tipo

T

El tipo de valor devuelto que el autor de la llamada espera de la respuesta REST.

E

excepción que se produce en caso de error.

Implementaciones

ResponseBuilder<T,E>

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

Generador para crear un ServiceResponse<T>.

Resumen del método

Modificador y tipo Método y descripción
ServiceResponseWithHeaders<T,THeader> <THeader>buildEmptyWithHeaders(Response<Void> response, Class<THeader> headerType)

Compile un servicioresponseWithHeaders instance from a REST call response, a header in JSON format y un posible error, que no tiene un cuerpo de respuesta.
ServiceResponseWithHeaders<T,THeader> <THeader>buildWithHeaders(Response<ResponseBody> response, Class<THeader> headerType)

Compile un servicioresponseWithHeaders instance from a REST call response( Respuesta de servicio, un encabezado en formato JSON y un posible error.
ServiceResponse<T> build(Response<ResponseBody> response)

Compile una instancia de ServiceResponse a partir de una respuesta de llamada REST y un posible error.
ServiceResponse<T> buildEmpty(Response<Void> response)

Compile una instancia de ServiceResponse a partir de una respuesta de llamada REST y un posible error, que no tiene un cuerpo de respuesta.
java.lang.Class<> exceptionType()
boolean isSuccessful(int statusCode)

Compruebe si el código de estado devuelto se considerará correcto para este generador.
ServiceResponseBuilder<T,E> register(int statusCode, Type type)

Registre una asignación desde un código de estado de respuesta a un tipo de destino de respuesta.
ServiceResponseBuilder<T,E> registerAll(Map<Integer,Type> responseTypes)

Registre todas las asignaciones de un código de estado de respuesta a un tipo de destino de respuesta almacenado en un Map.
ServiceResponseBuilder<T,E> registerError(Class<? extends RestException> type)

Registre un tipo de destino para los errores con los modelos.
ServiceResponseBuilder<T,E> withThrowOnGet404(boolean throwOnGet404)

Especifica si se inician en 404 respuestas desde una llamada GET.

Métodos heredados 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

Detalles del método

<THeader>buildEmptyWithHeaders

public ServiceResponseWithHeaders buildEmptyWithHeaders(Response response, Class headerType)

Compile una instancia de ServiceResponseWithHeaders a partir de una respuesta de llamada REST, un encabezado en formato JSON y un posible error, que no tiene un cuerpo de respuesta.

Si el código de estado de la respuesta está registrado, la respuesta se considerará válida. Si el código de estado no está registrado, la respuesta se considerará no válida. También se produce una excepción AutoRestException.

Parámetros:

response
headerType

Produce:

java.io.IOException

<THeader>buildWithHeaders

public ServiceResponseWithHeaders buildWithHeaders(Response response, Class headerType)

Compile una instancia de ServiceResponseWithHeaders a partir de una respuesta de llamada REST, un encabezado en formato JSON y un posible error.

Si el código de estado de la respuesta está registrado, la respuesta se considerará válida y deserializada en el tipo de destino especificado. Si el código de estado no está registrado, la respuesta se considerará no válida y se deserializará en el tipo de error especificado si hay uno. También se produce una excepción AutoRestException.

Parámetros:

response
headerType

Produce:

java.io.IOException

build

public ServiceResponse build(Response response)

Compile una instancia de ServiceResponse a partir de una respuesta de llamada REST y un posible error.

Si el código de estado de la respuesta está registrado, la respuesta se considerará válida y deserializada en el tipo de destino especificado. Si el código de estado no está registrado, la respuesta se considerará no válida y se deserializará en el tipo de error especificado si hay uno. También se produce una excepción AutoRestException.

Parámetros:

response

Produce:

java.io.IOException

buildEmpty

public ServiceResponse buildEmpty(Response response)

Compile una instancia de ServiceResponse a partir de una respuesta de llamada REST y un posible error, que no tiene un cuerpo de respuesta.

Si el código de estado de la respuesta está registrado, la respuesta se considerará válida. Si el código de estado no está registrado, la respuesta se considerará no válida. También se produce una excepción AutoRestException.

Parámetros:

response

Produce:

java.io.IOException

exceptionType

public Class exceptionType()

Devoluciones:

el tipo de excepción que se producirá en caso de error.

isSuccessful

public boolean isSuccessful(int statusCode)

Compruebe si el código de estado devuelto se considerará correcto para este generador.

Parámetros:

statusCode - el código de estado que se va a comprobar

Devoluciones:

true si es correcto, false en caso contrario.

register

public ServiceResponseBuilder register(int statusCode, Type type)

Registre una asignación desde un código de estado de respuesta a un tipo de destino de respuesta.

Parámetros:

statusCode
type

registerAll

public ServiceResponseBuilder registerAll(Map responseTypes)

Registre todas las asignaciones de un código de estado de respuesta a un tipo de destino de respuesta almacenado en un Map.

Parámetros:

responseTypes - la asignación de códigos de estado de respuesta a los tipos de respuesta.

Devoluciones:

la misma instancia del generador.

registerError

public ServiceResponseBuilder registerError(Class type)

Registre un tipo de destino para los errores con los modelos.

Parámetros:

type

withThrowOnGet404

public ServiceResponseBuilder withThrowOnGet404(boolean throwOnGet404)

Especifica si se inician en 404 respuestas desde una llamada GET.

Parámetros:

throwOnGet404 - true si se va a producir; false para devolver simplemente null. El valor predeterminado es false.

Devoluciones:

el propio generador de respuestas

Se aplica a