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

Implements

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

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

This class provides a fluent builder API to help aid the configuration and instantiation of DataLakeFileClient, DataLakeFileAsyncClient, DataLakeDirectoryClient and DataLakeDirectoryAsyncClient, call buildFileClient(), buildFileAsyncClient(), buildDirectoryClient() and buildDirectoryAsyncClient() 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 and file/directory name, in the format of https://{accountName}.dfs.core.windows.net/{fileSystemName}/{pathName}.
• the credential through .credential() or .connectionString() if the file system is not publicly accessible.

Constructor Summary

Constructor	Description
DataLakePathClientBuilder()	Creates a builder instance that is able to configure and construct DataLakeFileClient, DataLakeFileAsyncClient, DataLakeDirectoryClient and DataLakeDirectoryAsyncClient.

Method Summary

Modifier and Type	Method and Description
DataLakePathClientBuilder	addPolicy(HttpPipelinePolicy pipelinePolicy) Adds a HttpPipelinePolicy to apply on each request sent.
DataLakePathClientBuilder	audience(DataLakeAudience audience) Sets the Audience to use for authentication with Azure Active Directory (AAD).
DataLakeDirectoryAsyncClient	buildDirectoryAsyncClient() Creates a DataLakeDirectoryAsyncClient based on options set in the builder.
DataLakeDirectoryClient	buildDirectoryClient() Creates a DataLakeDirectoryClient based on options set in the builder.
DataLakeFileAsyncClient	buildFileAsyncClient() Creates a DataLakeFileAsyncClient based on options set in the builder.
DataLakeFileClient	buildFileClient() Creates a DataLakeFileClient based on options set in the builder.
DataLakePathClientBuilder	clientOptions(ClientOptions clientOptions) Allows for setting common properties such as application ID, headers, proxy configuration, etc.
DataLakePathClientBuilder	configuration(Configuration configuration) Sets the configuration object used to retrieve environment configuration values during building of the client.
DataLakePathClientBuilder	credential(AzureNamedKeyCredential credential) Sets the AzureNamedKeyCredential used to authorize requests sent to the service.
DataLakePathClientBuilder	credential(AzureSasCredential credential) Sets the AzureSasCredential used to authorize requests sent to the service.
DataLakePathClientBuilder	credential(TokenCredential credential) Sets the TokenCredential used to authorize requests sent to the service.
DataLakePathClientBuilder	credential(StorageSharedKeyCredential credential) Sets the StorageSharedKeyCredential used to authorize requests sent to the service.
DataLakePathClientBuilder	customerProvidedKey(CustomerProvidedKey customerProvidedKey) Sets the CustomerProvidedKey that is used to encrypt blob contents on the server.
DataLakePathClientBuilder	endpoint(String endpoint) Sets the service endpoint, additionally parses it for information (SAS token, file system name, path name)
DataLakePathClientBuilder	fileSystemName(String fileSystemName) Sets the name of the file system that contains the path.
static HttpLogOptions	getDefaultHttpLogOptions() Gets the default Storage allowlist log headers and query parameters.
DataLakePathClientBuilder	httpClient(HttpClient httpClient) Sets the HttpClient to use for sending and receiving requests to and from the service.
DataLakePathClientBuilder	httpLogOptions(HttpLogOptions logOptions) Sets the HttpLogOptions to use when sending and receiving requests to and from the service.
DataLakePathClientBuilder	pathName(String pathName) Sets the name of the file/directory.
DataLakePathClientBuilder	pipeline(HttpPipeline httpPipeline) Sets the HttpPipeline to use for the service client.
DataLakePathClientBuilder	retryOptions(RetryOptions retryOptions) Sets the RetryOptions for all the requests made through the client.
DataLakePathClientBuilder	retryOptions(RequestRetryOptions retryOptions) Sets the request retry options for all the requests made through the client.
DataLakePathClientBuilder	sasToken(String sasToken) Sets the SAS token used to authorize requests sent to the service.
DataLakePathClientBuilder	serviceVersion(DataLakeServiceVersion version) Sets the DataLakeServiceVersion that is used when making API requests.
DataLakePathClientBuilder	setAnonymousAccess() Clears the credential used to authorize the request.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DataLakePathClientBuilder

public DataLakePathClientBuilder()

