com.azure.data.tables

Class TableServiceClientBuilder

java.lang.Object

com.azure.data.tables.TableServiceClientBuilder

public class TableServiceClientBuilder
extends Object

builds the table service clients

Constructor Summary

Constructors

Constructor and Description
TableServiceClientBuilder() constructor

Method Summary

Modifier and Type	Method and Description
TableServiceClientBuilder	addPolicy(com.azure.core.http.policy.HttpPipelinePolicy pipelinePolicy) Adds a pipeline policy to apply on each request sent.
TableServiceAsyncClient	buildAsyncClient() builds an async TableServiceAsyncClient
TableServiceClient	buildClient() builds a sync TableServiceClient
TableServiceClientBuilder	configuration(com.azure.core.util.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 help build the client
TableServiceClientBuilder	credential(com.azure.core.credential.TokenCredential credential) update credential
TableServiceClientBuilder	endpoint(String endpoint) Sets the table service endpoint
TableServiceClientBuilder	httpClient(com.azure.core.http.HttpClient httpClient) Sets the HttpClient to use for sending a receiving requests to and from the service.
TableServiceClientBuilder	httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions) Sets the HttpLogOptions for service requests.
TableServiceClientBuilder	pipeline(com.azure.core.http.HttpPipeline pipeline) Sets the HTTP pipeline to use for the service client.
TableServiceClientBuilder	retryOptions(com.azure.storage.common.policy.RequestRetryOptions retryOptions) Sets the request retry options 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(TablesServiceVersion version) Sets the TablesServiceVersion that is used when making API requests.

Methods inherited from class java.lang.Object

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

Constructor Detail

TableServiceClientBuilder

public TableServiceClientBuilder()

constructor

Method Detail

buildClient

public TableServiceClient buildClient()

builds a sync TableServiceClient

Returns:

a sync TableServiceClient

buildAsyncClient

public TableServiceAsyncClient buildAsyncClient()

builds an async TableServiceAsyncClient

Returns:

TableServiceAsyncClient an aysnc TableServiceAsyncClient

connectionString

public TableServiceClientBuilder connectionString(String connectionString)

Sets the connection string to help build the client

Parameters:

connectionString - the connection string to the storage account

Returns:

the TableServiceClientBuilder

endpoint

public TableServiceClientBuilder endpoint(String endpoint)

Sets the table service endpoint

Parameters:

endpoint - URL of the service

Returns:

the updated TableServiceClientBuilder object

pipeline

public TableServiceClientBuilder pipeline(com.azure.core.http.HttpPipeline pipeline)

Sets the HTTP pipeline to use for the service client.

Parameters:

pipeline - The HTTP pipeline to use for sending service requests and receiving responses.

Returns:

The updated TableServiceClientBuilder object.

sasToken

public TableServiceClientBuilder sasToken(String sasToken)

Sets the SAS token used to authorize requests sent to the service.

Parameters:

sasToken - The SAS token to use for authenticating requests.

Returns:

the updated BlobServiceClientBuilder

Throws:

NullPointerException - If sasToken is null.

configuration

public TableServiceClientBuilder configuration(com.azure.core.util.Configuration configuration)

Sets the configuration object used to retrieve environment configuration values during building of the client.

Parameters:

configuration - Configuration store used to retrieve environment configurations.

Returns:

the updated TableServiceClientBuilder object

credential

public TableServiceClientBuilder credential(com.azure.core.credential.TokenCredential credential)

update credential

Parameters:

credential - the tables shared key credential

Returns:

the updated TableServiceClient builder

Throws:

NullPointerException - If credential is null.

httpClient

public TableServiceClientBuilder httpClient(com.azure.core.http.HttpClient httpClient)

Sets the HttpClient to use for sending a receiving requests to and from the service.

Parameters:

httpClient - HttpClient to use for requests.

Returns:

the updated TableServiceClientBuilder object

httpLogOptions

public TableServiceClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)

Sets the HttpLogOptions for service requests.

Parameters:

logOptions - The logging configuration to use when sending and receiving HTTP requests/responses.

Returns:

the updated TableServiceClientBuilder object

Throws:

NullPointerException - If logOptions is null.

addPolicy

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

Throws:

NullPointerException - If pipelinePolicy is null.

serviceVersion

public TableServiceClientBuilder serviceVersion(TablesServiceVersion version)

Sets the TablesServiceVersion 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 - TablesServiceVersion of the service to be used when making requests.

Returns:

the updated TableServiceClientBuilder object

retryOptions

public TableServiceClientBuilder retryOptions(com.azure.storage.common.policy.RequestRetryOptions retryOptions)

Sets the request retry options for all the requests made through the client.

Parameters:

retryOptions - RequestRetryOptions.

Returns:

the updated TableServiceClientBuilder object

Throws:

NullPointerException - If retryOptions is null.