com.azure.core.util

Class ClientOptions

java.lang.Object

com.azure.core.util.ClientOptions

public final class ClientOptions
extends Object

This class represents various options to be set on the client. A user can set applicationId and a list of Header on the ClientOptions.

Headers

The Header could be set using setHeaders. For example if you set a header, Header("name", "value"), on ClientOptions, it will be set on the request being sent to Azure Service.

ApplicationId

The applicationId is used to configure UserAgentPolicy for telemetry/monitoring purpose. It can be set using ClientOptions#setApplicationId(String).

More About Azure Core: Telemetry policy

Constructor Summary

Constructors

Constructor and Description
ClientOptions()

Method Summary

Modifier and Type	Method and Description
String	getApplicationId() Gets the applicationId.
Iterable<Header>	getHeaders() Gets a Iterable representation of the Header.
ClientOptions	setApplicationId(String applicationId) Sets the applicationId provided.
ClientOptions	setHeaders(Iterable<Header> headers) Sets the headers, overwriting all previously set headers in the process.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientOptions

public ClientOptions()

Method Detail

getApplicationId

public String getApplicationId()

Gets the applicationId.

Returns:

The applicationId.

setApplicationId

public ClientOptions setApplicationId(String applicationId)

Sets the applicationId provided. The applicationId is used to configure UserAgentPolicy for telemetry/monitoring purpose. It can be set using ClientOptions#setApplicationId(String).

More About Azure Core: Telemetry policy

Parameters:

applicationId - to be set.

Returns:

updated ClientOptions.

Throws:

IllegalArgumentException - If applicationId contains space or larger than 24 in length.

setHeaders

public ClientOptions setHeaders(Iterable<Header> headers)

Sets the headers, overwriting all previously set headers in the process. For example if you set a header, Header("name", "value"), on ClientOptions, it will be set on the request being sent to Azure Service.

Parameters:

headers - to be set on the request being sent to Azure Service.

Returns:

updated ClientOptions.

getHeaders

public Iterable<Header> getHeaders()

Gets a Iterable representation of the Header.

Returns:

the headers. If Header is not set previously, it returns an empty list (immutable).