AzureConfigurable<T> Interface

Type Parameters

T

the actual type of the interface extending this interface

public interface AzureConfigurable

The base interface for allowing configurations to be made on the HTTP client.

Method Summary

Modifier and Type Method and Description
abstract T withAuxiliaryCredential(TokenCredential token)

Set the cross-tenant auxiliary credentials for Azure which can hold up to three.

abstract T withAuxiliaryCredentials(List<TokenCredential> tokens)

Set the cross-tenant auxiliary credentials for Azure which can hold up to three.

abstract T withConfiguration(Configuration configuration)

Sets the configuration.

abstract T withHttpClient(HttpClient httpClient)

Sets the HTTP client.

abstract T withLogLevel(HttpLogDetailLevel logLevel)

Sets the logging detail level on the HTTP client.

abstract T withLogOptions(HttpLogOptions logOptions)

Set the logging options on the HTTP client.

abstract T withPolicy(HttpPipelinePolicy policy)

Plug in a policy into the HTTP pipeline.

abstract T withRetryOptions(RetryOptions retryOptions)

Sets the retry options for the HTTP pipeline retry policy.

abstract T withRetryPolicy(RetryPolicy retryPolicy)

Sets the retry policy used in HTTP pipeline.

abstract T withScope(String scope)

Sets the credential scope.

abstract T withScopes(List<String> scopes)

Sets the credential scopes.

Method Details

withAuxiliaryCredential

public abstract T withAuxiliaryCredential(TokenCredential token)

Set the cross-tenant auxiliary credentials for Azure which can hold up to three.

Parameters:

token - the auxiliary credential

Returns:

the configurable object itself

withAuxiliaryCredentials

public abstract T withAuxiliaryCredentials(List tokens)

Set the cross-tenant auxiliary credentials for Azure which can hold up to three.

Parameters:

tokens - the auxiliary credentials

Returns:

the configurable object itself

withConfiguration

public abstract T withConfiguration(Configuration configuration)

Sets the configuration.

Parameters:

configuration - the proxy to use

Returns:

the configurable object itself for chaining

withHttpClient

public abstract T withHttpClient(HttpClient httpClient)

Sets the HTTP client.

Parameters:

httpClient - the HTTP client

Returns:

the configurable object itself for chaining

withLogLevel

public abstract T withLogLevel(HttpLogDetailLevel logLevel)

Sets the logging detail level on the HTTP client. If set, this configure will override HttpLogOptions#setLogLevel(HttpLogDetailLevel) configure of withLogOptions(HttpLogOptions logOptions).

Parameters:

logLevel - the logging level

Returns:

the configurable object itself

withLogOptions

public abstract T withLogOptions(HttpLogOptions logOptions)

Set the logging options on the HTTP client.

Parameters:

logOptions - the HttpLogDetailLevel logging options

Returns:

the configurable object itself

withPolicy

public abstract T withPolicy(HttpPipelinePolicy policy)

Plug in a policy into the HTTP pipeline.

Parameters:

policy - the policy to plug in

Returns:

the configurable object itself

withRetryOptions

public abstract T withRetryOptions(RetryOptions retryOptions)

Sets the retry options for the HTTP pipeline retry policy.

This setting has no effect, if retry policy is set via withRetryPolicy(RetryPolicy retryPolicy).

Parameters:

retryOptions - the retry options for the HTTP pipeline retry policy.

Returns:

the configurable object itself.

withRetryPolicy

public abstract T withRetryPolicy(RetryPolicy retryPolicy)

Sets the retry policy used in HTTP pipeline.

Parameters:

retryPolicy - the retry policy

Returns:

the configurable object itself for chaining

withScope

public abstract T withScope(String scope)

Sets the credential scope.

Parameters:

scope - the credential scope

Returns:

the configurable object itself for chaining

withScopes

public abstract T withScopes(List scopes)

Sets the credential scopes.

Parameters:

scopes - the credential scope

Returns:

the configurable object itself for chaining

Applies to