MetricsAdvisorClientBuilder Class

Package:

com.azure.ai.metricsadvisor

Maven Artifact:

com.azure:azure-ai-metricsadvisor:1.2.3

• java.lang.Object
• • com.azure.ai.metricsadvisor.MetricsAdvisorClientBuilder

Implements

ConfigurationTrait<MetricsAdvisorClientBuilder> EndpointTrait<MetricsAdvisorClientBuilder> HttpTrait<MetricsAdvisorClientBuilder> TokenCredentialTrait<MetricsAdvisorClientBuilder>

public final class MetricsAdvisorClientBuilder
implements ConfigurationTrait<MetricsAdvisorClientBuilder>, EndpointTrait<MetricsAdvisorClientBuilder>, HttpTrait<MetricsAdvisorClientBuilder>, TokenCredentialTrait<MetricsAdvisorClientBuilder>

This class provides a fluent builder API to help instantiation of MetricsAdvisorClient and MetricsAdvisorAsyncClient, call buildClient() buildClient} and buildAsyncClient() respectively to construct an instance of the desired client.

The client needs the service endpoint of the Azure Metrics Advisor to access the resource service. credential(MetricsAdvisorKeyCredential metricsAdvisorKeyCredential) gives the builder access to credential.

Instantiating an asynchronous Metrics Advisor Client

MetricsAdvisorAsyncClient metricsAdvisorAsyncClient =
     new MetricsAdvisorClientBuilder()
         .credential(new MetricsAdvisorKeyCredential("{subscription_key}", "{api_key}"))
         .endpoint("{endpoint}")
         .buildAsyncClient();

Instantiating a synchronous Metrics Advisor Client

MetricsAdvisorClient metricsAdvisorClient =
     new MetricsAdvisorClientBuilder()
         .credential(new MetricsAdvisorKeyCredential("{subscription_key}", "{api_key}"))
         .endpoint("{endpoint}")
         .buildClient();

Another way to construct the client is using a HttpPipeline. The pipeline gives the client an authenticated way to communicate with the service. Set the pipeline with pipeline(HttpPipeline httpPipeline) and set the service endpoint with endpoint(String endpoint). Using a pipeline requires additional setup but allows for finer control on how the MetricsAdvisorClient and MetricsAdvisorAsyncClient is built.

HttpPipeline pipeline = new HttpPipelineBuilder()
     .policies(/* add policies */)
     .build();

 MetricsAdvisorClient metricsAdvisorClient =
     new MetricsAdvisorClientBuilder()
         .credential(new MetricsAdvisorKeyCredential("{subscription_key}", "{api_key}"))
         .endpoint("{endpoint}")
         .pipeline(pipeline)
         .buildClient();

Constructor Summary

Constructor	Description
MetricsAdvisorClientBuilder()	The constructor with defaults.

Method Summary

Modifier and Type	Method and Description
MetricsAdvisorClientBuilder	addPolicy(HttpPipelinePolicy policy) Adds a HttpPipelinePolicy to apply on each request sent.
MetricsAdvisorAsyncClient	buildAsyncClient() Creates a MetricsAdvisorAsyncClient based on options set in the builder.
MetricsAdvisorClient	buildClient() Creates a MetricsAdvisorClient based on options set in the builder.
MetricsAdvisorClientBuilder	clientOptions(ClientOptions clientOptions) Allows for setting common properties such as application ID, headers, proxy configuration, etc.
MetricsAdvisorClientBuilder	configuration(Configuration configuration) Sets the configuration store that is used during construction of the service client.
MetricsAdvisorClientBuilder	credential(MetricsAdvisorKeyCredential metricsAdvisorKeyCredential) Sets the MetricsAdvisorKeyCredential to use when authenticating HTTP requests for this MetricsAdvisorClientBuilder.
MetricsAdvisorClientBuilder	credential(TokenCredential tokenCredential) Sets the TokenCredential used to authorize requests sent to the service.
MetricsAdvisorClientBuilder	endpoint(String endpoint) Sets the service endpoint for the Azure Metrics Advisor instance.
MetricsAdvisorClientBuilder	httpClient(HttpClient client) Sets the HttpClient to use for sending and receiving requests to and from the service.
MetricsAdvisorClientBuilder	httpLogOptions(HttpLogOptions logOptions) Sets the HttpLogOptions to use when sending and receiving requests to and from the service.
MetricsAdvisorClientBuilder	pipeline(HttpPipeline httpPipeline) Sets the HttpPipeline to use for the service client.
MetricsAdvisorClientBuilder	retryOptions(RetryOptions retryOptions) Sets the RetryOptions for all the requests made through the client.
MetricsAdvisorClientBuilder	retryPolicy(RetryPolicy retryPolicy) Sets the RetryPolicy#RetryPolicy() that is used when each request is sent.
MetricsAdvisorClientBuilder	serviceVersion(MetricsAdvisorServiceVersion version) Sets the MetricsAdvisorServiceVersion that is used when making API requests.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

MetricsAdvisorClientBuilder

public MetricsAdvisorClientBuilder()

The constructor with defaults.

Method Details

addPolicy

public MetricsAdvisorClientBuilder addPolicy(HttpPipelinePolicy policy)

Adds a HttpPipelinePolicy to apply on each request sent.

Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

Parameters:

policy - A HttpPipelinePolicy.

Returns:

The updated MetricsAdvisorClientBuilder object.

buildAsyncClient

public MetricsAdvisorAsyncClient buildAsyncClient()

