com.azure.identity

Class IdentityClientOptions

java.lang.Object

com.azure.identity.IdentityClientOptions

public final class IdentityClientOptions
extends java.lang.Object

Options to configure the IdentityClient.

Constructor Summary

Constructors

Constructor and Description
IdentityClientOptions() Creates an instance of IdentityClientOptions with default settings.

Method Summary

Modifier and Type	Method and Description
java.lang.String	authorityHost()
IdentityClientOptions	authorityHost(java.lang.String authorityHost) Specifies the Azure Active Directory endpoint to acquire tokens.
int	maxRetry()
IdentityClientOptions	maxRetry(int maxRetry) Specifies the max number of retries when an authentication request fails.
ProxyOptions	proxyOptions()
IdentityClientOptions	proxyOptions(ProxyOptions proxyOptions) Specifies he options for proxy configuration.
java.util.function.Function<java.lang.Integer,java.lang.Integer>	retryTimeout()
IdentityClientOptions	retryTimeout(java.util.function.Function<java.lang.Integer,java.lang.Integer> retryTimeout) Specifies a Function to calculate seconds of timeout on every retried request.

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentityClientOptions

public IdentityClientOptions()

Creates an instance of IdentityClientOptions with default settings.

Method Detail

authorityHost

public java.lang.String authorityHost()

Returns:

the Azure Active Directory endpoint to acquire tokens.

authorityHost

public IdentityClientOptions authorityHost(java.lang.String authorityHost)

Specifies the Azure Active Directory endpoint to acquire tokens.

Parameters:

authorityHost - the Azure Active Directory endpoint

Returns:

IdentityClientOptions

maxRetry

public int maxRetry()

Returns:

the max number of retries when an authentication request fails.

maxRetry

public IdentityClientOptions maxRetry(int maxRetry)

Specifies the max number of retries when an authentication request fails.

Parameters:

maxRetry - the number of retries

Returns:

IdentityClientOptions

retryTimeout

public java.util.function.Function<java.lang.Integer,java.lang.Integer> retryTimeout()

Returns:

a Function to calculate seconds of timeout on every retried request.

retryTimeout

public IdentityClientOptions retryTimeout(java.util.function.Function<java.lang.Integer,java.lang.Integer> retryTimeout)

Specifies a Function to calculate seconds of timeout on every retried request.

Parameters:

retryTimeout - the Function that returns a timeout in seconds given the number of retry

Returns:

IdentityClientOptions

proxyOptions

public ProxyOptions proxyOptions()

Returns:

the options for proxy configuration.

proxyOptions

public IdentityClientOptions proxyOptions(ProxyOptions proxyOptions)

Specifies he options for proxy configuration.

Parameters:

proxyOptions - the options for proxy configuration

Returns:

IdentityClientOptions