TableServiceClientBuilder Class

Reference

Package:: com.azure.data.tables

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

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

Implements

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

public final class TableServiceClientBuilder
implements TokenCredentialTrait<TableServiceClientBuilder>, AzureNamedKeyCredentialTrait<TableServiceClientBuilder>, ConnectionStringTrait<TableServiceClientBuilder>, AzureSasCredentialTrait<TableServiceClientBuilder>, HttpTrait<TableServiceClientBuilder>, ConfigurationTrait<TableServiceClientBuilder>, EndpointTrait<TableServiceClientBuilder>

Provides a fluent builder API to help aid the configuration and instantiation of TableServiceClient and TableServiceAsyncClient.

Overview

This class provides a fluent builder API to help aid the configuration and instantiation of TableServiceClient and TableServiceAsyncClient objects. Call buildClient() or buildAsyncClient(), respectively, to construct an instance of the desired client.

Getting Started

The minimal configuration options required by TableServiceClientBuilder to build a TableServiceClient or TableServiceAsyncClient are an 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 a TableServiceClient or TableServiceAsyncClient instance, call buildClient() or buildAsyncClient(), respectively.

The following example shows how to build a TableServiceClient.

TableServiceClient tableServiceClient = new TableServiceClientBuilder()
     .connectionString("connectionString")
     .buildClient();

The following example shows how to build a TableServiceAsyncClient.

TableServiceAsyncClient tableServiceClient = new TableServiceClientBuilder()
     .connectionString("connectionString")
     .buildAsyncClient();

Authentication 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.

TableServiceClient tableServiceClient = new TableServiceClientBuilder()
     .connectionString("connectionstring")
     .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.

TableServiceClient tableServiceClient = new TableServiceClientBuilder()
     .endpoint("endpoint")
     .credential(new AzureNamedKeyCredential("name", "key"))
     .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:

TableServiceClient tableServiceClient = new TableServiceClientBuilder()
     .endpoint("endpoint")
     .credential(new AzureSasCredential("sasToken"))
     .buildClient();

Using a SAS token:

TableServiceClient tableServiceClient = new TableServiceClientBuilder()
     .endpoint("endpoint")
     .sasToken("sasToken")
     .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.

TableServiceClient tableServiceClient = new TableServiceClientBuilder()
     .endpoint("endpoint")
     .credential(new DefaultAzureCredentialBuilder().build())
     .buildClient();

Constructor Summary

Constructor	Description
TableServiceClientBuilder()	Creates a builder instance that is able to configure and construct TableServiceClient and TableServiceAsyncClient objects.

Method Summary

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

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

TableServiceClientBuilder

public TableServiceClientBuilder()

Creates a builder instance that is able to configure and construct TableServiceClient and TableServiceAsyncClient objects.

Method Details

addPolicy

public TableServiceClientBuilder 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:

Share via

TableServiceClientBuilder Class

Overview

Getting Started

Authentication 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

TableServiceClientBuilder

Method Details

addPolicy

buildAsyncClient

buildClient

clientOptions

configuration

connectionString

credential

credential

credential

enableTenantDiscovery

endpoint

httpClient

httpLogOptions

pipeline

retryOptions

retryPolicy

sasToken

serviceVersion

Applies to

Additional resources