Package com.azure.communication.identity

Class CommunicationIdentityClientBuilder

java.lang.Object
com.azure.communication.identity.CommunicationIdentityClientBuilder
All Implemented Interfaces:
com.azure.core.client.traits.AzureKeyCredentialTrait<CommunicationIdentityClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<CommunicationIdentityClientBuilder>, com.azure.core.client.traits.ConnectionStringTrait<CommunicationIdentityClientBuilder>, com.azure.core.client.traits.EndpointTrait<CommunicationIdentityClientBuilder>, com.azure.core.client.traits.HttpTrait<CommunicationIdentityClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<CommunicationIdentityClientBuilder>
public final class CommunicationIdentityClientBuilder extends Object implements com.azure.core.client.traits.AzureKeyCredentialTrait<CommunicationIdentityClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<CommunicationIdentityClientBuilder>, com.azure.core.client.traits.ConnectionStringTrait<CommunicationIdentityClientBuilder>, com.azure.core.client.traits.EndpointTrait<CommunicationIdentityClientBuilder>, com.azure.core.client.traits.HttpTrait<CommunicationIdentityClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<CommunicationIdentityClientBuilder>
This class provides a fluent builder API to help aid the configuration and instantiation of CommunicationIdentityClients and CommunicationIdentityAsyncClients, call buildClient and buildAsyncClient respectively to construct an instance of the desired client.

Instantiating an asynchronous Azure Communication Service Identity Client

 // You can find your endpoint and access key from your resource in the Azure Portal
 String endpoint = "https://<RESOURCE_NAME>.communication.azure.com";
 AzureKeyCredential keyCredential = new AzureKeyCredential("<access-key>");

 CommunicationIdentityAsyncClient communicationIdentityAsyncClient = new CommunicationIdentityClientBuilder()
         .endpoint(endpoint)
         .credential(keyCredential)
         .buildAsyncClient();

Instantiating a synchronous Azure Communication Service Identity Client

 // You can find your endpoint and access key from your resource in the Azure Portal
 String endpoint = "https://<RESOURCE_NAME>.communication.azure.com";
 AzureKeyCredential keyCredential = new AzureKeyCredential("<access-key>");

 CommunicationIdentityClient communicationIdentityClient = new CommunicationIdentityClientBuilder()
     .endpoint(endpoint)
     .credential(keyCredential)
     .buildClient();
See Also:

  • Constructor Details

    • CommunicationIdentityClientBuilder

      public CommunicationIdentityClientBuilder()

  • Method Details

    • endpoint

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

    • pipeline

      public CommunicationIdentityClientBuilder pipeline(com.azure.core.http.HttpPipeline pipeline)
      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 a pipeline is not supplied, the credential and httpClient fields must be set

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

    • credential

      public CommunicationIdentityClientBuilder 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<CommunicationIdentityClientBuilder>
      Parameters:
      tokenCredential - TokenCredential used to authorize requests sent to the service.
      Returns:
      The updated CommunicationIdentityClientBuilder object.
      Throws:
      NullPointerException - If tokenCredential is null.

    • credential

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

    • connectionString

      public CommunicationIdentityClientBuilder connectionString(String connectionString)
      Set endpoint and credential to use
      Specified by:
      connectionString in interface com.azure.core.client.traits.ConnectionStringTrait<CommunicationIdentityClientBuilder>
      Parameters:
      connectionString - connection string for setting endpoint and initalizing CommunicationClientCredential
      Returns:
      CommunicationIdentityClientBuilder

    • httpClient

      public CommunicationIdentityClientBuilder httpClient(com.azure.core.http.HttpClient httpClient)
      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<CommunicationIdentityClientBuilder>
      Parameters:
      httpClient - The HttpClient to use for requests.
      Returns:
      CommunicationIdentityClientBuilder

    • addPolicy

      public CommunicationIdentityClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy customPolicy)
      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<CommunicationIdentityClientBuilder>
      Parameters:
      customPolicy - A pipeline policy.
      Returns:
      CommunicationIdentityClientBuilder
      Throws:
      NullPointerException - If pipelinePolicy is null.

    • clientOptions

      public CommunicationIdentityClientBuilder 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<CommunicationIdentityClientBuilder>
      Parameters:
      clientOptions - A configured instance of HttpClientOptions.
      Returns:
      The updated CommunicationIdentityClientBuilder object.
      Throws:
      NullPointerException - If clientOptions is null.
      See Also:
      • HttpClientOptions

    • configuration

      public CommunicationIdentityClientBuilder configuration(com.azure.core.util.Configuration configuration)
      Sets the configuration object used to retrieve environment configuration values during building of the client.
      Specified by:
      configuration in interface com.azure.core.client.traits.ConfigurationTrait<CommunicationIdentityClientBuilder>
      Parameters:
      configuration - Configuration store used to retrieve environment configurations.
      Returns:
      the updated CommunicationIdentityClientBuilder object

    • httpLogOptions

      public CommunicationIdentityClientBuilder 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<CommunicationIdentityClientBuilder>
      Parameters:
      logOptions - The logging configuration to use when sending and receiving requests to and from the service.
      Returns:
      the updated CommunicationIdentityClientBuilder object

    • retryPolicy

      public CommunicationIdentityClientBuilder retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy)
      Sets the RetryPolicy that is used when each request is sent.

      A default retry policy will be supplied if one isn't provided.

      Setting this is mutually exclusive with using retryOptions(RetryOptions).

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

    • retryOptions

      public CommunicationIdentityClientBuilder 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<CommunicationIdentityClientBuilder>
      Parameters:
      retryOptions - The RetryOptions to use for all the requests made through the client.
      Returns:
      The updated CommunicationIdentityClientBuilder object.

    • serviceVersion

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

    • buildAsyncClient

      public CommunicationIdentityAsyncClient buildAsyncClient()
      Create asynchronous client applying HMACAuthenticationPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy. Additional HttpPolicies specified by additionalPolicies will be applied after them
      Returns:
      CommunicationIdentityAsyncClient instance
      Throws:
      IllegalStateException - If both retryOptions(RetryOptions) and retryPolicy(RetryPolicy) have been set.

    • buildClient

      public CommunicationIdentityClient buildClient()
      Create synchronous client applying HmacAuthenticationPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy. Additional HttpPolicies specified by additionalPolicies will be applied after them
      Returns:
      CommunicationIdentityClient instance
      Throws:
      IllegalStateException - If both retryOptions(RetryOptions) and retryPolicy(RetryPolicy) have been set.