Creates a builder instance that is able to configure and construct DataLakeFileClient, DataLakeFileAsyncClient, DataLakeDirectoryClient and DataLakeDirectoryAsyncClient.

Method Details

addPolicy

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

audience

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

buildDirectoryAsyncClient

public DataLakeDirectoryAsyncClient buildDirectoryAsyncClient()

Creates a DataLakeDirectoryAsyncClient based on options set in the builder.

Code Samples

DataLakeDirectoryAsyncClient client = new DataLakePathClientBuilder()
     .endpoint(endpoint)
     .credential(storageSharedKeyCredential)
     .buildDirectoryAsyncClient();

Returns:

a DataLakeDirectoryAsyncClient created from the configurations in this builder.

buildDirectoryClient

public DataLakeDirectoryClient buildDirectoryClient()

Creates a DataLakeDirectoryClient based on options set in the builder.

Code Samples

DataLakeDirectoryClient client = new DataLakePathClientBuilder()
     .endpoint(endpoint)
     .credential(storageSharedKeyCredential)
     .buildDirectoryClient();

Returns:

a DataLakeDirectoryClient created from the configurations in this builder.

buildFileAsyncClient

public DataLakeFileAsyncClient buildFileAsyncClient()

Creates a DataLakeFileAsyncClient based on options set in the builder.

Code Samples

DataLakeFileAsyncClient client = new DataLakePathClientBuilder()
     .endpoint(endpoint)
     .credential(storageSharedKeyCredential)
     .buildFileAsyncClient();

Returns:

a DataLakeFileAsyncClient created from the configurations in this builder.

buildFileClient

public DataLakeFileClient buildFileClient()

Creates a DataLakeFileClient based on options set in the builder.

Code Samples

DataLakeFileClient client = new DataLakePathClientBuilder()
     .endpoint(endpoint)
     .credential(storageSharedKeyCredential)
     .buildFileClient();

Returns:

a DataLakeFileClient created from the configurations in this builder.

clientOptions

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

configuration

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

credential

public DataLakePathClientBuilder credential(AzureNamedKeyCredential credential)

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

Parameters:

credential - AzureNamedKeyCredential.

Returns:

the updated DataLakePathClientBuilder

credential

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

credential

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

credential

public DataLakePathClientBuilder credential(StorageSharedKeyCredential credential)

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

Parameters:

credential - StorageSharedKeyCredential.

Returns:

the updated DataLakePathClientBuilder

customerProvidedKey

public DataLakePathClientBuilder customerProvidedKey(CustomerProvidedKey customerProvidedKey)

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

Parameters:

customerProvidedKey - Customer provided key containing the encryption key information.

Returns:

the updated DataLakePathClientBuilder object

endpoint

public DataLakePathClientBuilder endpoint(String endpoint)

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

If the path name contains special characters, pass in the url encoded version of the path name.

If the endpoint is to a file/directory in the root container, this method will fail as it will interpret the path name as the file system name. With only one path element, it is impossible to distinguish between a file system name and a path in the root file system, so it is assumed to be the file system name as this is much more common. When working with paths in the root file system, it is best to set the endpoint to the account url and specify the path name separately using the pathName(String pathName) method.

Parameters:

endpoint - URL of the service

Returns:

the updated DataLakePathClientBuilder object

fileSystemName

public DataLakePathClientBuilder fileSystemName(String fileSystemName)

Sets the name of the file system that contains the path.

Parameters:

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

Returns:

the updated DataLakePathClientBuilder object

getDefaultHttpLogOptions

public static HttpLogOptions getDefaultHttpLogOptions()

Gets the default Storage allowlist log headers and query parameters.

Returns:

the default http log options.

httpClient

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

httpLogOptions

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

pathName

public DataLakePathClientBuilder pathName(String pathName)

Sets the name of the file/directory.

Parameters:

pathName - Name of the path. If the path name contains special characters, pass in the url encoded version of the path name.

Returns:

the updated DataLakePathClientBuilder object

pipeline

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

retryOptions

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

retryOptions

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

sasToken

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

serviceVersion

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

setAnonymousAccess

public DataLakePathClientBuilder setAnonymousAccess()

Clears the credential used to authorize the request.

This is for paths that are publicly accessible.

Returns:

the updated DataLakePathClientBuilder