Package com.azure.storage.file.datalake

Class DataLakeFileSystemClientBuilder

java.lang.Object

com.azure.storage.file.datalake.DataLakeFileSystemClientBuilder

All Implemented Interfaces:

AzureNamedKeyCredentialTrait<DataLakeFileSystemClientBuilder>, AzureSasCredentialTrait<DataLakeFileSystemClientBuilder>, ConfigurationTrait<DataLakeFileSystemClientBuilder>, EndpointTrait<DataLakeFileSystemClientBuilder>, HttpTrait<DataLakeFileSystemClientBuilder>, TokenCredentialTrait<DataLakeFileSystemClientBuilder>

public class DataLakeFileSystemClientBuilder
extends Object
implements TokenCredentialTrait<DataLakeFileSystemClientBuilder>, AzureNamedKeyCredentialTrait<DataLakeFileSystemClientBuilder>, AzureSasCredentialTrait<DataLakeFileSystemClientBuilder>, HttpTrait<DataLakeFileSystemClientBuilder>, ConfigurationTrait<DataLakeFileSystemClientBuilder>, EndpointTrait<DataLakeFileSystemClientBuilder>

This class provides a fluent builder API to help aid the configuration and instantiation of FileSystemClients and FileSystemAsyncClients, 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(), including the file system name, in the format of https://{accountName}.dfs.core.windows.net/{fileSystemName}.
• the credential through .credential() or .connectionString() if the file system is not publicly accessible.

Constructor Summary

Constructors

Constructor	Description
DataLakeFileSystemClientBuilder()	Creates a builder instance that is able to configure and construct FileSystemClients and FileSystemAsyncClients.

Method Summary

Modifier and Type	Method	Description
DataLakeFileSystemClientBuilder	addPolicy(HttpPipelinePolicy pipelinePolicy)	Adds a pipeline policy to apply on each request sent.
DataLakeFileSystemAsyncClient	buildAsyncClient()	Code Samples
DataLakeFileSystemClient	buildClient()	Code Samples
DataLakeFileSystemClientBuilder	clientOptions(ClientOptions clientOptions)	Allows for setting common properties such as application ID, headers, proxy configuration, etc.
DataLakeFileSystemClientBuilder	configuration(Configuration configuration)	Sets the configuration object used to retrieve environment configuration values during building of the client.
DataLakeFileSystemClientBuilder	credential(AzureNamedKeyCredential credential)	Sets the AzureNamedKeyCredential used to authorize requests sent to the service.
DataLakeFileSystemClientBuilder	credential(AzureSasCredential credential)	Sets the AzureSasCredential used to authorize requests sent to the service.
DataLakeFileSystemClientBuilder	credential(TokenCredential credential)	Sets the TokenCredential used to authorize requests sent to the service.
DataLakeFileSystemClientBuilder	credential(StorageSharedKeyCredential credential)	Sets the StorageSharedKeyCredential used to authorize requests sent to the service.
DataLakeFileSystemClientBuilder	customerProvidedKey(CustomerProvidedKey customerProvidedKey)	Sets the customer provided key that is used to encrypt file contents on the server.
DataLakeFileSystemClientBuilder	endpoint(String endpoint)	Sets the service endpoint, additionally parses it for information (SAS token, file system name)
DataLakeFileSystemClientBuilder	fileSystemName(String fileSystemName)	Sets the name of the file system.
static HttpLogOptions	getDefaultHttpLogOptions()	Gets the default Storage allowlist log headers and query parameters.
DataLakeFileSystemClientBuilder	httpClient(HttpClient httpClient)	Sets the HttpClient to use for sending and receiving requests to and from the service.
DataLakeFileSystemClientBuilder	httpLogOptions(HttpLogOptions logOptions)	Sets the logging configuration to use when sending and receiving requests to and from the service.
DataLakeFileSystemClientBuilder	pipeline(HttpPipeline httpPipeline)	Sets the HttpPipeline to use for the service client.
DataLakeFileSystemClientBuilder	retryOptions(RetryOptions retryOptions)	Sets the RetryOptions for all the requests made through the client.
DataLakeFileSystemClientBuilder	retryOptions(RequestRetryOptions retryOptions)	Sets the request retry options for all the requests made through the client.
DataLakeFileSystemClientBuilder	sasToken(String sasToken)	Sets the SAS token used to authorize requests sent to the service.
DataLakeFileSystemClientBuilder	serviceVersion(DataLakeServiceVersion version)	Sets the DataLakeServiceVersion that is used when making API requests.
DataLakeFileSystemClientBuilder	setAnonymousAccess()	Clears the credential used to authorize the request.

Methods inherited from class java.lang.Object

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

Constructor Details

DataLakeFileSystemClientBuilder

public DataLakeFileSystemClientBuilder()

Creates a builder instance that is able to configure and construct FileSystemClients and FileSystemAsyncClients.

Method Details

buildClient

public DataLakeFileSystemClient buildClient()

Code Samples

 DataLakeFileSystemClient client = new DataLakeFileSystemClientBuilder()
     .endpoint(endpoint)
     .credential(storageSharedKeyCredential)
     .buildClient();
 

Returns:

a DataLakeFileSystemClient created from the configurations in this builder.

Throws:

IllegalStateException - If multiple credentials have been specified.

IllegalStateException - If both retryOptions(RetryOptions) and retryOptions(RequestRetryOptions) have been set.

buildAsyncClient

public DataLakeFileSystemAsyncClient buildAsyncClient()

Code Samples

 DataLakeFileSystemAsyncClient client = new DataLakeFileSystemClientBuilder()
     .endpoint(endpoint)
     .credential(storageSharedKeyCredential)
     .buildAsyncClient();
 

Returns:

a DataLakeFileSystemAsyncClient created from the configurations in this builder.

Throws:

IllegalStateException - If multiple credentials have been specified.

IllegalStateException - If both retryOptions(RetryOptions) and retryOptions(RequestRetryOptions) have been set.

endpoint

public DataLakeFileSystemClientBuilder endpoint(String endpoint)

Sets the service endpoint, additionally parses it for information (SAS token, file system name)

Specified by:

endpoint in interface EndpointTrait<DataLakeFileSystemClientBuilder>

Parameters:

endpoint - URL of the service

Returns:

the updated DataLakeFileSystemClientBuilder object

Throws:

IllegalArgumentException - If endpoint is null or is a malformed URL.

credential

public DataLakeFileSystemClientBuilder credential(StorageSharedKeyCredential credential)

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

Parameters:

credential - StorageSharedKeyCredential.

Returns:

the updated DataLakeFileSystemClientBuilder

Throws:

NullPointerException - If credential is null.

credential

public DataLakeFileSystemClientBuilder credential(AzureNamedKeyCredential credential)

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

Specified by:

credential in interface AzureNamedKeyCredentialTrait<DataLakeFileSystemClientBuilder>

Parameters:

credential - AzureNamedKeyCredential.

Returns:

the updated DataLakeFileSystemClientBuilder

Throws:

NullPointerException - If credential is null.

credential

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

Specified by:

credential in interface TokenCredentialTrait<DataLakeFileSystemClientBuilder>

Parameters:

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

Returns:

the updated DataLakeFileSystemClientBuilder

Throws:

NullPointerException - If credential is null.

sasToken

public DataLakeFileSystemClientBuilder 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 DataLakeFileSystemClientBuilder

Throws:

NullPointerException - If sasToken is null.

credential

public DataLakeFileSystemClientBuilder credential(AzureSasCredential credential)

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

Specified by:

credential in interface AzureSasCredentialTrait<DataLakeFileSystemClientBuilder>

Parameters:

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

Returns:

the updated DataLakeFileSystemClientBuilder

Throws:

NullPointerException - If credential is null.

setAnonymousAccess

public DataLakeFileSystemClientBuilder setAnonymousAccess()

Clears the credential used to authorize the request.

This is for file systems that are publicly accessible.

Returns:

the updated DataLakeFileSystemClientBuilder

fileSystemName

public DataLakeFileSystemClientBuilder fileSystemName(String fileSystemName)

Sets the name of the file system.

Parameters:

fileSystemName - Name of the file system. If the value null or empty the root file system, $root, will be used.

Returns:

the updated DataLakeFileSystemClientBuilder object

httpClient

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

Specified by:

httpClient in interface HttpTrait<DataLakeFileSystemClientBuilder>

Parameters:

httpClient - The HttpClient to use for requests.

Returns:

the updated DataLakeFileSystemClientBuilder object

getDefaultHttpLogOptions

public static HttpLogOptions getDefaultHttpLogOptions()

Gets the default Storage allowlist log headers and query parameters.

Returns:

the default http log options.

addPolicy

public DataLakeFileSystemClientBuilder addPolicy(HttpPipelinePolicy pipelinePolicy)

Adds a pipeline policy 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.

Specified by:

addPolicy in interface HttpTrait<DataLakeFileSystemClientBuilder>

Parameters:

pipelinePolicy - A pipeline policy.

Returns:

the updated DataLakeFileSystemClientBuilder object

Throws:

NullPointerException - If pipelinePolicy is null.

httpLogOptions

public DataLakeFileSystemClientBuilder httpLogOptions(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.

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.

Specified by:

httpLogOptions in interface HttpTrait<DataLakeFileSystemClientBuilder>

Parameters:

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

Returns:

the updated DataLakeFileSystemClientBuilder object

Throws:

NullPointerException - If logOptions is null.

configuration

public DataLakeFileSystemClientBuilder configuration(Configuration configuration)

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

Specified by:

configuration in interface ConfigurationTrait<DataLakeFileSystemClientBuilder>

Parameters:

configuration - Configuration store used to retrieve environment configurations.

Returns:

the updated DataLakeFileSystemClientBuilder object

retryOptions

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

Parameters:

retryOptions - RequestRetryOptions.

Returns:

the updated DataLakeFileSystemClientBuilder object.

retryOptions

public DataLakeFileSystemClientBuilder 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). Consider using retryOptions(RequestRetryOptions) to also set storage specific options.

Specified by:

retryOptions in interface HttpTrait<DataLakeFileSystemClientBuilder>

Parameters:

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

Returns:

the updated DataLakeFileSystemClientBuilder object

pipeline

public DataLakeFileSystemClientBuilder 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 is not ignored when pipeline is set.

Specified by:

pipeline in interface HttpTrait<DataLakeFileSystemClientBuilder>

Parameters:

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

Returns:

the updated DataLakeFileSystemClientBuilder object

clientOptions

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

Specified by:

clientOptions in interface HttpTrait<DataLakeFileSystemClientBuilder>

Parameters:

clientOptions - A configured instance of HttpClientOptions.

Returns:

the updated DataLakeFileSystemClientBuilder object

Throws:

NullPointerException - If clientOptions is null.

See Also:

• HttpClientOptions

serviceVersion

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

customerProvidedKey

public DataLakeFileSystemClientBuilder customerProvidedKey(CustomerProvidedKey customerProvidedKey)

Sets the customer provided key that is used to encrypt file contents on the server.

Parameters:

customerProvidedKey - Customer provided key containing the encryption key information.

Returns:

the updated DataLakeFileSystemClientBuilder object