com.azure.data.tables

Class TableClientBuilder

java.lang.Object

com.azure.data.tables.TableClientBuilder

public class TableClientBuilder
extends Object

builds table client

Method Summary

Modifier and Type	Method and Description
TableClientBuilder	addPolicy(com.azure.core.http.policy.HttpPipelinePolicy pipelinePolicy) Adds a policy to the set of existing policies that are executed after required policies.
TableAsyncClient	buildAsyncClient() builds an async tableClient
TableClient	buildClient() builds a sync tableClient
TableClientBuilder	configuration(com.azure.core.util.Configuration configuration) Sets the configuration store that is used during construction of the service client.
TableClientBuilder	connectionString(String connectionString) Sets the connection string to help build the client
TableClientBuilder	credential(com.azure.core.credential.TokenCredential credential) Sets the TokenCredential used to authenticate HTTP requests.
TableClientBuilder	endpoint(String endpoint) Sets the endpoint for the Azure Storage Table instance that the client will interact with.
TableClientBuilder	httpClient(com.azure.core.http.HttpClient client) Sets the HTTP client 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 for HTTP requests and responses.
TableClientBuilder	pipeline(com.azure.core.http.HttpPipeline pipeline) Sets the HTTP pipeline to use for the service client.
TableClientBuilder	retryOptions(com.azure.storage.common.policy.RequestRetryOptions retryOptions) Sets the request retry options 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(TablesServiceVersion version) Sets the TablesServiceVersion that is used when making API requests.
TableClientBuilder	tableName(String tableName) Sets the table name to help build the client

Methods inherited from class java.lang.Object

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

Method Detail

connectionString

public TableClientBuilder connectionString(String connectionString)

Sets the connection string to help build the client

Parameters:

connectionString - the connection string to the storage account

Returns:

the TableClientBuilder

tableName

public TableClientBuilder tableName(String tableName)

Sets the table name to help build the client

Parameters:

tableName - name of the table for which the client is created for

Returns:

the TableClientBuilder

buildClient

public TableClient buildClient()

builds a sync tableClient

Returns:

a sync tableClient

buildAsyncClient

public TableAsyncClient buildAsyncClient()

builds an async tableClient

Returns:

an aysnc tableClient

endpoint

public TableClientBuilder endpoint(String endpoint)

Sets the endpoint for the Azure Storage Table instance that the client will interact with.

Parameters:

endpoint - The URL of the Azure Storage Table instance to send service requests to and receive responses from.

Returns:

the updated TableClientBuilder object

Throws:

IllegalArgumentException - If endpoint isn't a proper URL

pipeline

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

sasToken

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

Throws:

NullPointerException - If sasToken is null.

configuration

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

Sets the configuration store that is used during construction of the service 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 - The configuration store used to

Returns:

The updated TableClientBuilder object.

credential

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

Sets the TokenCredential used to authenticate HTTP requests.

Parameters:

credential - TokenCredential used to authenticate HTTP requests.

Returns:

The updated TableClientBuilder object.

Throws:

NullPointerException - If credential is null.

httpClient

public TableClientBuilder httpClient(com.azure.core.http.HttpClient client)

Sets the HTTP client to use for sending and receiving requests to and from the service.

Parameters:

client - The HTTP client to use for requests.

Returns:

The updated TableClientBuilder object.

httpLogOptions

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

Sets the logging configuration for HTTP requests and responses.

If logLevel is not provided, default value of HttpLogDetailLevel.NONE is set.

Parameters:

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

Returns:

The updated TableClientBuilder object.

addPolicy

public TableClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy pipelinePolicy)

Adds a policy to the set of existing policies that are executed after required policies.

Parameters:

pipelinePolicy - The retry policy for service requests.

Returns:

The updated TableClientBuilder object.

Throws:

NullPointerException - If policy is null.

serviceVersion

public TableClientBuilder serviceVersion(TablesServiceVersion version)

Sets the TablesServiceVersion that is used when making API requests.

Parameters:

version - TablesServiceVersion of the service to be used when making requests.

Returns:

The updated TableClientBuilder object.

retryOptions

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