RestClient.Builder 类

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

public static class RestClient.Builder

用于生成 REST 客户端的生成器类。

构造函数摘要

构造函数 说明
Builder()

使用服务的基 URL 创建生成器的实例。

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

使用基 URL 和 2 个自定义生成器创建生成器的实例。

方法摘要

修饰符和类型 方法和描述
RestClient build()

使用所有当前配置生成 Rest客户端。

Builder useHttpClientThreadPool(boolean useHttpClientThreadPool)

设置在 OkHttp 客户端还是 RxJava 计划程序中使用线程池。

Builder withBaseUrl(Environment environment, Environment.Endpoint endpoint)

使用环境中的默认值设置基 URL。

Builder withBaseUrl(String baseUrl)

设置动态基 URL。

Builder withCallbackExecutor(Executor executor)

设置要运行的异步回调的执行程序。

Builder withConnectionPool(ConnectionPool connectionPool)

设置 Http 客户端的连接池。

Builder withConnectionTimeout(long timeout, TimeUnit unit)

在 HTTP 客户端上设置连接超时。

Builder withCredentials(ServiceClientCredentials credentials)

设置凭据。

Builder withDispatcher(Dispatcher dispatcher)

设置 OkHttp 客户端中使用的调度程序。

Builder withInterceptor(Interceptor interceptor)

添加 Http 客户端管道的拦截器。

Builder withLogLevel(LogLevel logLevel)

设置 HTTP 日志级别。

Builder withMaxIdleConnections(int maxIdleConnections)

已放弃

设置 HTTP 客户端的最大空闲连接。

Builder withNetworkInterceptor(Interceptor networkInterceptor)

添加 Http 客户端管道的网络层的拦截器。

Builder withProxy(Proxy proxy)

设置 HTTP 客户端的代理。

Builder withProxyAuthenticator(Authenticator proxyAuthenticator)

设置 HTTP 客户端的代理验证器。

Builder withReadTimeout(long timeout, TimeUnit unit)

在 HTTP 客户端上设置读取超时。

Builder withResponseBuilderFactory(ResponseBuilder.Factory responseBuilderFactory)

设置响应生成器工厂。

Builder withRetryStrategy(RetryStrategy strategy)

将重试策略添加到客户端。

Builder withSerializerAdapter(SerializerAdapter<?> serializerAdapter)

设置序列化适配器。

Builder withUserAgent(String userAgent)

设置用户代理标头。

方法继承自 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

构造函数详细信息

Builder

public Builder()

使用服务的基 URL 创建生成器的实例。

Builder

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

使用基 URL 和 2 个自定义生成器创建生成器的实例。

参数:

httpClientBuilder - 要生成 OkHttpClient的生成器。
retrofitBuilder - 要生成 Retrofit的生成器。

方法详细信息

build

public RestClient build()

使用所有当前配置生成 RestClient。

返回:

useHttpClientThreadPool

public RestClient.Builder useHttpClientThreadPool(boolean useHttpClientThreadPool)

设置是使用 OkHttp 客户端还是 RxJava 计划程序中的线程池。 如果设置为 true,将使用 OkHttp 客户端中的线程池。 默认值为 false。

参数:

useHttpClientThreadPool - 是否在 Okhttp 客户端中使用线程池。 默认值为 false。

返回:

用于链接的生成器本身

withBaseUrl

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

使用环境中的默认值设置基 URL。

参数:

environment - 要使用的环境
endpoint - 应用程序正在访问的环境终结点

返回:

用于链接的生成器本身

withBaseUrl

public RestClient.Builder withBaseUrl(String baseUrl)

设置动态基 URL。

参数:

baseUrl - 要使用的基 URL。

返回:

用于链接的生成器本身。

withCallbackExecutor

public RestClient.Builder withCallbackExecutor(Executor executor)

设置要运行的异步回调的执行程序。

参数:

executor - 要执行回调的执行程序。

返回:

用于链接的生成器本身

withConnectionPool

public RestClient.Builder withConnectionPool(ConnectionPool connectionPool)

设置 Http 客户端的连接池。

参数:

connectionPool - 要使用的 OkHttp 3 连接池

返回:

用于链接的生成器本身

withConnectionTimeout

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

在 HTTP 客户端上设置连接超时。 默认值为 10 秒。

参数:

timeout - 超时数值
unit - 数值的时间单位

返回:

用于链接的生成器本身

withCredentials

public RestClient.Builder withCredentials(ServiceClientCredentials credentials)

设置凭据。

参数:

credentials - 凭据对象。

返回:

用于链接的生成器本身。

withDispatcher

public RestClient.Builder withDispatcher(Dispatcher dispatcher)

设置 OkHttp 客户端中使用的调度程序。 这也是设置用于执行 HTTP 请求的线程池的位置。

参数:

dispatcher - 要使用的调度程序

返回:

用于链接的生成器本身

withInterceptor

public RestClient.Builder withInterceptor(Interceptor interceptor)

添加 Http 客户端管道的拦截器。

参数:

interceptor - 要添加的侦听器。

返回:

用于链接的生成器本身。

withLogLevel

public RestClient.Builder withLogLevel(LogLevel logLevel)

设置 HTTP 日志级别。

参数:

logLevel - LogLevel 枚举。

返回:

用于链接的生成器本身。

withMaxIdleConnections


public RestClient.Builder withMaxIdleConnections(int maxIdleConnections)

已放弃

设置 HTTP 客户端的最大空闲连接。 默认值为 5。

参数:

maxIdleConnections - 最大空闲连接数

返回:

用于链接的生成器本身

withNetworkInterceptor

public RestClient.Builder withNetworkInterceptor(Interceptor networkInterceptor)

添加 Http 客户端管道的网络层的拦截器。

参数:

networkInterceptor - 要添加的侦听器。

返回:

用于链接的生成器本身。

withProxy

public RestClient.Builder withProxy(Proxy proxy)

设置 HTTP 客户端的代理。

参数:

proxy - 要使用的代理

返回:

用于链接的生成器本身

withProxyAuthenticator

public RestClient.Builder withProxyAuthenticator(Authenticator proxyAuthenticator)

设置 HTTP 客户端的代理验证器。

参数:

proxyAuthenticator - 要使用的代理验证器

返回:

用于链接的生成器本身

withReadTimeout

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

在 HTTP 客户端上设置读取超时。 默认值为 10 秒。

参数:

timeout - 超时数值
unit - 数值的时间单位

返回:

用于链接的生成器本身

withResponseBuilderFactory

public RestClient.Builder withResponseBuilderFactory(ResponseBuilder.Factory responseBuilderFactory)

设置响应生成器工厂。

参数:

responseBuilderFactory - 响应生成器工厂

返回:

用于链接的生成器本身

withRetryStrategy

public RestClient.Builder withRetryStrategy(RetryStrategy strategy)

将重试策略添加到客户端。

参数:

strategy - 要添加的重试策略

返回:

用于链接的生成器本身

withSerializerAdapter

public RestClient.Builder withSerializerAdapter(SerializerAdapter serializerAdapter)

设置序列化适配器。

参数:

serializerAdapter - 序列化程序的适配器

返回:

用于链接的生成器本身

withUserAgent

public RestClient.Builder withUserAgent(String userAgent)

设置用户代理标头。

参数:

userAgent - 用户代理标头。

返回:

用于链接的生成器本身。

适用于