RestClient.Builder Classe

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

public static class RestClient.Builder

A classe de construtor para a criação de um cliente REST.

Resumo do Construtor

Construtor Description
Builder()

Cria uma instância do construtor com uma URL base para o serviço.

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

Cria uma instância do construtor com uma URL base e dois construtores personalizados.

Resumo do método

Modificador e tipo Método e descrição
RestClient build()

Crie um cliente restcom todas as configurações atuais.

Builder useHttpClientThreadPool(boolean useHttpClientThreadPool)

Define se o pool de threads deve ser usado em okcliente Http ou agendadores Java do Rx.

Builder withBaseUrl(Environment environment, Environment.Endpoint endpoint)

Define a URL base com o padrão do Ambiente.

Builder withBaseUrl(String baseUrl)

Define a URL base dinâmica.

Builder withCallbackExecutor(Executor executor)

Define o executor para retornos de chamada assíncronos a serem executados.

Builder withConnectionPool(ConnectionPool connectionPool)

Define o pool de conexões para o cliente Http.

Builder withConnectionTimeout(long timeout, TimeUnit unit)

Defina o tempo limite de conexão no cliente HTTP.

Builder withCredentials(ServiceClientCredentials credentials)

Define as credenciais.

Builder withDispatcher(Dispatcher dispatcher)

Define o dispatcher usado em Okcliente Http.

Builder withInterceptor(Interceptor interceptor)

Adicione um interceptor ao pipeline do cliente Http.

Builder withLogLevel(LogLevel logLevel)

Define o nível de log HTTP.

Builder withMaxIdleConnections(int maxIdleConnections)

Preterido

Defina o máximo de conexões ociosas para o cliente HTTP.

Builder withNetworkInterceptor(Interceptor networkInterceptor)

Adicione um interceptor à camada de rede do pipeline do cliente Http.

Builder withProxy(Proxy proxy)

Define o proxy para o cliente HTTP.

Builder withProxyAuthenticator(Authenticator proxyAuthenticator)

Define o autenticador de proxy para o cliente HTTP.

Builder withReadTimeout(long timeout, TimeUnit unit)

Defina o tempo limite de leitura no cliente HTTP.

Builder withResponseBuilderFactory(ResponseBuilder.Factory responseBuilderFactory)

Define a fábrica do construtor de respostas.

Builder withRetryStrategy(RetryStrategy strategy)

Adiciona uma estratégia de repetição ao cliente.

Builder withSerializerAdapter(SerializerAdapter<?> serializerAdapter)

Define o adaptador de serialização.

Builder withUserAgent(String userAgent)

Define o cabeçalho do agente do usuário.

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 construtor

Builder

public Builder()

Cria uma instância do construtor com uma URL base para o serviço.

Builder

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

Cria uma instância do construtor com uma URL base e dois construtores personalizados.

Parâmetros:

httpClientBuilder - o construtor para criar um OkHttpClient.
retrofitBuilder - o construtor para criar um Retrofit.

Detalhes do método

build

public RestClient build()

Crie um RestClient com todas as configurações atuais.

Retornos:

useHttpClientThreadPool

public RestClient.Builder useHttpClientThreadPool(boolean useHttpClientThreadPool)

Define se o pool de threads deve ser usado em agendadores de cliente OkHttp ou RxJava. Se definido como true, o pool de threads no cliente OkHttp será usado. O padrão é false.

Parâmetros:

useHttpClientThreadPool - se o pool de threads deve ser usado no cliente Okhttp. O padrão é false.

Retornos:

o construtor em si para encadeamento

withBaseUrl

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

Define a URL base com o padrão do Ambiente.

Parâmetros:

environment - o ambiente a ser usado
endpoint - o ponto de extremidade de ambiente que o aplicativo está acessando

Retornos:

o construtor em si para encadeamento

withBaseUrl

public RestClient.Builder withBaseUrl(String baseUrl)

Define a URL base dinâmica.

Parâmetros:

baseUrl - a URL base a ser usada.

Retornos:

o construtor em si para encadeamento.

withCallbackExecutor

public RestClient.Builder withCallbackExecutor(Executor executor)

Define o executor para retornos de chamada assíncronos a serem executados.

Parâmetros:

executor - o executor para executar os retornos de chamada.

Retornos:

o construtor em si para encadeamento

withConnectionPool

public RestClient.Builder withConnectionPool(ConnectionPool connectionPool)

Define o pool de conexões para o cliente Http.

Parâmetros:

connectionPool - o pool de conexões okHttp 3 a ser usado

Retornos:

o construtor em si para encadeamento

withConnectionTimeout

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

Defina o tempo limite de conexão no cliente HTTP. O padrão é 10 segundos.

Parâmetros:

timeout - o valor numérico de tempo limite
unit - a unidade de tempo para o valor numérico

Retornos:

o construtor em si para encadeamento

withCredentials

public RestClient.Builder withCredentials(ServiceClientCredentials credentials)

Define as credenciais.

Parâmetros:

credentials - o objeto de credenciais.

Retornos:

o construtor em si para encadeamento.

withDispatcher

public RestClient.Builder withDispatcher(Dispatcher dispatcher)

Define o dispatcher usado no cliente OkHttp. Esse também é o local onde definir o pool de threads para executar solicitações HTTP.

Parâmetros:

dispatcher - o dispatcher a ser usado

Retornos:

o construtor em si para encadeamento

withInterceptor

public RestClient.Builder withInterceptor(Interceptor interceptor)

Adicione um interceptor ao pipeline do cliente Http.

Parâmetros:

interceptor - o interceptor a ser adicionado.

Retornos:

o construtor em si para encadeamento.

withLogLevel

public RestClient.Builder withLogLevel(LogLevel logLevel)

Define o nível de log HTTP.

Parâmetros:

logLevel - a enumeração LogLevel.

Retornos:

o construtor em si para encadeamento.

withMaxIdleConnections


public RestClient.Builder withMaxIdleConnections(int maxIdleConnections)

Preterido

Defina o máximo de conexões ociosas para o cliente HTTP. O padrão é 5.

Parâmetros:

maxIdleConnections - as conexões ociosas máximas

Retornos:

o construtor em si para encadeamento

withNetworkInterceptor

public RestClient.Builder withNetworkInterceptor(Interceptor networkInterceptor)

Adicione um interceptor à camada de rede do pipeline do cliente Http.

Parâmetros:

networkInterceptor - o interceptor a ser adicionado.

Retornos:

o construtor em si para encadeamento.

withProxy

public RestClient.Builder withProxy(Proxy proxy)

Define o proxy para o cliente HTTP.

Parâmetros:

proxy - o proxy a ser usado

Retornos:

o construtor em si para encadeamento

withProxyAuthenticator

public RestClient.Builder withProxyAuthenticator(Authenticator proxyAuthenticator)

Define o autenticador de proxy para o cliente HTTP.

Parâmetros:

proxyAuthenticator - o autenticador de proxy a ser usado

Retornos:

o construtor em si para encadeamento

withReadTimeout

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

Defina o tempo limite de leitura no cliente HTTP. O padrão é 10 segundos.

Parâmetros:

timeout - o valor numérico de tempo limite
unit - a unidade de tempo para o valor numérico

Retornos:

o construtor em si para encadeamento

withResponseBuilderFactory

public RestClient.Builder withResponseBuilderFactory(ResponseBuilder.Factory responseBuilderFactory)

Define a fábrica do construtor de respostas.

Parâmetros:

responseBuilderFactory - a fábrica do construtor de respostas

Retornos:

o construtor em si para encadeamento

withRetryStrategy

public RestClient.Builder withRetryStrategy(RetryStrategy strategy)

Adiciona uma estratégia de repetição ao cliente.

Parâmetros:

strategy - a estratégia de repetição a ser adicionada

Retornos:

o construtor em si para encadeamento

withSerializerAdapter

public RestClient.Builder withSerializerAdapter(SerializerAdapter serializerAdapter)

Define o adaptador de serialização.

Parâmetros:

serializerAdapter - o adaptador para um serializador

Retornos:

o construtor em si para encadeamento

withUserAgent

public RestClient.Builder withUserAgent(String userAgent)

Define o cabeçalho do agente do usuário.

Parâmetros:

userAgent - o cabeçalho do agente do usuário.

Retornos:

o construtor em si para encadeamento.

Aplica-se a