public final class MetricsAdvisorAdministrationClientBuilder extends Object
MetricsAdvisorAdministrationClients
and MetricsAdvisorAdministrationAsyncClient
,
call MetricsAdvisorAdministrationClientBuilder.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.
MetricsAdvisorAdministrationClientBuilder.credential(MetricsAdvisorKeyCredential)
gives the builder access to credential.
Instantiating an asynchronous Metrics Advisor Client
MetricsAdvisorAdministrationAsyncClient
metricsAdvisorAdminAsyncClient = newMetricsAdvisorAdministrationClientBuilder
() .credential(newMetricsAdvisorKeyCredential
("{subscription_key}", "{api_key}")) .endpoint("{endpoint}") .buildAsyncClient();
Instantiating a synchronous Metrics Advisor Client
MetricsAdvisorAdministrationClient
metricsAdvisorAdminClient = newMetricsAdvisorAdministrationClientBuilder
() .credential(newMetricsAdvisorKeyCredential
("{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 MetricsAdvisorAdministrationClient
and MetricsAdvisorAdministrationAsyncClient
is built.
HttpPipeline
pipeline = newHttpPipelineBuilder
() .policies(/* add policies */) .build();MetricsAdvisorAdministrationClient
metricsAdvisorAdministrationClient = newMetricsAdvisorAdministrationClientBuilder
() .credential(newMetricsAdvisorKeyCredential
("{subscription_key}", "{api_key}")) .endpoint("{endpoint}") .pipeline(pipeline) .buildClient();
Constructor and Description |
---|
MetricsAdvisorAdministrationClientBuilder()
The constructor with defaults.
|
Modifier and Type | Method and Description |
---|---|
MetricsAdvisorAdministrationClientBuilder |
addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy)
Adds a policy to the set of existing policies that are executed after required policies.
|
MetricsAdvisorAdministrationAsyncClient |
buildAsyncClient()
Creates a
MetricsAdvisorAdministrationAsyncClient based on options set in the builder. |
MetricsAdvisorAdministrationClient |
buildClient()
Creates a
MetricsAdvisorAdministrationClient based on options set in the builder. |
MetricsAdvisorAdministrationClientBuilder |
clientOptions(com.azure.core.util.ClientOptions clientOptions)
Sets the client options such as application ID and custom headers to set on a request.
|
MetricsAdvisorAdministrationClientBuilder |
configuration(com.azure.core.util.Configuration configuration)
Sets the configuration store that is used during construction of the service client.
|
MetricsAdvisorAdministrationClientBuilder |
credential(MetricsAdvisorKeyCredential metricsAdvisorKeyCredential)
Sets the
MetricsAdvisorKeyCredential to use when authenticating HTTP requests for this
MetricsAdvisorAdministrationClientBuilder. |
MetricsAdvisorAdministrationClientBuilder |
credential(com.azure.core.credential.TokenCredential tokenCredential)
Sets the
TokenCredential used to authenticate HTTP requests. |
MetricsAdvisorAdministrationClientBuilder |
endpoint(String endpoint)
Sets the service endpoint for the Azure Metrics Advisor instance.
|
MetricsAdvisorAdministrationClientBuilder |
httpClient(com.azure.core.http.HttpClient client)
Sets the HTTP client to use for sending and receiving requests to and from the service.
|
MetricsAdvisorAdministrationClientBuilder |
httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
Sets the logging configuration for HTTP requests and responses.
|
MetricsAdvisorAdministrationClientBuilder |
pipeline(com.azure.core.http.HttpPipeline httpPipeline)
Sets the HTTP pipeline to use for the service client.
|
MetricsAdvisorAdministrationClientBuilder |
retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy)
Sets the
RetryPolicy.RetryPolicy() that is used when each request is sent. |
MetricsAdvisorAdministrationClientBuilder |
serviceVersion(MetricsAdvisorServiceVersion version)
Sets the
MetricsAdvisorServiceVersion that is used when making API requests. |
public MetricsAdvisorAdministrationClientBuilder()
public MetricsAdvisorAdministrationClient buildClient()
MetricsAdvisorAdministrationClient
based on options set in the builder. Every time
buildClient()
is called a new instance of MetricsAdvisorAdministrationClient
is created.
If pipeline
is set, then the pipeline
and
endpoint
are used to create the client
.
All other builder settings are ignored.
NullPointerException
- if endpoint
or
MetricsAdvisorAdministrationClientBuilder.credential(MetricsAdvisorKeyCredential)
has not been set.IllegalArgumentException
- if endpoint
cannot be parsed into a valid URL.public MetricsAdvisorAdministrationAsyncClient buildAsyncClient()
MetricsAdvisorAdministrationAsyncClient
based on options set in the builder. Every time
buildAsyncClient()
is called a new instance of MetricsAdvisorAdministrationAsyncClient
is
created.
If pipeline
is set, then the pipeline
and
endpoint
are used to create the client
.
All other builder settings are ignored.
NullPointerException
- if endpoint
or
MetricsAdvisorAdministrationClientBuilder.credential(MetricsAdvisorKeyCredential)
has not been set.IllegalArgumentException
- if endpoint
cannot be parsed into a valid URL.public MetricsAdvisorAdministrationClientBuilder endpoint(String endpoint)
endpoint
- The URL of the Azure Metrics Advisor instance service requests to and receive responses from.NullPointerException
- if endpoint
is nullIllegalArgumentException
- if endpoint
cannot be parsed into a valid URL.public MetricsAdvisorAdministrationClientBuilder credential(com.azure.core.credential.TokenCredential tokenCredential)
TokenCredential
used to authenticate HTTP requests.tokenCredential
- TokenCredential
used to authenticate HTTP requests.MetricsAdvisorAdministrationClientBuilder
object.NullPointerException
- If tokenCredential
is null.public MetricsAdvisorAdministrationClientBuilder credential(MetricsAdvisorKeyCredential metricsAdvisorKeyCredential)
MetricsAdvisorKeyCredential
to use when authenticating HTTP requests for this
MetricsAdvisorAdministrationClientBuilder.metricsAdvisorKeyCredential
- MetricsAdvisorKeyCredential
API key credentialNullPointerException
- If metricsAdvisorKeyCredential
is null.public MetricsAdvisorAdministrationClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
If logOptions
isn't provided, the default options will use HttpLogDetailLevel.NONE
which will prevent logging.
logOptions
- The logging configuration to use when sending and receiving HTTP requests/responses.public MetricsAdvisorAdministrationClientBuilder clientOptions(com.azure.core.util.ClientOptions clientOptions)
clientOptions
- The client options.public MetricsAdvisorAdministrationClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy)
policy
- The retry policy for service requests.NullPointerException
- If policy
is null.public MetricsAdvisorAdministrationClientBuilder httpClient(com.azure.core.http.HttpClient client)
client
- The HTTP client to use for requests.public MetricsAdvisorAdministrationClientBuilder pipeline(com.azure.core.http.HttpPipeline httpPipeline)
If pipeline
is set, all other settings are ignored, aside from
endpoint
to build
MetricsAdvisorAdministrationAsyncClient
or MetricsAdvisorAdministrationClient
.
httpPipeline
- The HTTP pipeline to use for sending service requests and receiving responses.public MetricsAdvisorAdministrationClientBuilder configuration(com.azure.core.util.Configuration configuration)
The default configuration store is a clone of the global
configuration store
, use Configuration.NONE
to bypass using configuration settings during construction.
configuration
- The configuration store used to.public MetricsAdvisorAdministrationClientBuilder retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy)
RetryPolicy.RetryPolicy()
that is used when each request is sent.
The default retry policy will be used if not provided
MetricsAdvisorAdministrationClientBuilder.buildAsyncClient()
to build MetricsAdvisorAdministrationAsyncClient
or MetricsAdvisorAdministrationClient
.
retryPolicy
- user's retry policy applied to each request.public MetricsAdvisorAdministrationClientBuilder serviceVersion(MetricsAdvisorServiceVersion version)
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.
version
- MetricsAdvisorServiceVersion
of the service to be used when making requests.Copyright © 2021 Microsoft Corporation. All rights reserved.