Creates a MetricsAdvisorAsyncClient based on options set in the builder. Every time buildAsyncClient() is called a new instance of MetricsAdvisorAsyncClient is created.

If pipeline(HttpPipeline httpPipeline) is set, then the pipeline and endpoint(String endpoint) are used to create the MetricsAdvisorClient. All other builder settings are ignored.

Returns:

A MetricsAdvisorAsyncClient with the options set from the builder.

buildClient

public MetricsAdvisorClient buildClient()

Creates a MetricsAdvisorClient based on options set in the builder. Every time buildClient() is called a new instance of MetricsAdvisorClient is created.

If pipeline(HttpPipeline httpPipeline) is set, then the pipeline and endpoint(String endpoint) are used to create the MetricsAdvisorClient. All other builder settings are ignored.

Returns:

A MetricsAdvisorClient with the options set from the builder.

clientOptions

public MetricsAdvisorClientBuilder clientOptions(ClientOptions clientOptions)

Allows for setting common properties such as application ID, headers, proxy configuration, etc. Note that it is recommended that this method be called with an instance of the HttpClientOptions class (a subclass of the ClientOptions base class). The HttpClientOptions subclass provides more configuration options suitable for HTTP clients, which is applicable for any class that implements this HttpTrait interface.

Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

Parameters:

clientOptions - A configured instance of HttpClientOptions.

Returns:

The updated MetricsAdvisorClientBuilder object.

configuration

public MetricsAdvisorClientBuilder configuration(Configuration configuration)

Sets the configuration store that is used during construction of the service client.

The default configuration store is a clone of the global configuration store, use NONE to bypass using configuration settings during construction.

Parameters:

configuration - The configuration store used to.

Returns:

The updated MetricsAdvisorClientBuilder object.

credential

public MetricsAdvisorClientBuilder credential(MetricsAdvisorKeyCredential metricsAdvisorKeyCredential)

Sets the MetricsAdvisorKeyCredential to use when authenticating HTTP requests for this MetricsAdvisorClientBuilder.

Parameters:

metricsAdvisorKeyCredential - MetricsAdvisorKeyCredential API key credential

Returns:

The updated MetricsAdvisorClientBuilder object.

credential

public MetricsAdvisorClientBuilder credential(TokenCredential tokenCredential)

Sets the TokenCredential used to authorize requests sent to the service. Refer to the Azure SDK for Java identity and authentication documentation for more details on proper usage of the TokenCredential type.

Parameters:

tokenCredential - TokenCredential used to authorize requests sent to the service.

Returns:

The updated MetricsAdvisorClientBuilder object.

endpoint

public MetricsAdvisorClientBuilder endpoint(String endpoint)

Sets the service endpoint for the Azure Metrics Advisor instance.

Parameters:

endpoint - The URL of the Azure Metrics Advisor instance service requests to and receive responses from.

Returns:

The updated MetricsAdvisorClientBuilder object.

httpClient

public MetricsAdvisorClientBuilder httpClient(HttpClient client)

Sets the HttpClient to use for sending and receiving requests to and from the service.

Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

Parameters:

client - The HttpClient to use for requests.

Returns:

The updated MetricsAdvisorClientBuilder object.

httpLogOptions

public MetricsAdvisorClientBuilder httpLogOptions(HttpLogOptions logOptions)

Sets the HttpLogOptions to use when sending and receiving requests to and from the service. If a logLevel is not provided, default value of HttpLogDetailLevel#NONE is set.

Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

Parameters:

logOptions - The HttpLogOptions to use when sending and receiving requests to and from the service.

Returns:

The updated MetricsAdvisorClientBuilder object.

pipeline

public MetricsAdvisorClientBuilder pipeline(HttpPipeline httpPipeline)

Sets the HttpPipeline to use for the service client.

Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

If pipeline is set, all other settings are ignored, aside from endpoint(String endpoint) to build MetricsAdvisorAsyncClient or MetricsAdvisorClient.

Parameters:

httpPipeline - HttpPipeline to use for sending service requests and receiving responses.

Returns:

The updated MetricsAdvisorClientBuilder object.

retryOptions

public MetricsAdvisorClientBuilder retryOptions(RetryOptions retryOptions)

Sets the RetryOptions for all the requests made through the client.

Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

Setting this is mutually exclusive with using retryPolicy(RetryPolicy retryPolicy).

Parameters:

retryOptions - The RetryOptions to use for all the requests made through the client.

Returns:

The updated DocumentModelAdministrationClientBuilder object.

retryPolicy

public MetricsAdvisorClientBuilder retryPolicy(RetryPolicy retryPolicy)

Sets the RetryPolicy#RetryPolicy() that is used when each request is sent.

The default retry policy will be used if not provided buildAsyncClient() to build MetricsAdvisorAsyncClient or MetricsAdvisorClient.

Setting this is mutually exclusive with using retryOptions(RetryOptions retryOptions).

Parameters:

retryPolicy - user's retry policy applied to each request.

Returns:

The updated MetricsAdvisorClientBuilder object.

serviceVersion

public MetricsAdvisorClientBuilder serviceVersion(MetricsAdvisorServiceVersion version)

Sets the MetricsAdvisorServiceVersion that is used when making API requests.

If a service version is not provided, the service version that will be used will be the latest known service version based on the version of the client library being used. If no service version is specified, updating to a newer version the client library will have the result of potentially moving to a newer service version.

Parameters:

version - MetricsAdvisorServiceVersion of the service to be used when making requests.

Returns:

The updated MetricsAdvisorClientBuilder object.