Package com.azure.maps.search

Class MapsSearchClientBuilder

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

Example usage

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

 // Creates a builder
 MapsSearchClientBuilder builder = new MapsSearchClientBuilder();
 builder.credential(keyCredential);
 builder.httpLogOptions(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.BODY_AND_HEADERS));

 // Builds the client
 MapsSearchClient client = builder.buildClient();

  • Constructor Details

    • MapsSearchClientBuilder

      public MapsSearchClientBuilder()
      Default constructor for the builder class.

  • Method Details

    • mapsClientId

      public MapsSearchClientBuilder mapsClientId(String mapsClientId)
      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:
      mapsClientId - the clientId value.
      Returns:
      the SearchClientBuilder.

    • endpoint

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

    • serviceVersion

      public MapsSearchClientBuilder serviceVersion(MapsSearchServiceVersion version)
      Sets the MapsSearchServiceVersion 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 - MapsSearchServiceVersion of the service to be used when making requests.
      Returns:
      the updated MapsSearchClientBuilder object

    • pipeline

      public MapsSearchClientBuilder 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<MapsSearchClientBuilder>
      Parameters:
      pipeline - the pipeline value.
      Returns:
      the SearchClientBuilder.

    • httpClient

      public MapsSearchClientBuilder 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<MapsSearchClientBuilder>
      Parameters:
      httpClient - the httpClient value.
      Returns:
      the SearchClientBuilder.

    • configuration

      public MapsSearchClientBuilder 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<MapsSearchClientBuilder>
      Parameters:
      configuration - the configuration value.
      Returns:
      the SearchClientBuilder.

    • httpLogOptions

      public MapsSearchClientBuilder 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<MapsSearchClientBuilder>
      Parameters:
      httpLogOptions - the httpLogOptions value.
      Returns:
      the SearchClientBuilder.

    • retryPolicy

      public MapsSearchClientBuilder 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 SearchClientBuilder.

    • clientOptions

      public MapsSearchClientBuilder 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<MapsSearchClientBuilder>
      Parameters:
      clientOptions - the clientOptions value.
      Returns:
      the SearchClientBuilder.

    • addPolicy

      public MapsSearchClientBuilder 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<MapsSearchClientBuilder>
      Parameters:
      customPolicy - The custom Http pipeline policy to add.
      Returns:
      the SearchClientBuilder.

    • credential

      public MapsSearchClientBuilder 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<MapsSearchClientBuilder>
      Parameters:
      tokenCredential - TokenCredential used to authenticate HTTP requests.
      Returns:
      The updated MapsSearchClientBuilder object.
      Throws:
      NullPointerException - If tokenCredential is null.

    • credential

      public MapsSearchClientBuilder 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<MapsSearchClientBuilder>
      Parameters:
      keyCredential - The AzureKeyCredential used to authenticate HTTP requests.
      Returns:
      The updated MapsSearchClientBuilder object.
      Throws:
      NullPointerException - If keyCredential is null.

    • credential

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

    • retryOptions

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

    • buildAsyncClient

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

    • buildClient

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