Package com.azure.maps.render

Class MapsRenderClientBuilder

java.lang.Object
com.azure.maps.render.MapsRenderClientBuilder
All Implemented Interfaces:
com.azure.core.client.traits.AzureKeyCredentialTrait<MapsRenderClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<MapsRenderClientBuilder>, com.azure.core.client.traits.EndpointTrait<MapsRenderClientBuilder>, com.azure.core.client.traits.HttpTrait<MapsRenderClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<MapsRenderClientBuilder>
public final class MapsRenderClientBuilder extends Object implements com.azure.core.client.traits.AzureKeyCredentialTrait<MapsRenderClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<MapsRenderClientBuilder>, com.azure.core.client.traits.HttpTrait<MapsRenderClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<MapsRenderClientBuilder>, com.azure.core.client.traits.EndpointTrait<MapsRenderClientBuilder>
A builder for creating a new instance of the RenderClient type. Builder class used to instantiate both synchronous and asynchronous MapsRenderClient clients. Creating a sync client using a AzureKeyCredential: 
 // Authenticates using subscription key
 AzureKeyCredential keyCredential = new AzureKeyCredential(System.getenv("SUBSCRIPTION_KEY"));

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

 // Builds the client
 MapsRenderClient client = builder.buildClient();
Creating a sync client using a TokenCredential: 
 // Authenticates using Azure AD building a default credential
 // This will look for AZURE_CLIENT_ID, AZURE_TENANT_ID, and AZURE_CLIENT_SECRET env variables
 DefaultAzureCredential tokenCredential = new DefaultAzureCredentialBuilder().build();

 // Creates a builder
 MapsRenderClientBuilder builder = new MapsRenderClientBuilder();
 builder.credential(tokenCredential);
 builder.mapsClientId(System.getenv("MAPS_CLIENT_ID"));
 builder.httpLogOptions(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.BODY_AND_HEADERS));

 // Builds a client
 MapsRenderClient client = builder.buildClient();

  • Constructor Details

    • MapsRenderClientBuilder

      public MapsRenderClientBuilder()
      Create an instance of the RenderClientBuilder.

  • Method Details

    • mapsClientId

      public MapsRenderClientBuilder 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 RenderhClientBuilder.

    • endpoint

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

    • serviceVersion

      public MapsRenderClientBuilder serviceVersion(MapsRenderServiceVersion version)
      Render service version
      Parameters:
      version - the service version
      Returns:
      a reference to this RenderClientBuilder

    • pipeline

      public MapsRenderClientBuilder 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<MapsRenderClientBuilder>
      Parameters:
      pipeline - the pipeline value.
      Returns:
      a reference to this RenderClientBuilder.

    • httpClient

      public MapsRenderClientBuilder 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<MapsRenderClientBuilder>
      Parameters:
      httpClient - the httpClient value.
      Returns:
      a reference to this RenderClientBuilder.

    • configuration

      public MapsRenderClientBuilder 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<MapsRenderClientBuilder>
      Parameters:
      configuration - the configuration value.
      Returns:
      a reference to this RenderClientBuilder.

    • httpLogOptions

      public MapsRenderClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions httpLogOptions)
      Sets The http log options.
      Specified by:
      httpLogOptions in interface com.azure.core.client.traits.HttpTrait<MapsRenderClientBuilder>
      Parameters:
      httpLogOptions - the http log options.
      Returns:
      a reference to this RenderClientBuilder.

    • retryPolicy

      public MapsRenderClientBuilder 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:
      a reference to this RenderClientBuilder.

    • clientOptions

      public MapsRenderClientBuilder 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<MapsRenderClientBuilder>
      Parameters:
      clientOptions - the clientOptions value.
      Returns:
      a reference to this RenderClientBuilder.

    • addPolicy

      public MapsRenderClientBuilder 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<MapsRenderClientBuilder>
      Parameters:
      customPolicy - The custom Http pipeline policy to add.
      Returns:
      a reference to this RenderClientBuilder.

    • credential

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

    • credential

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

    • buildAsyncClient

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

    • buildClient

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

    • retryOptions

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