Package com.azure.data.tables

Class TableClientBuilder

java.lang.Object
com.azure.data.tables.TableClientBuilder
All Implemented Interfaces:
com.azure.core.client.traits.AzureNamedKeyCredentialTrait<TableClientBuilder>, com.azure.core.client.traits.AzureSasCredentialTrait<TableClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<TableClientBuilder>, com.azure.core.client.traits.ConnectionStringTrait<TableClientBuilder>, com.azure.core.client.traits.EndpointTrait<TableClientBuilder>, com.azure.core.client.traits.HttpTrait<TableClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<TableClientBuilder>
public final class TableClientBuilder extends Object implements com.azure.core.client.traits.TokenCredentialTrait<TableClientBuilder>, com.azure.core.client.traits.AzureNamedKeyCredentialTrait<TableClientBuilder>, com.azure.core.client.traits.ConnectionStringTrait<TableClientBuilder>, com.azure.core.client.traits.AzureSasCredentialTrait<TableClientBuilder>, com.azure.core.client.traits.HttpTrait<TableClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<TableClientBuilder>, com.azure.core.client.traits.EndpointTrait<TableClientBuilder>
Provides a fluent builder API to help aid the configuration and instantiation of a TableClient and TableAsyncClient.

Overview

This class provides a fluent builder API to help aid the configuration and instantiation of TableClient and TableAsyncClient objects. After properly authenticating the client, call buildClient() or buildAsyncClient(), respectively, to construct an instance of the desired client.

Getting Started

The minimal configuration options required by TableClientBuilder to build a TableClient or TableAsyncClient are a tableName and endpoint and a form of authentication, which can be set via: connectionString(String), credential(AzureNamedKeyCredential), credential(TokenCredential), credential(AzureSasCredential), or sasToken(String)

To build an instance of TableClient or TableAsyncClient call buildClient() or buildAsyncClient(), respectively.

The following example shows how to build a TableClient instance.

 TableClient tableClient = new TableClientBuilder()
     .connectionString("connectionString")
     .tableName("tableName")
     .buildClient();

The following example shows how to build a TableAsyncClient instance.

 TableAsyncClient tableClient = new TableClientBuilder()
     .connectionString("connectionString")
     .tableName("tableName")
     .buildAsyncClient();

Authenticating via Connection String

To use a connection string to authorize the client, call the builder's connectionString(String) method with your connection string. When authenticating via a connection string, providing an endpoint is not required.

 TableClient tableClient = new TableClientBuilder()
     .connectionString("connectionString")
     .tableName("tableName")
     .buildClient();

Authentication via Shared Key

To use shared key authentication, create an instance of AzureNamedKeyCredential and pass it to the builder's credential(AzureNamedKeyCredential) method. Pass the account URL to the builder's endpoint(String) method.

 TableClient tableClient = new TableClientBuilder()
     .credential(new AzureNamedKeyCredential("name", "key"))
     .tableName("tableName")
     .endpoint("endpoint")
     .buildClient();

Authentication via Shared Access Signature (SAS)

when authorizing a client utilizing a Shared Access Signature (SAS), you have the option of using AzureSasCredential or the SAS token directly. To use an AzureSasCredential, pass it to the builder's credential(AzureSasCredential) method. When authenticating with a SAS token, pass it to the builder's sasToken(String) method. Pass the account URL to the builder's endpoint(String) method.

Using AzureSasCredential:

 TableClient tableClient = new TableClientBuilder()
     .credential(new AzureSasCredential("sasToken"))
     .endpoint("endpoint")
     .tableName("tableName")
     .buildClient();

Using SAS token:

 TableClient tableClient = new TableClientBuilder()
     .sasToken("sasToken")
     .endpoint("endpoint")
     .tableName("tableName")
     .buildClient();

Authentication via Token Credential

To use token credential authentication, create an instance of a credential class that implements TokenCredential and pass it to the builder's credential(TokenCredential) method. Pass the account URL to the builder's endpoint(String) method.

 TableClient tableClient = new TableClientBuilder()
     .endpoint("endpoint")
     .credential(new DefaultAzureCredentialBuilder().build())
     .tableName("tableName")
     .buildClient();
See Also:

  • Constructor Details

    • TableClientBuilder

      public TableClientBuilder()
      Creates a builder instance that is able to configure and construct TableClient and TableAsyncClient objects.

  • Method Details

    • buildClient

      public TableClient buildClient()
      Creates a TableClient based on options set in the builder.
      Returns:
      A TableClient created from the configurations in this builder.
      Throws:
      NullPointerException - If endpoint or tableName are null.
      IllegalArgumentException - If endpoint is malformed or empty or if tableName is empty.
      IllegalStateException - If no form of authentication or endpoint have been specified or if multiple forms of authentication are provided, with the exception of sasToken + connectionString. Also thrown if endpoint and/or sasToken are set alongside a connectionString and the endpoint and/or SAS token in the latter are different than the former, respectively.

    • buildAsyncClient

      public TableAsyncClient buildAsyncClient()
      Creates a TableAsyncClient based on options set in the builder.
      Returns:
      A TableAsyncClient created from the configurations in this builder.
      Throws:
      NullPointerException - If endpoint or tableName are null.
      IllegalArgumentException - If endpoint is malformed or empty or if tableName is empty.
      IllegalStateException - If no form of authentication or endpoint have been specified or if multiple forms of authentication are provided, with the exception of sasToken + connectionString. Also thrown if endpoint and/or sasToken are set alongside a connectionString and the endpoint and/or SAS token in the latter are different than the former, respectively.

    • connectionString

      public TableClientBuilder connectionString(String connectionString)
      Sets the connection string to connect to the service.
      Specified by:
      connectionString in interface com.azure.core.client.traits.ConnectionStringTrait<TableClientBuilder>
      Parameters:
      connectionString - Connection string of the storage or CosmosDB table API account.
      Returns:
      The updated TableClientBuilder.
      Throws:
      NullPointerException - If connectionString is null.
      IllegalArgumentException - If connectionString isn't a valid connection string.

    • endpoint

      public TableClientBuilder endpoint(String endpoint)
      Sets the service endpoint.
      Specified by:
      endpoint in interface com.azure.core.client.traits.EndpointTrait<TableClientBuilder>
      Parameters:
      endpoint - The URL of the storage or CosmosDB table API account endpoint.
      Returns:
      The updated TableClientBuilder.
      Throws:
      NullPointerException - If endpoint is null.
      IllegalArgumentException - If endpoint isn't a valid URL.

    • pipeline

      public TableClientBuilder 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.

      The endpoint is not ignored when pipeline is set.

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

    • configuration

      public TableClientBuilder configuration(com.azure.core.util.Configuration configuration)
      Sets the configuration object used to retrieve environment configuration values during building of the client.

      The default configuration store is a clone of the global configuration store, use Configuration.NONE to bypass using configuration settings during construction.

      Specified by:
      configuration in interface com.azure.core.client.traits.ConfigurationTrait<TableClientBuilder>
      Parameters:
      configuration - Configuration store used to retrieve environment configuration.
      Returns:
      The updated TableClientBuilder.

    • sasToken

      public TableClientBuilder sasToken(String sasToken)
      Sets the SAS token used to authorize requests sent to the service. Setting this is mutually exclusive with credential(AzureNamedKeyCredential), credential(AzureSasCredential) or credential(TokenCredential).
      Parameters:
      sasToken - The SAS token to use for authenticating requests.
      Returns:
      The updated TableClientBuilder.
      Throws:
      NullPointerException - If sasToken is null.
      IllegalArgumentException - If sasToken is empty.

    • credential

      public TableClientBuilder credential(com.azure.core.credential.AzureSasCredential credential)
      Sets the AzureSasCredential used to authorize requests sent to the service. Setting this is mutually exclusive with credential(AzureNamedKeyCredential), credential(TokenCredential) or sasToken(String).
      Specified by:
      credential in interface com.azure.core.client.traits.AzureSasCredentialTrait<TableClientBuilder>
      Parameters:
      credential - AzureSasCredential used to authorize requests sent to the service.
      Returns:
      The updated TableClientBuilder.
      Throws:
      NullPointerException - If credential is null.

    • credential

      public TableClientBuilder credential(com.azure.core.credential.AzureNamedKeyCredential credential)
      Sets the AzureNamedKeyCredential used to authorize requests sent to the service. Setting this is mutually exclusive with using credential(AzureSasCredential), credential(TokenCredential) or sasToken(String).
      Specified by:
      credential in interface com.azure.core.client.traits.AzureNamedKeyCredentialTrait<TableClientBuilder>
      Parameters:
      credential - AzureNamedKeyCredential used to authorize requests sent to the service.
      Returns:
      The updated TableClientBuilder.
      Throws:
      NullPointerException - If credential is null.

    • credential

      public TableClientBuilder credential(com.azure.core.credential.TokenCredential credential)
      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. Setting this is mutually exclusive with using credential(AzureNamedKeyCredential), credential(AzureSasCredential) or sasToken(String).
      Specified by:
      credential in interface com.azure.core.client.traits.TokenCredentialTrait<TableClientBuilder>
      Parameters:
      credential - TokenCredential used to authorize requests sent to the service.
      Returns:
      The updated TableClientBuilder.
      Throws:
      NullPointerException - If credential is null.

    • httpClient

      public TableClientBuilder 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<TableClientBuilder>
      Parameters:
      httpClient - The HttpClient to use for requests.
      Returns:
      The updated TableClientBuilder.

    • httpLogOptions

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

    • addPolicy

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

    • serviceVersion

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

    • retryPolicy

      public TableClientBuilder retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy)
      Sets the request RetryPolicy for all the requests made through the client. The default RetryPolicy will be used in the pipeline, if not provided. Setting this is mutually exclusive with using retryOptions(RetryOptions).
      Parameters:
      retryPolicy - RetryPolicy.
      Returns:
      The updated TableClientBuilder.

    • retryOptions

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

    • clientOptions

      public TableClientBuilder 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<TableClientBuilder>
      Parameters:
      clientOptions - A configured instance of HttpClientOptions.
      Returns:
      The updated TableClientBuilder.
      See Also:
      • HttpClientOptions

    • tableName

      public TableClientBuilder tableName(String tableName)
      Sets the name of the table.
      Parameters:
      tableName - Name of the table.
      Returns:
      The updated TableClientBuilder.
      Throws:
      IllegalArgumentException - If tableName is null or empty.

    • enableTenantDiscovery

      public TableClientBuilder enableTenantDiscovery()
      Enable tenant discovery when authenticating with the Table Service. This functionality is disabled by default and only available for Storage endpoints using service version 2020_12_06.

      Enable this if there is a chance for your application and the Storage account it communicates with to reside in different tenants. If this is enabled, clients created using this builder will make an unauthorized initial service request that will be met with a 401 response containing an authentication challenge, which will be subsequently used to retrieve an access token to authorize all further requests with.

      Returns:
      The updated TableClientBuilder.