com.azure.core.util

Class HttpClientOptions

java.lang.Object

com.azure.core.util.ClientOptions

com.azure.core.util.HttpClientOptions

public final class HttpClientOptions
extends ClientOptions

General configuration options for HttpClients.

Constructor Summary

Constructors

Constructor and Description
HttpClientOptions()

Method Summary

Modifier and Type	Method and Description
Configuration	getConfiguration() Gets the configuration store that the HttpClient will use.
ProxyOptions	getProxyOptions() Gets the proxy options that the HttpClient will use.
Duration	getReadTimeout() Gets the read timeout duration used when reading the server response.
Duration	getResponseTimeout() Gets the response timeout duration used when waiting for a server to reply.
Duration	getWriteTimeout() Gets the write timeout for a request to be sent.
HttpClientOptions	readTimeout(Duration readTimeout) Sets the read timeout duration used when reading the server response.
HttpClientOptions	responseTimeout(Duration responseTimeout) Sets the response timeout duration used when waiting for a server to reply.
HttpClientOptions	setApplicationId(String applicationId) Sets the application ID.
HttpClientOptions	setConfiguration(Configuration configuration) Sets the configuration store that the HttpClient will use.
HttpClientOptions	setHeaders(Iterable<Header> headers) Sets the Headers.
HttpClientOptions	setProxyOptions(ProxyOptions proxyOptions) Sets the proxy options that the HttpClient will use.
HttpClientOptions	setWriteTimeout(Duration writeTimeout) Sets the write timeout for a request to be sent.

Methods inherited from class com.azure.core.util.ClientOptions

getApplicationId, getHeaders

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HttpClientOptions

public HttpClientOptions()

Method Detail

setApplicationId

public HttpClientOptions setApplicationId(String applicationId)

Description copied from class: ClientOptions

Sets the application ID.

The applicationId is used to configure UserAgentPolicy for telemetry/monitoring purposes.

See Azure Core: Telemetry policy for additional information.

Code Samples

Create ClientOptions with application ID 'myApplicationId'

 ClientOptions clientOptions = new ClientOptions()
     .setApplicationId("myApplicationId");
 

Overrides:

setApplicationId in class ClientOptions

Parameters:

applicationId - The application ID.

Returns:

The updated ClientOptions object.

setHeaders

public HttpClientOptions setHeaders(Iterable<Header> headers)

Description copied from class: ClientOptions

Sets the Headers.

The passed headers are applied to each request sent with the client.

This overwrites all previously set headers.

Code Samples

Create ClientOptions with Header 'myCustomHeader':'myStaticValue'

 ClientOptions clientOptions = new ClientOptions()
     .setHeaders(Collections.singletonList(new Header("myCustomHeader", "myStaticValue")));
 

Overrides:

setHeaders in class ClientOptions

Parameters:

headers - The headers.

Returns:

The updated ClientOptions object.

setProxyOptions

public HttpClientOptions setProxyOptions(ProxyOptions proxyOptions)

Sets the proxy options that the HttpClient will use.

Parameters:

proxyOptions - The proxy options to use.

Returns:

The updated HttpClientOptions object.

getProxyOptions

public ProxyOptions getProxyOptions()

Gets the proxy options that the HttpClient will use.

Returns:

The proxy options to use.

setConfiguration

public HttpClientOptions setConfiguration(Configuration configuration)

Sets the configuration store that the HttpClient will use.

Parameters:

configuration - The configuration store to use.

Returns:

The updated HttpClientOptions object.

getConfiguration

public Configuration getConfiguration()

Gets the configuration store that the HttpClient will use.

Returns:

The configuration store to use.

setWriteTimeout

public HttpClientOptions setWriteTimeout(Duration writeTimeout)

Sets the write timeout for a request to be sent.

The write timeout does not apply to the entire request but to each emission being sent over the wire. For example a request body which emits 10 8KB buffers will trigger 10 write operations, the outbound buffer will be periodically checked to determine if it is still draining.

If writeTimeout is null a 60 second timeout will be used, if it is a Duration less than or equal to zero then no write timeout will be applied. When applying the timeout the greater of one millisecond and the value of writeTimeout will be used.

Parameters:

writeTimeout - Write operation timeout duration.

Returns:

The updated HttpClientOptions object.

getWriteTimeout

public Duration getWriteTimeout()

Gets the write timeout for a request to be sent.

Returns:

The write timeout of a request to be sent.

responseTimeout

public HttpClientOptions responseTimeout(Duration responseTimeout)

Sets the response timeout duration used when waiting for a server to reply.

The response timeout begins once the request write completes and finishes once the first response read is triggered when the server response is received.

If responseTimeout is null a 60 second timeout will be used, if it is a Duration less than or equal to zero then no timeout will be applied to the response. When applying the timeout the greater of one millisecond and the value of responseTimeout will be used.

Parameters:

responseTimeout - Response timeout duration.

Returns:

The updated HttpClientOptions object.

getResponseTimeout

public Duration getResponseTimeout()

Gets the response timeout duration used when waiting for a server to reply.

Returns:

The response timeout duration.

readTimeout

public HttpClientOptions readTimeout(Duration readTimeout)

Sets the read timeout duration used when reading the server response.

The read timeout begins once the first response read is triggered after the server response is received. This timeout triggers periodically but won't fire its operation if another read operation has completed between when the timeout is triggered and completes.

If readTimeout is null a 60 second timeout will be used, if it is a Duration less than or equal to zero then no timeout period will be applied to response read. When applying the timeout the greater of one millisecond and the value of readTimeout will be used.

Parameters:

readTimeout - Read timeout duration.

Returns:

The updated HttpClientOptions object.

getReadTimeout

public Duration getReadTimeout()

Gets the read timeout duration used when reading the server response.

Returns:

The read timeout duration.