RestClient.Builder Classe
- java.
lang. Object - com.
microsoft. bot. restclient. RestClient. Builder
- com.
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 |
|---|---|
|
Rest |
build()
Crie um cliente rest |
| Builder |
useHttpClientThreadPool(boolean useHttpClientThreadPool)
Define se o pool de threads deve ser usado em ok |
| 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 Ok |
| 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
em vez disso, use withConnectionPool(ConnectionPool connectionPool)
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
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:
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:
Retornos:
withBaseUrl
public RestClient.Builder withBaseUrl(Environment environment, Environment.Endpoint endpoint)
Define a URL base com o padrão do Ambiente.
Parâmetros:
Retornos:
withBaseUrl
public RestClient.Builder withBaseUrl(String baseUrl)
Define a URL base dinâmica.
Parâmetros:
Retornos:
withCallbackExecutor
public RestClient.Builder withCallbackExecutor(Executor executor)
Define o executor para retornos de chamada assíncronos a serem executados.
Parâmetros:
Retornos:
withConnectionPool
public RestClient.Builder withConnectionPool(ConnectionPool connectionPool)
Define o pool de conexões para o cliente Http.
Parâmetros:
Retornos:
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:
Retornos:
withCredentials
public RestClient.Builder withCredentials(ServiceClientCredentials credentials)
Define as credenciais.
Parâmetros:
Retornos:
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:
Retornos:
withInterceptor
public RestClient.Builder withInterceptor(Interceptor interceptor)
Adicione um interceptor ao pipeline do cliente Http.
Parâmetros:
Retornos:
withLogLevel
public RestClient.Builder withLogLevel(LogLevel logLevel)
Define o nível de log HTTP.
Parâmetros:
Retornos:
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:
Retornos:
withNetworkInterceptor
public RestClient.Builder withNetworkInterceptor(Interceptor networkInterceptor)
Adicione um interceptor à camada de rede do pipeline do cliente Http.
Parâmetros:
Retornos:
withProxy
public RestClient.Builder withProxy(Proxy proxy)
Define o proxy para o cliente HTTP.
Parâmetros:
Retornos:
withProxyAuthenticator
public RestClient.Builder withProxyAuthenticator(Authenticator proxyAuthenticator)
Define o autenticador de proxy para o cliente HTTP.
Parâmetros:
Retornos:
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:
Retornos:
withResponseBuilderFactory
public RestClient.Builder withResponseBuilderFactory(ResponseBuilder.Factory responseBuilderFactory)
Define a fábrica do construtor de respostas.
Parâmetros:
Retornos:
withRetryStrategy
public RestClient.Builder withRetryStrategy(RetryStrategy strategy)
Adiciona uma estratégia de repetição ao cliente.
Parâmetros:
Retornos:
withSerializerAdapter
public RestClient.Builder withSerializerAdapter(SerializerAdapter serializerAdapter)
Define o adaptador de serialização.
Parâmetros:
Retornos:
withUserAgent
public RestClient.Builder withUserAgent(String userAgent)
Define o cabeçalho do agente do usuário.
Parâmetros:
Retornos: