DataLakeServiceClientBuilder Class

Package:

com.azure.storage.file.datalake

Maven Artifact:

com.azure:azure-storage-file-datalake:12.18.4

• java.lang.Object
• • com.azure.storage.file.datalake.DataLakeServiceClientBuilder

Implements

AzureNamedKeyCredentialTrait<DataLakeServiceClientBuilder> AzureSasCredentialTrait<DataLakeServiceClientBuilder> ConfigurationTrait<DataLakeServiceClientBuilder> EndpointTrait<DataLakeServiceClientBuilder> HttpTrait<DataLakeServiceClientBuilder> TokenCredentialTrait<DataLakeServiceClientBuilder>

public class DataLakeServiceClientBuilder
implements TokenCredentialTrait<DataLakeServiceClientBuilder>, AzureNamedKeyCredentialTrait<DataLakeServiceClientBuilder>, AzureSasCredentialTrait<DataLakeServiceClientBuilder>, HttpTrait<DataLakeServiceClientBuilder>, ConfigurationTrait<DataLakeServiceClientBuilder>, EndpointTrait<DataLakeServiceClientBuilder>

This class provides a fluent builder API to help aid the configuration and instantiation of DataLakeServiceClient and DataLakeServiceAsyncClient, call buildClient() and buildAsyncClient() respectively to construct an instance of the desired client.

The following information must be provided on this builder:

• the endpoint through .endpoint(), in the format of https://{accountName}.dfs.core.windows.net.
• the credential through .credential() or .connectionString().

Constructor Summary

Constructor	Description
DataLakeServiceClientBuilder()	Creates a builder instance that is able to configure and construct DataLakeServiceClient and DataLakeServiceAsyncClient.

Method Summary

Modifier and Type	Method and Description
DataLakeServiceClientBuilder	addPolicy(HttpPipelinePolicy pipelinePolicy) Adds a HttpPipelinePolicy to apply on each request sent.
DataLakeServiceClientBuilder	audience(DataLakeAudience audience) Sets the Audience to use for authentication with Azure Active Directory (AAD).
DataLakeServiceAsyncClient	buildAsyncClient()
DataLakeServiceClient	buildClient()
DataLakeServiceClientBuilder	clientOptions(ClientOptions clientOptions) Allows for setting common properties such as application ID, headers, proxy configuration, etc.
DataLakeServiceClientBuilder	configuration(Configuration configuration) Sets the configuration object used to retrieve environment configuration values during building of the client.
DataLakeServiceClientBuilder	connectionString(String connectionString) Sets the connection string to connect to the service.
DataLakeServiceClientBuilder	credential(AzureNamedKeyCredential credential) Sets the AzureNamedKeyCredential used to authorize requests sent to the service.
DataLakeServiceClientBuilder	credential(AzureSasCredential credential) Sets the AzureSasCredential used to authorize requests sent to the service.
DataLakeServiceClientBuilder	credential(TokenCredential credential) Sets the TokenCredential used to authorize requests sent to the service.
DataLakeServiceClientBuilder	credential(StorageSharedKeyCredential credential) Sets the StorageSharedKeyCredential used to authorize requests sent to the service.
DataLakeServiceClientBuilder	customerProvidedKey(CustomerProvidedKey customerProvidedKey) Sets the CustomerProvidedKey that is used to encrypt file contents on the server.
DataLakeServiceClientBuilder	encryptionScope(String encryptionScope) Sets the encryption scope that is used to encrypt path contents on the server.
DataLakeServiceClientBuilder	endpoint(String endpoint) Sets the data lake service endpoint, additionally parses it for information (SAS token)
DataLakeServiceClientBuilder	fileSystemEncryptionScopeOptions(FileSystemEncryptionScopeOptions fileSystemEncryptionScopeOptions) Sets the FileSystemEncryptionScopeOptions that is used to determine how path contents are encrypted on the server.
static HttpLogOptions	getDefaultHttpLogOptions() Gets the default Storage allowlist log headers and query parameters.
DataLakeServiceClientBuilder	httpClient(HttpClient httpClient) Sets the HttpClient to use for sending and receiving requests to and from the service.
DataLakeServiceClientBuilder	httpLogOptions(HttpLogOptions logOptions) Sets the HttpLogOptions to use when sending and receiving requests to and from the service.
DataLakeServiceClientBuilder	pipeline(HttpPipeline httpPipeline) Sets the HttpPipeline to use for the service client.
DataLakeServiceClientBuilder	retryOptions(RetryOptions retryOptions) Sets the RetryOptions for all the requests made through the client.
DataLakeServiceClientBuilder	retryOptions(RequestRetryOptions retryOptions) Sets the request retry options for all the requests made through the client.
DataLakeServiceClientBuilder	sasToken(String sasToken) Sets the SAS token used to authorize requests sent to the service.
DataLakeServiceClientBuilder	serviceVersion(DataLakeServiceVersion version) Sets the DataLakeServiceVersion 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

DataLakeServiceClientBuilder

public DataLakeServiceClientBuilder()

Creates a builder instance that is able to configure and construct DataLakeServiceClient and DataLakeServiceAsyncClient.

Method Details

addPolicy

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

the updated DataLakeServiceClientBuilder object

audience

public DataLakeServiceClientBuilder audience(DataLakeAudience audience)

Sets the Audience to use for authentication with Azure Active Directory (AAD). The audience is not considered when using a shared key.

Parameters:

audience - DataLakeAudience to be used when requesting a token from Azure Active Directory (AAD).

Returns:

the updated DataLakeServiceClientBuilder object

buildAsyncClient

public DataLakeServiceAsyncClient buildAsyncClient()

Returns:

a DataLakeServiceAsyncClient created from the configurations in this builder.

buildClient

public DataLakeServiceClient buildClient()

Returns:

a DataLakeServiceClient created from the configurations in this builder.

clientOptions

public DataLakeServiceClientBuilder clientOptions(ClientOptions clientOptions)

Allows for setting common properties such as application ID, headers, proxy configuration, etc. Note that it is recommended that this method be called with an instance of the HttpClientOptions class (a subclass of the ClientOptions base class). The HttpClientOptions subclass provides more configuration options suitable for HTTP clients, which is applicable for any class that implements this HttpTrait interface.

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:

clientOptions - A configured instance of HttpClientOptions.

Returns:

the updated DataLakeServiceClientBuilder object

configuration

public DataLakeServiceClientBuilder configuration(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 DataLakeServiceClientBuilder object

connectionString

public DataLakeServiceClientBuilder connectionString(String connectionString)

Sets the connection string to connect to the service.

Parameters:

connectionString - Connection string of the storage account.

Returns:

the updated DataLakeServiceClientBuilder

credential

public DataLakeServiceClientBuilder credential(AzureNamedKeyCredential credential)

Sets the AzureNamedKeyCredential used to authorize requests sent to the service.

Parameters:

credential - AzureNamedKeyCredential.

Returns:

the updated DataLakeServiceClientBuilder

credential

public DataLakeServiceClientBuilder credential(AzureSasCredential credential)

Sets the AzureSasCredential used to authorize requests sent to the service.

Parameters:

credential - AzureSasCredential used to authorize requests sent to the service.

Returns:

the updated DataLakeServiceClientBuilder

credential

public DataLakeServiceClientBuilder credential(TokenCredential credential)

Sets the TokenCredential used to authorize requests sent to the service. Refer to the Azure SDK for Java identity and authentication documentation for more details on proper usage of the TokenCredential type.

Parameters:

credential - TokenCredential used to authorize requests sent to the service.

Returns:

the updated DataLakeServiceClientBuilder

credential

public DataLakeServiceClientBuilder credential(StorageSharedKeyCredential credential)

Sets the StorageSharedKeyCredential used to authorize requests sent to the service.

Parameters:

credential - StorageSharedKeyCredential.

Returns:

the updated DataLakeServiceClientBuilder

customerProvidedKey

public DataLakeServiceClientBuilder customerProvidedKey(CustomerProvidedKey customerProvidedKey)

Sets the CustomerProvidedKey that is used to encrypt file contents on the server.

Parameters:

customerProvidedKey - Customer provided key containing the encryption key information.

Returns:

the updated DataLakeServiceClientBuilder object

encryptionScope

public DataLakeServiceClientBuilder encryptionScope(String encryptionScope)

Sets the encryption scope that is used to encrypt path contents on the server.

Parameters:

encryptionScope - Encryption scope containing the encryption key information.

Returns:

the updated DataLakeServiceClientBuilder object

endpoint

public DataLakeServiceClientBuilder endpoint(String endpoint)

Sets the data lake service endpoint, additionally parses it for information (SAS token)

Parameters:

endpoint - URL of the service

Returns:

the updated DataLakeServiceClientBuilder object

fileSystemEncryptionScopeOptions

public DataLakeServiceClientBuilder fileSystemEncryptionScopeOptions(FileSystemEncryptionScopeOptions fileSystemEncryptionScopeOptions)

Sets the FileSystemEncryptionScopeOptions that is used to determine how path contents are encrypted on the server.

Parameters:

fileSystemEncryptionScopeOptions - Encryption scope containing the encryption key information.

Returns:

the updated DataLakeServiceClientBuilder object

getDefaultHttpLogOptions

public static HttpLogOptions getDefaultHttpLogOptions()

Gets the default Storage allowlist log headers and query parameters.

Returns:

the default http log options.

httpClient

public DataLakeServiceClientBuilder httpClient(HttpClient httpClient)

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

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:

httpClient - The HttpClient to use for requests.

Returns:

the updated DataLakeServiceClientBuilder object

httpLogOptions

public DataLakeServiceClientBuilder httpLogOptions(HttpLogOptions logOptions)

Sets the HttpLogOptions 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.

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:

logOptions - The HttpLogOptions to use when sending and receiving requests to and from the service.

Returns:

the updated DataLakeServiceClientBuilder object

pipeline

public DataLakeServiceClientBuilder pipeline(HttpPipeline httpPipeline)

Sets the HttpPipeline to use for the service client.

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.

The endpoint(String endpoint) is not ignored when pipeline is set.

Parameters:

httpPipeline - HttpPipeline to use for sending service requests and receiving responses.

Returns:

the updated DataLakeServiceClientBuilder object

retryOptions

public DataLakeServiceClientBuilder retryOptions(RetryOptions retryOptions)

Sets the RetryOptions for all the requests made through the client.

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.

Setting this is mutually exclusive with using retryOptions(RequestRetryOptions retryOptions). Consider using retryOptions(RequestRetryOptions retryOptions) to also set storage specific options.

Parameters:

retryOptions - The RetryOptions to use for all the requests made through the client.

Returns:

the updated DataLakeServiceClientBuilder object

retryOptions

public DataLakeServiceClientBuilder retryOptions(RequestRetryOptions retryOptions)

Sets the request retry options for all the requests made through the client. Setting this is mutually exclusive with using retryOptions(RetryOptions retryOptions).

Parameters:

retryOptions - RequestRetryOptions.

Returns:

the updated DataLakeServiceClientBuilder object

sasToken

public DataLakeServiceClientBuilder 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. This string should only be the query parameters (with or without a leading '?') and not a full url.

Returns:

the updated DataLakeServiceClientBuilder

serviceVersion

public DataLakeServiceClientBuilder serviceVersion(DataLakeServiceVersion version)

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

Returns:

the updated DataLakeServiceClientBuilder object