Package com.azure.data.tables

Class TableClientBuilder

java.lang.Object

com.azure.data.tables.TableClientBuilder

public final class TableClientBuilder
extends Object

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

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(AzureSasCredential), credential(AzureNamedKeyCredential) or sasToken(String)

Samples to construct a sync client

 TableClient tableClient = new TableClientBuilder()
     .endpoint("https://myaccount.core.windows.net/")
     .credential(new AzureNamedKeyCredential("name", "key"))
     .tableName("myTable")
     .buildClient();
 

Samples to construct an async client

 TableAsyncClient tableAsyncClient = new TableClientBuilder()
     .endpoint("https://myaccount.core.windows.net/")
     .credential(new AzureNamedKeyCredential("name", "key"))
     .tableName("myTable")
     .buildAsyncClient();
 

See Also:

TableAsyncClient, TableClient

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
TableClientBuilder	addPolicy(com.azure.core.http.policy.HttpPipelinePolicy pipelinePolicy)	Adds a pipeline policy 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(com.azure.core.util.ClientOptions clientOptions)	Sets the ClientOptions such as application ID and custom headers to set on a request.
TableClientBuilder	configuration(com.azure.core.util.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(com.azure.core.credential.AzureNamedKeyCredential credential)	Sets the AzureNamedKeyCredential used to authorize requests sent to the service.
TableClientBuilder	credential(com.azure.core.credential.AzureSasCredential credential)	Sets the AzureSasCredential used to authorize requests sent to the service.
TableClientBuilder	credential(com.azure.core.credential.TokenCredential credential)	Sets the TokenCredential used to authorize requests sent to the service.
TableClientBuilder	endpoint(String endpoint)	Sets the service endpoint.
TableClientBuilder	httpClient(com.azure.core.http.HttpClient httpClient)	Sets the HttpClient to use for sending and receiving requests to and from the service.
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.
TableClientBuilder	pipeline(com.azure.core.http.HttpPipeline pipeline)	Sets the HttpPipeline to use for the service client.
TableClientBuilder	retryPolicy(com.azure.core.http.policy.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 service version that is used when making API requests.
TableClientBuilder	tableName(String tableName)	Sets the name of the table.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TableClientBuilder

public TableClientBuilder()

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

Method Detail

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.

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.

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. If pipeline is set, all other settings are ignored, aside from endpoint.

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.

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

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

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. Setting this is mutually exclusive with using credential(AzureNamedKeyCredential), credential(AzureSasCredential) or sasToken(String).

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.

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.

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. The policy will be added after the retry policy. If the method is called multiple times, all policies will be added and their order preserved.

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.

Parameters:

retryPolicy - RetryPolicy.

Returns:

The updated TableClientBuilder.

clientOptions

public TableClientBuilder clientOptions(com.azure.core.util.ClientOptions clientOptions)

Sets the ClientOptions such as application ID and custom headers to set on a request.

Parameters:

clientOptions - The ClientOptions.

Returns:

The updated TableClientBuilder.

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.