Package com.azure.maps.elevation

Class ElevationClientBuilder

java.lang.Object
com.azure.maps.elevation.ElevationClientBuilder
All Implemented Interfaces:
com.azure.core.client.traits.AzureKeyCredentialTrait<ElevationClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<ElevationClientBuilder>, com.azure.core.client.traits.EndpointTrait<ElevationClientBuilder>, com.azure.core.client.traits.HttpTrait<ElevationClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<ElevationClientBuilder>
public final class ElevationClientBuilder extends Object implements com.azure.core.client.traits.AzureKeyCredentialTrait<ElevationClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<ElevationClientBuilder>, com.azure.core.client.traits.HttpTrait<ElevationClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<ElevationClientBuilder>, com.azure.core.client.traits.EndpointTrait<ElevationClientBuilder>
Builder class used to instantiate both synchronous and asynchronous ElevationClient clients.

Example usage

Creating a sync client using a AzureKeyCredential: 
 // Authenticates using subscription key
 AzureKeyCredential keyCredential = new AzureKeyCredential(System.getenv("SUBSCRIPTION_KEY"));

 // Creates a client
 ElevationClient client = new ElevationClientBuilder() 
     .credential(keyCredential)
     .elevationClientId(System.getenv("MAPS_CLIENT_ID"))
     .buildClient();

  • Constructor Details

    • ElevationClientBuilder

      public ElevationClientBuilder()
      Default constructor for the builder class; Create an instance of the ElevationClientBuilder.

  • Method Details

    • elevationClientId

      public ElevationClientBuilder elevationClientId(String elevationClientId)
      Sets the Azure Maps client id for use with Azure AD Authentication. This client id is the account-based GUID that appears on the Azure Maps Authentication page. More details: Azure Maps AD Authentication
      Parameters:
      elevationClientId - the clientId value.
      Returns:
      the ElevationClientBuilder.

    • endpoint

      public ElevationClientBuilder endpoint(String endpoint)
      Set endpoint of the service.
      Specified by:
      endpoint in interface com.azure.core.client.traits.EndpointTrait<ElevationClientBuilder>
      Parameters:
      endpoint - url of the service
      Returns:
      ElevationClientBuilder

    • serviceVersion

      public ElevationClientBuilder serviceVersion(ElevationServiceVersion version)
      Sets the ElevationServiceVersion 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 of the client library will have the result of potentially moving to a newer service version.

      Targeting a specific service version may also mean that the service will return an error for newer APIs.

      Parameters:
      version - ElevationServiceVersion of the service to be used when making requests.
      Returns:
      the updated ElevationClientBuilder object

    • pipeline

      public ElevationClientBuilder pipeline(com.azure.core.http.HttpPipeline pipeline)
      Sets The HTTP pipeline to send requests through.
      Specified by:
      pipeline in interface com.azure.core.client.traits.HttpTrait<ElevationClientBuilder>
      Parameters:
      pipeline - the pipeline value.
      Returns:
      the ElevationClientBuilder.

    • httpClient

      public ElevationClientBuilder httpClient(com.azure.core.http.HttpClient httpClient)
      Sets The HTTP client used to send the request.
      Specified by:
      httpClient in interface com.azure.core.client.traits.HttpTrait<ElevationClientBuilder>
      Parameters:
      httpClient - the httpClient value.
      Returns:
      the ElevationClientBuilder.

    • configuration

      public ElevationClientBuilder configuration(com.azure.core.util.Configuration configuration)
      Sets The configuration store that is used during construction of the service client.
      Specified by:
      configuration in interface com.azure.core.client.traits.ConfigurationTrait<ElevationClientBuilder>
      Parameters:
      configuration - the configuration value.
      Returns:
      the ElevationClientBuilder.

    • httpLogOptions

      public ElevationClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions httpLogOptions)
      Sets The logging configuration for HTTP requests and responses.
      Specified by:
      httpLogOptions in interface com.azure.core.client.traits.HttpTrait<ElevationClientBuilder>
      Parameters:
      httpLogOptions - the httpLogOptions value.
      Returns:
      the ElevationClientBuilder.

    • retryPolicy

      public ElevationClientBuilder retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy)
      Sets The retry policy that will attempt to retry failed requests, if applicable.
      Parameters:
      retryPolicy - the retryPolicy value.
      Returns:
      the ElevationClientBuilder.

    • clientOptions

      public ElevationClientBuilder clientOptions(com.azure.core.util.ClientOptions clientOptions)
      Sets The client options such as application ID and custom headers to set on a request.
      Specified by:
      clientOptions in interface com.azure.core.client.traits.HttpTrait<ElevationClientBuilder>
      Parameters:
      clientOptions - the clientOptions value.
      Returns:
      the ElevationClientBuilder.

    • addPolicy

      public ElevationClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy customPolicy)
      Adds a custom Http pipeline policy.
      Specified by:
      addPolicy in interface com.azure.core.client.traits.HttpTrait<ElevationClientBuilder>
      Parameters:
      customPolicy - The custom Http pipeline policy to add.
      Returns:
      the ElevationClientBuilder.

    • credential

      public ElevationClientBuilder credential(com.azure.core.credential.TokenCredential tokenCredential)
      Sets the TokenCredential used to authenticate HTTP requests.
      Specified by:
      credential in interface com.azure.core.client.traits.TokenCredentialTrait<ElevationClientBuilder>
      Parameters:
      tokenCredential - TokenCredential used to authenticate HTTP requests.
      Returns:
      The updated ElevationClientBuilder object.
      Throws:
      NullPointerException - If tokenCredential is null.

    • credential

      public ElevationClientBuilder credential(com.azure.core.credential.AzureKeyCredential keyCredential)
      Sets the AzureKeyCredential used to authenticate HTTP requests.
      Specified by:
      credential in interface com.azure.core.client.traits.AzureKeyCredentialTrait<ElevationClientBuilder>
      Parameters:
      keyCredential - The AzureKeyCredential used to authenticate HTTP requests.
      Returns:
      The updated ElevationClientBuilder object.
      Throws:
      NullPointerException - If keyCredential is null.

    • retryOptions

      public ElevationClientBuilder retryOptions(com.azure.core.http.policy.RetryOptions retryOptions)
      Sets retry options
      Specified by:
      retryOptions in interface com.azure.core.client.traits.HttpTrait<ElevationClientBuilder>
      Parameters:
      retryOptions - the retry options for the client
      Returns:
      a reference to this ElevationClientBuilder

    • buildAsyncClient

      public ElevationAsyncClient buildAsyncClient()
      Builds an instance of ElevationAsyncClient async client.
      Returns:
      an instance of ElevationAsyncClient.

    • buildClient

      public ElevationClient buildClient()
      Builds an instance of ElevationClient sync client.
      Returns:
      an instance of ElevationClient.