RestClient.Builder Klasse

  • Referenz
Paket:
com.microsoft.bot.restclient
Maven-Artefakt:
com.microsoft.bot:bot-connector:4.14.3
  • java.lang.Object
    • com.microsoft.bot.restclient.RestClient.Builder

public static class RestClient.Builder

Die Generatorklasse zum Erstellen eines REST-Clients.

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
Builder()

Erstellt eine Instanz des Generators mit einer Basis-URL zum Dienst.
Builder(OkHttpClient.Builder httpClientBuilder, Retrofit.Builder retrofitBuilder)

Erstellt eine Instanz des Generators mit einer Basis-URL und zwei benutzerdefinierten Generatoren.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
RestClient build()

Erstellen Sie einen RestClient mit allen aktuellen Konfigurationen.
Builder useHttpClientThreadPool(boolean useHttpClientThreadPool)

Legt fest, ob der Threadpool in OkHttp-Client oder Rx-Java-Scheduler verwendet werden soll.
Builder withBaseUrl(Environment environment, Environment.Endpoint endpoint)

Legt die Basis-URL mit der Standardeinstellung aus der Umgebung fest.
Builder withBaseUrl(String baseUrl)

Legt die dynamische Basis-URL fest.
Builder withCallbackExecutor(Executor executor)

Legt den Executor für asynchrone Rückrufe fest, die ausgeführt werden sollen.
Builder withConnectionPool(ConnectionPool connectionPool)

Legt den Verbindungspool für den Http-Client fest.
Builder withConnectionTimeout(long timeout, TimeUnit unit)

Legen Sie das Verbindungstimeout auf dem HTTP-Client fest.
Builder withCredentials(ServiceClientCredentials credentials)

Legt die Anmeldeinformationen fest.
Builder withDispatcher(Dispatcher dispatcher)

Legt den Verteiler fest, der in okHttp-Client verwendet wird.
Builder withInterceptor(Interceptor interceptor)

Fügen Sie einen Interceptor der Http-Clientpipeline hinzu.
Builder withLogLevel(LogLevel logLevel)

Legt die HTTP-Protokollebene fest.
Builder withMaxIdleConnections(int maxIdleConnections)

Als veraltet markiert

Legen Sie die maximalen Leerlaufverbindungen für den HTTP-Client fest.
Builder withNetworkInterceptor(Interceptor networkInterceptor)

Fügen Sie einen Interceptor der Netzwerkschicht der Http-Clientpipeline hinzu.
Builder withProxy(Proxy proxy)

Legt den Proxy für den HTTP-Client fest.
Builder withProxyAuthenticator(Authenticator proxyAuthenticator)

Legt den Proxyauthentifikator für den HTTP-Client fest.
Builder withReadTimeout(long timeout, TimeUnit unit)

Legen Sie das Lesetimeout auf dem HTTP-Client fest.
Builder withResponseBuilderFactory(ResponseBuilder.Factory responseBuilderFactory)

Legt die Factory des Antwort-Generators fest.
Builder withRetryStrategy(RetryStrategy strategy)

Fügt dem Client eine Wiederholungsstrategie hinzu.
Builder withSerializerAdapter(SerializerAdapter<?> serializerAdapter)

Legt den Serialisierungsadapter fest.
Builder withUserAgent(String userAgent)

Legt den Benutzer-Agent-Header fest.

Geerbte Methoden von 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

Details zum Konstruktor

Builder

public Builder()

Erstellt eine Instanz des Generators mit einer Basis-URL zum Dienst.

Builder

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

Erstellt eine Instanz des Generators mit einer Basis-URL und zwei benutzerdefinierten Generatoren.

Parameter:

httpClientBuilder - der Generator zum Erstellen einer OkHttpClient.
retrofitBuilder - der Generator zum Erstellen einer Retrofit.

Details zur Methode

build

public RestClient build()

Erstellen Sie einen RestClient mit allen aktuellen Konfigurationen.

Gibt zurück:

useHttpClientThreadPool

public RestClient.Builder useHttpClientThreadPool(boolean useHttpClientThreadPool)

Legt fest, ob der Threadpool in OkHttp-Client- oder RxJava-Schedulern verwendet werden soll. Wenn dieser Wert auf "true" festgelegt ist, wird der Threadpool im OkHttp-Client verwendet. Der Standardwert ist "false".

Parameter:

useHttpClientThreadPool - gibt an, ob der Threadpool im Okhttp-Client verwendet werden soll. Der Standardwert ist "false".

Gibt zurück:

der Generator selbst zur Verkettung

withBaseUrl

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

Legt die Basis-URL mit der Standardeinstellung aus der Umgebung fest.

Parameter:

environment - die zu verwendende Umgebung
endpoint - der Umgebungsendpunkt, auf den die Anwendung zugreift

Gibt zurück:

der Generator selbst zur Verkettung

withBaseUrl

public RestClient.Builder withBaseUrl(String baseUrl)

Legt die dynamische Basis-URL fest.

Parameter:

baseUrl - die zu verwendende Basis-URL.

