Package com.azure.ai.metricsadvisor

Class MetricsAdvisorClientBuilder

java.lang.Object
com.azure.ai.metricsadvisor.MetricsAdvisorClientBuilder
All Implemented Interfaces:
com.azure.core.client.traits.ConfigurationTrait<MetricsAdvisorClientBuilder>, com.azure.core.client.traits.EndpointTrait<MetricsAdvisorClientBuilder>, com.azure.core.client.traits.HttpTrait<MetricsAdvisorClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<MetricsAdvisorClientBuilder>
public final class MetricsAdvisorClientBuilder extends Object implements com.azure.core.client.traits.ConfigurationTrait<MetricsAdvisorClientBuilder>, com.azure.core.client.traits.EndpointTrait<MetricsAdvisorClientBuilder>, com.azure.core.client.traits.HttpTrait<MetricsAdvisorClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<MetricsAdvisorClientBuilder>
This class provides a fluent builder API to help instantiation of MetricsAdvisorClients and MetricsAdvisorAsyncClients, 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) 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 this and set the service endpoint with this. 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();
See Also:

  • Constructor Details

    • MetricsAdvisorClientBuilder

      public MetricsAdvisorClientBuilder()
      The constructor with defaults.

  • Method Details

    • 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 is set, then the pipeline and endpoint are used to create the client. All other builder settings are ignored.

      Returns:
      A MetricsAdvisorClient with the options set from the builder.
      Throws:
      NullPointerException - if endpoint or credential(MetricsAdvisorKeyCredential) has not been set.
      IllegalArgumentException - if endpoint cannot be parsed into a valid URL.
      IllegalStateException - If both retryOptions(RetryOptions) and retryPolicy(RetryPolicy) have been set.

    • 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 is set, then the pipeline and endpoint are used to create the client. All other builder settings are ignored.

      Returns:
      A MetricsAdvisorAsyncClient with the options set from the builder.
      Throws:
      NullPointerException - if endpoint or credential(MetricsAdvisorKeyCredential) has not been set.
      IllegalArgumentException - if endpoint cannot be parsed into a valid URL.
      IllegalStateException - If both retryOptions(RetryOptions) and retryPolicy(RetryPolicy) have been set.

    • endpoint

      public MetricsAdvisorClientBuilder endpoint(String endpoint)
      Sets the service endpoint for the Azure Metrics Advisor instance.
      Specified by:
      endpoint in interface com.azure.core.client.traits.EndpointTrait<MetricsAdvisorClientBuilder>
      Parameters:
      endpoint - The URL of the Azure Metrics Advisor instance service requests to and receive responses from.
      Returns:
      The updated MetricsAdvisorClientBuilder object.
      Throws:
      NullPointerException - if endpoint is null
      IllegalArgumentException - if endpoint cannot be parsed into a valid URL.

    • credential

      public MetricsAdvisorClientBuilder credential(com.azure.core.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.
      Specified by:
      credential in interface com.azure.core.client.traits.TokenCredentialTrait<MetricsAdvisorClientBuilder>
      Parameters:
      tokenCredential - TokenCredential used to authorize requests sent to the service.
      Returns:
      The updated MetricsAdvisorClientBuilder object.
      Throws:
      NullPointerException - If tokenCredential is null.

    • 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.
      Throws:
      NullPointerException - If metricsAdvisorKeyCredential is null.

    • httpLogOptions

      public MetricsAdvisorClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
      Sets the logging configuration 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.

      Specified by:
      httpLogOptions in interface com.azure.core.client.traits.HttpTrait<MetricsAdvisorClientBuilder>
      Parameters:
      logOptions - The logging configuration to use when sending and receiving requests to and from the service.
      Returns:
      The updated MetricsAdvisorClientBuilder object.

    • clientOptions

      public MetricsAdvisorClientBuilder clientOptions(com.azure.core.util.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.

      Specified by:
      clientOptions in interface com.azure.core.client.traits.HttpTrait<MetricsAdvisorClientBuilder>
      Parameters:
      clientOptions - A configured instance of HttpClientOptions.
      Returns:
      The updated MetricsAdvisorClientBuilder object.
      See Also:
      • HttpClientOptions

    • addPolicy

      public MetricsAdvisorClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy)
      Adds a pipeline policy 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.

      Specified by:
      addPolicy in interface com.azure.core.client.traits.HttpTrait<MetricsAdvisorClientBuilder>
      Parameters:
      policy - A pipeline policy.
      Returns:
      The updated MetricsAdvisorClientBuilder object.
      Throws:
      NullPointerException - If policy is null.

    • httpClient

      public MetricsAdvisorClientBuilder httpClient(com.azure.core.http.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.

      Specified by:
      httpClient in interface com.azure.core.client.traits.HttpTrait<MetricsAdvisorClientBuilder>
      Parameters:
      client - The HttpClient to use for requests.
      Returns:
      The updated MetricsAdvisorClientBuilder object.

    • pipeline

      public MetricsAdvisorClientBuilder pipeline(com.azure.core.http.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 to build MetricsAdvisorAsyncClient or MetricsAdvisorClient.

      Specified by:
      pipeline in interface com.azure.core.client.traits.HttpTrait<MetricsAdvisorClientBuilder>
      Parameters:
      httpPipeline - HttpPipeline to use for sending service requests and receiving responses.
      Returns:
      The updated MetricsAdvisorClientBuilder object.

    • configuration

      public MetricsAdvisorClientBuilder configuration(com.azure.core.util.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 Configuration.NONE to bypass using configuration settings during construction.

      Specified by:
      configuration in interface com.azure.core.client.traits.ConfigurationTrait<MetricsAdvisorClientBuilder>
      Parameters:
      configuration - The configuration store used to.
      Returns:
      The updated MetricsAdvisorClientBuilder object.

    • retryPolicy

      public MetricsAdvisorClientBuilder retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy)
      Sets the 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).

      Parameters:
      retryPolicy - user's retry policy applied to each request.
      Returns:
      The updated MetricsAdvisorClientBuilder object.

    • retryOptions

      public MetricsAdvisorClientBuilder retryOptions(com.azure.core.http.policy.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).

      Specified by:
      retryOptions in interface com.azure.core.client.traits.HttpTrait<MetricsAdvisorClientBuilder>
      Parameters:
      retryOptions - The RetryOptions to use for all the requests made through the client.
      Returns:
      The updated DocumentModelAdministrationClientBuilder 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.