RestClient.Builder Класс

  • Ссылка
Пакет:
com.microsoft.bot.restclient
Артефакт Maven:
com.microsoft.bot:bot-connector:4.14.3
  • 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)

Задает, следует ли использовать пул потоков в ОКклиента Http или Rxпланировщиков Java.
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)

Задает диспетчер, используемый в ОКhttp-клиенте.
Builder withInterceptor(Interceptor interceptor)

Добавьте перехватчик конвейера клиента Http.
Builder withLogLevel(LogLevel logLevel)

Задает уровень журнала HTTP.
Builder withMaxIdleConnections(int maxIdleConnections)

Не рекомендуется

вместо этого используйте withConnectionPool(ConnectionPool connectionPool)

Задайте максимальное количество неактивных подключений для 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)

Не рекомендуется

вместо этого используйте withConnectionPool(ConnectionPool connectionPool)

Задайте максимальное количество неактивных подключений для 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 - Заголовок агента пользователя.

Возвращаемое значение:

Сам построитель для цепочки.

Применяется к