RestClient.Builder Clase

  • java.lang.Object
    • com.microsoft.bot.restclient.RestClient.Builder

public static class RestClient.Builder

Clase de generador para compilar un cliente REST.

Resumen del constructor

Constructor Description
Builder()

Crea una instancia del generador con una dirección URL base para el servicio.

Builder(OkHttpClient.Builder httpClientBuilder, Retrofit.Builder retrofitBuilder)

Crea una instancia del generador con una dirección URL base y 2 generadores personalizados.

Resumen del método

Modificador y tipo Método y descripción
RestClient build()

Cree un cliente restcon todas las configuraciones actuales.

Builder useHttpClientThreadPool(boolean useHttpClientThreadPool)

Establece si se va a usar el grupo de subprocesos en Okcliente Http o Rxprogramadores de Java.

Builder withBaseUrl(Environment environment, Environment.Endpoint endpoint)

Establece la dirección URL base con el valor predeterminado de Environment.

Builder withBaseUrl(String baseUrl)

Establece la dirección URL base dinámica.

Builder withCallbackExecutor(Executor executor)

Establece el ejecutor para que se ejecuten devoluciones de llamada asincrónicas.

Builder withConnectionPool(ConnectionPool connectionPool)

Establece el grupo de conexiones para el cliente Http.

Builder withConnectionTimeout(long timeout, TimeUnit unit)

Establezca el tiempo de espera de conexión en el cliente HTTP.

Builder withCredentials(ServiceClientCredentials credentials)

Establece las credenciales.

Builder withDispatcher(Dispatcher dispatcher)

Establece el distribuidor usado en Okcliente Http.

Builder withInterceptor(Interceptor interceptor)

Agregue un interceptor a la canalización de cliente Http.

Builder withLogLevel(LogLevel logLevel)

Establece el nivel de registro HTTP.

Builder withMaxIdleConnections(int maxIdleConnections)

Obsoleto

Establezca las conexiones inactivas máximas para el cliente HTTP.

Builder withNetworkInterceptor(Interceptor networkInterceptor)

Agregue un interceptor a la capa de red de la canalización de cliente Http.

Builder withProxy(Proxy proxy)

Establece el proxy para el cliente HTTP.

Builder withProxyAuthenticator(Authenticator proxyAuthenticator)

Establece el autenticador de proxy para el cliente HTTP.

Builder withReadTimeout(long timeout, TimeUnit unit)

Establezca el tiempo de espera de lectura en el cliente HTTP.

Builder withResponseBuilderFactory(ResponseBuilder.Factory responseBuilderFactory)

Establece el generador de respuestas.

Builder withRetryStrategy(RetryStrategy strategy)

Agrega una estrategia de reintento al cliente.

Builder withSerializerAdapter(SerializerAdapter<?> serializerAdapter)

Establece el adaptador de serialización.

Builder withUserAgent(String userAgent)

Establece el encabezado del agente de usuario.

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 constructor

Builder

public Builder()

Crea una instancia del generador con una dirección URL base para el servicio.

Builder

public Builder(OkHttpClient.Builder httpClientBuilder, Retrofit.Builder retrofitBuilder)

Crea una instancia del generador con una dirección URL base y 2 generadores personalizados.

Parámetros:

httpClientBuilder - generador para compilar un OkHttpClient.
retrofitBuilder - el generador para compilar un Retrofit.

Detalles del método

build

public RestClient build()

Compile un RestClient con todas las configuraciones actuales.

Devoluciones:

useHttpClientThreadPool

public RestClient.Builder useHttpClientThreadPool(boolean useHttpClientThreadPool)

Establece si se va a usar el grupo de subprocesos en los programadores okHttp o RxJava. Si se establece en true, se usará el grupo de subprocesos en el cliente OkHttp. El valor predeterminado es false.

Parámetros:

useHttpClientThreadPool - si se va a usar el grupo de subprocesos en el cliente Okhttp. El valor predeterminado es false.

Devoluciones:

el propio generador para encadenar

withBaseUrl

public RestClient.Builder withBaseUrl(Environment environment, Environment.Endpoint endpoint)

Establece la dirección URL base con el valor predeterminado de Environment.

Parámetros:

environment - el entorno que se va a usar
endpoint - el punto de conexión del entorno al que accede la aplicación

Devoluciones:

el propio generador para encadenar

withBaseUrl

public RestClient.Builder withBaseUrl(String baseUrl)

Establece la dirección URL base dinámica.

Parámetros:

baseUrl - la dirección URL base que se va a usar.

Devoluciones:

el propio generador para encadenar.

withCallbackExecutor

public RestClient.Builder withCallbackExecutor(Executor executor)

Establece el ejecutor para que se ejecuten devoluciones de llamada asincrónicas.

Parámetros:

executor - ejecutor para ejecutar las devoluciones de llamada.

Devoluciones:

el propio generador para encadenar

withConnectionPool

public RestClient.Builder withConnectionPool(ConnectionPool connectionPool)

Establece el grupo de conexiones para el cliente Http.

Parámetros:

connectionPool - el grupo de conexiones OkHttp 3 que se va a usar

Devoluciones:

el propio generador para encadenar

withConnectionTimeout

public RestClient.Builder withConnectionTimeout(long timeout, TimeUnit unit)

Establezca el tiempo de espera de conexión en el cliente HTTP. El valor predeterminado es de 10 segundos.

Parámetros:

timeout - el valor numérico de tiempo de espera
unit - unidad de tiempo para el valor numérico

Devoluciones:

el propio generador para encadenar

withCredentials

public RestClient.Builder withCredentials(ServiceClientCredentials credentials)

Establece las credenciales.

Parámetros:

credentials - el objeto credentials.

Devoluciones:

el propio generador para encadenar.

withDispatcher

public RestClient.Builder withDispatcher(Dispatcher dispatcher)

Establece el distribuidor usado en el cliente OkHttp. Aquí también es donde establecer el grupo de subprocesos para ejecutar solicitudes HTTP.

Parámetros:

dispatcher - distribuidor que se va a usar

Devoluciones:

el propio generador para encadenar

withInterceptor

public RestClient.Builder withInterceptor(Interceptor interceptor)

Agregue un interceptor a la canalización de cliente Http.

Parámetros:

interceptor - interceptor que se va a agregar.

Devoluciones:

el propio generador para encadenar.

withLogLevel

public RestClient.Builder withLogLevel(LogLevel logLevel)

Establece el nivel de registro HTTP.

Parámetros:

logLevel - enumeración LogLevel.

Devoluciones:

el propio generador para encadenar.

withMaxIdleConnections


public RestClient.Builder withMaxIdleConnections(int maxIdleConnections)

Obsoleto

Establezca las conexiones inactivas máximas para el cliente HTTP. El valor predeterminado es 5.

Parámetros:

maxIdleConnections - conexiones inactivas máximas

Devoluciones:

el propio generador para encadenar

withNetworkInterceptor

public RestClient.Builder withNetworkInterceptor(Interceptor networkInterceptor)

Agregue un interceptor a la capa de red de la canalización de cliente Http.

Parámetros:

networkInterceptor - interceptor que se va a agregar.

Devoluciones:

el propio generador para encadenar.

withProxy

public RestClient.Builder withProxy(Proxy proxy)

Establece el proxy para el cliente HTTP.

Parámetros:

proxy - proxy que se va a usar

Devoluciones:

el propio generador para encadenar

withProxyAuthenticator

public RestClient.Builder withProxyAuthenticator(Authenticator proxyAuthenticator)

Establece el autenticador de proxy para el cliente HTTP.

Parámetros:

proxyAuthenticator - autenticador de proxy que se va a usar

Devoluciones:

el propio generador para encadenar

withReadTimeout

public RestClient.Builder withReadTimeout(long timeout, TimeUnit unit)

Establezca el tiempo de espera de lectura en el cliente HTTP. El valor predeterminado es de 10 segundos.

Parámetros:

timeout - el valor numérico de tiempo de espera
unit - unidad de tiempo para el valor numérico

Devoluciones:

el propio generador para encadenar

withResponseBuilderFactory

public RestClient.Builder withResponseBuilderFactory(ResponseBuilder.Factory responseBuilderFactory)

Establece el generador de respuestas.

Parámetros:

responseBuilderFactory - generador de respuestas

Devoluciones:

el propio generador para encadenar

withRetryStrategy

public RestClient.Builder withRetryStrategy(RetryStrategy strategy)

Agrega una estrategia de reintento al cliente.

Parámetros:

strategy - la estrategia de reintento que se va a agregar

Devoluciones:

el propio generador para encadenar

withSerializerAdapter

public RestClient.Builder withSerializerAdapter(SerializerAdapter serializerAdapter)

Establece el adaptador de serialización.

Parámetros:

serializerAdapter - el adaptador a un serializador

Devoluciones:

el propio generador para encadenar

withUserAgent

public RestClient.Builder withUserAgent(String userAgent)

Establece el encabezado del agente de usuario.

Parámetros:

userAgent - encabezado del agente de usuario.

Devoluciones:

el propio generador para encadenar.

Se aplica a