Gibt zurück:

der Generator selbst zur Verkettung.

withCallbackExecutor

public RestClient.Builder withCallbackExecutor(Executor executor)

Legt den Executor für asynchrone Rückrufe fest, die ausgeführt werden sollen.

Parameter:

executor - der Executor zum Ausführen der Rückrufe.

Gibt zurück:

der Generator selbst zur Verkettung

withConnectionPool

public RestClient.Builder withConnectionPool(ConnectionPool connectionPool)

Legt den Verbindungspool für den Http-Client fest.

Parameter:

connectionPool - der zu verwendende OkHttp 3-Verbindungspool

Gibt zurück:

der Generator selbst zur Verkettung

withConnectionTimeout

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

Legen Sie das Verbindungstimeout auf dem HTTP-Client fest. Der Standardwert ist 10 Sekunden.

Parameter:

timeout - der numerische Timeoutwert
unit - die Zeiteinheit für den numerischen Wert

Gibt zurück:

der Generator selbst zur Verkettung

withCredentials

public RestClient.Builder withCredentials(ServiceClientCredentials credentials)

Legt die Anmeldeinformationen fest.

Parameter:

credentials - das Credentials-Objekt.

Gibt zurück:

der Generator selbst zur Verkettung.

withDispatcher

public RestClient.Builder withDispatcher(Dispatcher dispatcher)

Legt den Dispatcher fest, der im OkHttp-Client verwendet wird. Hier wird auch der Threadpool für die Ausführung von HTTP-Anforderungen festgelegt.

Parameter:

dispatcher - der zu verwendende Verteiler

Gibt zurück:

der Generator selbst zur Verkettung

withInterceptor

public RestClient.Builder withInterceptor(Interceptor interceptor)

Fügen Sie einen Interceptor der Http-Clientpipeline hinzu.

Parameter:

interceptor - der hinzuzufügende Interceptor.

Gibt zurück:

der Generator selbst zur Verkettung.

withLogLevel

public RestClient.Builder withLogLevel(LogLevel logLevel)

Legt die HTTP-Protokollebene fest.

Parameter:

logLevel - die LogLevel Enumeration.

Gibt zurück:

der Generator selbst zur Verkettung.

withMaxIdleConnections


public RestClient.Builder withMaxIdleConnections(int maxIdleConnections)

Als veraltet markiert

Legen Sie die maximalen Leerlaufverbindungen für den HTTP-Client fest. Der Standardwert ist 5.

Parameter:

maxIdleConnections - maximale Leerlaufverbindungen

Gibt zurück:

der Generator selbst zur Verkettung

withNetworkInterceptor

public RestClient.Builder withNetworkInterceptor(Interceptor networkInterceptor)

Fügen Sie einen Interceptor der Netzwerkschicht der Http-Clientpipeline hinzu.

Parameter:

networkInterceptor - der hinzuzufügende Interceptor.

Gibt zurück:

der Generator selbst zur Verkettung.

withProxy

public RestClient.Builder withProxy(Proxy proxy)

Legt den Proxy für den HTTP-Client fest.

Parameter:

proxy - der zu verwendende Proxy

Gibt zurück:

der Generator selbst zur Verkettung

withProxyAuthenticator

public RestClient.Builder withProxyAuthenticator(Authenticator proxyAuthenticator)

Legt den Proxyauthentifikator für den HTTP-Client fest.

Parameter:

proxyAuthenticator - der zu verwendende Proxyauthentifikator

Gibt zurück:

der Generator selbst zur Verkettung

withReadTimeout

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

Legen Sie das Lesetimeout auf dem HTTP-Client fest. Der Standardwert ist 10 Sekunden.

Parameter:

timeout - der numerische Timeoutwert
unit - die Zeiteinheit für den numerischen Wert

Gibt zurück:

der Generator selbst zur Verkettung

withResponseBuilderFactory

public RestClient.Builder withResponseBuilderFactory(ResponseBuilder.Factory responseBuilderFactory)

Legt die Factory des Antwort-Generators fest.

Parameter:

responseBuilderFactory - Die Antwort-Generator-Factory

Gibt zurück:

der Generator selbst zur Verkettung

withRetryStrategy

public RestClient.Builder withRetryStrategy(RetryStrategy strategy)

Fügt dem Client eine Wiederholungsstrategie hinzu.

Parameter:

strategy - die Wiederholungsstrategie zum Hinzufügen

Gibt zurück:

der Generator selbst zur Verkettung

withSerializerAdapter

public RestClient.Builder withSerializerAdapter(SerializerAdapter serializerAdapter)

Legt den Serialisierungsadapter fest.

Parameter:

serializerAdapter - adapter to a serializer

Gibt zurück:

der Generator selbst zur Verkettung

withUserAgent

public RestClient.Builder withUserAgent(String userAgent)

Legt den Benutzer-Agent-Header fest.

Parameter:

userAgent - der Benutzer-Agent-Header.

Gibt zurück:

der Generator selbst zur Verkettung.

Gilt für: