TableClientBuilder Class

Reference

Package:: com.azure.data.tables

Maven Artifact:: com.azure:azure-data-tables:12.4.0

java.lang.Object
- com.azure.data.tables.TableClientBuilder

Implements

AzureNamedKeyCredentialTrait<TableClientBuilder> AzureSasCredentialTrait<TableClientBuilder> ConfigurationTrait<TableClientBuilder> ConnectionStringTrait<TableClientBuilder> EndpointTrait<TableClientBuilder> HttpTrait<TableClientBuilder> TokenCredentialTrait<TableClientBuilder>

public final class TableClientBuilder
implements TokenCredentialTrait<TableClientBuilder>, AzureNamedKeyCredentialTrait<TableClientBuilder>, ConnectionStringTrait<TableClientBuilder>, AzureSasCredentialTrait<TableClientBuilder>, HttpTrait<TableClientBuilder>, ConfigurationTrait<TableClientBuilder>, 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 connectionString), credential(AzureNamedKeyCredential credential), credential(TokenCredential credential), credential(AzureSasCredential credential), or sasToken(String sasToken)

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 connectionString) 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 credential) method. Pass the account URL to the builder's endpoint(String endpoint) 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 credential) method. When authenticating with a SAS token, pass it to the builder's sasToken(String sasToken) method. Pass the account URL to the builder's endpoint(String endpoint) 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 credential) method. Pass the account URL to the builder's endpoint(String endpoint) method.

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

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
TableClientBuilder	addPolicy(HttpPipelinePolicy pipelinePolicy) Adds a HttpPipelinePolicy to apply on each request sent.
TableAsyncClient	buildAsyncClient() Creates a TableAsyncClient based on options set in the builder.
TableClient	buildClient() Creates a TableClient based on options set in the builder.
TableClientBuilder	clientOptions(ClientOptions clientOptions) Allows for setting common properties such as application ID, headers, proxy configuration, etc.
TableClientBuilder	configuration(Configuration configuration) Sets the Configuration object used to retrieve environment configuration values during building of the client.
TableClientBuilder	connectionString(String connectionString) Sets the connection string to connect to the service.
TableClientBuilder	credential(AzureNamedKeyCredential credential) Sets the AzureNamedKeyCredential used to authorize requests sent to the service.
TableClientBuilder	credential(AzureSasCredential credential) Sets the AzureSasCredential used to authorize requests sent to the service.
TableClientBuilder	credential(TokenCredential credential) Sets the TokenCredential used to authorize requests sent to the service.
TableClientBuilder	enableTenantDiscovery() Enable tenant discovery when authenticating with the Table Service.
TableClientBuilder	endpoint(String endpoint) Sets the service endpoint.
TableClientBuilder	httpClient(HttpClient httpClient) Sets the HttpClient to use for sending and receiving requests to and from the service.
TableClientBuilder	httpLogOptions(HttpLogOptions logOptions) Sets the HttpLogOptions to use when sending and receiving requests to and from the service.
TableClientBuilder	pipeline(HttpPipeline pipeline) Sets the HttpPipeline to use for the service client.
TableClientBuilder	retryOptions(RetryOptions retryOptions) Sets the RetryOptions for all the requests made through the client.
TableClientBuilder	retryPolicy(RetryPolicy retryPolicy) Sets the request RetryPolicy for all the requests made through the client.
TableClientBuilder	sasToken(String sasToken) Sets the SAS token used to authorize requests sent to the service.
TableClientBuilder	serviceVersion(TableServiceVersion version) Sets the TableServiceVersion that is used when making API requests.
TableClientBuilder	tableName(String tableName) Sets the name of the table.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

TableClientBuilder

public TableClientBuilder()

Creates a builder instance that is able to configure and construct TableClient and TableAsyncClient objects.

Method Details

addPolicy

public TableClientBuilder addPolicy(HttpPipelinePolicy pipelinePolicy)

Adds a HttpPipelinePolicy 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.

Parameters:

pipelinePolicy - A HttpPipelinePolicy.

Returns:

TableClientBuilder Class

Overview

Getting Started

Authenticating via Connection String

Authentication via Shared Key

Authentication via Shared Access Signature (SAS)

Authentication via Token Credential

Constructor Summary

Method Summary

Methods inherited from java.lang.Object

Constructor Details

TableClientBuilder

Method Details

addPolicy

buildAsyncClient

buildClient

clientOptions

configuration

connectionString

credential

credential

credential

enableTenantDiscovery

endpoint

httpClient

httpLogOptions

pipeline

retryOptions

retryPolicy

sasToken

serviceVersion

tableName

Applies to

Feedback

Additional resources