Package com.azure.storage.file.datalake

Class DataLakeFileSystemClientBuilder

  • public class DataLakeFileSystemClientBuilder
extends Object
    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 Detail

    • Method Detail

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

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

      • endpoint

        public DataLakeFileSystemClientBuilder endpoint​(String endpoint)
        Sets the service endpoint, additionally parses it for information (SAS token, file system name)
        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​(com.azure.storage.common.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​(com.azure.core.credential.TokenCredential credential)
        Sets the TokenCredential used to authorize requests sent to the service.
        Parameters:
        credential - TokenCredential.
        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​(com.azure.core.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 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​(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 DataLakeFileSystemClientBuilder object

      • getDefaultHttpLogOptions

        public static com.azure.core.http.policy.HttpLogOptions getDefaultHttpLogOptions()
        Gets the default Storage allowlist log headers and query parameters.
        Returns:
        the default http log options.

      • addPolicy

        public DataLakeFileSystemClientBuilder 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 DataLakeFileSystemClientBuilder object
        Throws:
        NullPointerException - If pipelinePolicy is null.

      • httpLogOptions

        public DataLakeFileSystemClientBuilder 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 DataLakeFileSystemClientBuilder object
        Throws:
        NullPointerException - If logOptions is null.

      • configuration

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

      • retryOptions

        public DataLakeFileSystemClientBuilder 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 DataLakeFileSystemClientBuilder object
        Throws:
        NullPointerException - If retryOptions is null.

      • pipeline

        public DataLakeFileSystemClientBuilder pipeline​(com.azure.core.http.HttpPipeline httpPipeline)
        Sets the HttpPipeline to use for the service client. If pipeline is set, all other settings are ignored, aside from endpoint.
        Parameters:
        httpPipeline - HttpPipeline to use for sending service requests and receiving responses.
        Returns:
        the updated DataLakeFileSystemClientBuilder object

      • clientOptions

        public DataLakeFileSystemClientBuilder clientOptions​(com.azure.core.util.ClientOptions clientOptions)
        Sets the client options for all the requests made through the client.
        Parameters:
        clientOptions - ClientOptions.
        Returns:
        the updated DataLakeFileSystemClientBuilder object
        Throws:
        NullPointerException - If clientOptions is null.

      • 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