Package com.azure.storage.file.datalake

Class DataLakePathClientBuilder

java.lang.Object
com.azure.storage.file.datalake.DataLakePathClientBuilder
All Implemented Interfaces:
com.azure.core.client.traits.AzureNamedKeyCredentialTrait<DataLakePathClientBuilder>, com.azure.core.client.traits.AzureSasCredentialTrait<DataLakePathClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<DataLakePathClientBuilder>, com.azure.core.client.traits.EndpointTrait<DataLakePathClientBuilder>, com.azure.core.client.traits.HttpTrait<DataLakePathClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<DataLakePathClientBuilder>
public final class DataLakePathClientBuilder extends Object implements com.azure.core.client.traits.TokenCredentialTrait<DataLakePathClientBuilder>, com.azure.core.client.traits.AzureNamedKeyCredentialTrait<DataLakePathClientBuilder>, com.azure.core.client.traits.AzureSasCredentialTrait<DataLakePathClientBuilder>, com.azure.core.client.traits.HttpTrait<DataLakePathClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<DataLakePathClientBuilder>, com.azure.core.client.traits.EndpointTrait<DataLakePathClientBuilder>
This class provides a fluent builder API to help aid the configuration and instantiation of FileClients, FileAsyncClients, DirectoryClients and DirectoryAsyncClients, 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 Details

  • Method Details

    • 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.
      Throws:
      NullPointerException - If endpoint or pathName is null.
      IllegalStateException - If multiple credentials have been specified.
      IllegalStateException - If both retryOptions(RetryOptions) and retryOptions(RequestRetryOptions) have been set.

    • 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.
      Throws:
      NullPointerException - If endpoint or pathName is null.
      IllegalStateException - If multiple credentials have been specified.
      IllegalStateException - If both retryOptions(RetryOptions) and retryOptions(RequestRetryOptions) have been set.

    • 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.
      Throws:
      NullPointerException - If endpoint or pathName is null.
      IllegalStateException - If both retryOptions(RetryOptions) and retryOptions(RequestRetryOptions) have been set.

    • 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.
      Throws:
      NullPointerException - If endpoint or pathName is null.
      IllegalStateException - If both retryOptions(RetryOptions) and retryOptions(RequestRetryOptions) have been set.

    • credential

      public DataLakePathClientBuilder credential(com.azure.storage.common.StorageSharedKeyCredential credential)
      Sets the StorageSharedKeyCredential used to authorize requests sent to the service.
      Parameters:
      credential - StorageSharedKeyCredential.
      Returns:
      the updated DataLakePathClientBuilder
      Throws:
      NullPointerException - If credential is null.

    • credential

      public DataLakePathClientBuilder credential(com.azure.core.credential.AzureNamedKeyCredential credential)
      Sets the AzureNamedKeyCredential used to authorize requests sent to the service.
      Specified by:
      credential in interface com.azure.core.client.traits.AzureNamedKeyCredentialTrait<DataLakePathClientBuilder>
      Parameters:
      credential - AzureNamedKeyCredential.
      Returns:
      the updated DataLakePathClientBuilder
      Throws:
      NullPointerException - If credential is null.

    • credential

      public DataLakePathClientBuilder credential(com.azure.core.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 com.azure.core.client.traits.TokenCredentialTrait<DataLakePathClientBuilder>
      Parameters:
      credential - TokenCredential used to authorize requests sent to the service.
      Returns:
      the updated DataLakePathClientBuilder
      Throws:
      NullPointerException - If credential is null.

    • 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
      Throws:
      NullPointerException - If sasToken is null.

    • credential

      public DataLakePathClientBuilder credential(com.azure.core.credential.AzureSasCredential credential)
      Sets the AzureSasCredential used to authorize requests sent to the service.
      Specified by:
      credential in interface com.azure.core.client.traits.AzureSasCredentialTrait<DataLakePathClientBuilder>
      Parameters:
      credential - AzureSasCredential used to authorize requests sent to the service.
      Returns:
      the updated DataLakePathClientBuilder
      Throws:
      NullPointerException - If credential is null.

    • setAnonymousAccess

      public DataLakePathClientBuilder setAnonymousAccess()
      Clears the credential used to authorize the request.

      This is for paths that are publicly accessible.

      Returns:
      the updated DataLakePathClientBuilder

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

      Specified by:
      endpoint in interface com.azure.core.client.traits.EndpointTrait<DataLakePathClientBuilder>
      Parameters:
      endpoint - URL of the service
      Returns:
      the updated DataLakePathClientBuilder object
      Throws:
      IllegalArgumentException - If endpoint is null or is a malformed URL.

    • 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

    • 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
      Throws:
      NullPointerException - If pathName is null

    • httpClient

      public DataLakePathClientBuilder httpClient(com.azure.core.http.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 com.azure.core.client.traits.HttpTrait<DataLakePathClientBuilder>
      Parameters:
      httpClient - The HttpClient to use for requests.
      Returns:
      the updated DataLakePathClientBuilder object

    • addPolicy

      public DataLakePathClientBuilder addPolicy(com.azure.core.http.policy.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 com.azure.core.client.traits.HttpTrait<DataLakePathClientBuilder>
      Parameters:
      pipelinePolicy - A pipeline policy.
      Returns:
      the updated DataLakePathClientBuilder object
      Throws:
      NullPointerException - If pipelinePolicy is null.

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

    • httpLogOptions

      public DataLakePathClientBuilder httpLogOptions(com.azure.core.http.policy.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 com.azure.core.client.traits.HttpTrait<DataLakePathClientBuilder>
      Parameters:
      logOptions - The logging configuration to use when sending and receiving requests to and from the service.
      Returns:
      the updated DataLakePathClientBuilder object
      Throws:
      NullPointerException - If logOptions is null.

    • configuration

      public DataLakePathClientBuilder configuration(com.azure.core.util.Configuration configuration)
      Sets the configuration object used to retrieve environment configuration values during building of the client.
      Specified by:
      configuration in interface com.azure.core.client.traits.ConfigurationTrait<DataLakePathClientBuilder>
      Parameters:
      configuration - Configuration store used to retrieve environment configurations.
      Returns:
      the updated DataLakePathClientBuilder object

    • retryOptions

      public DataLakePathClientBuilder retryOptions(com.azure.storage.common.policy.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 DataLakePathClientBuilder object.

    • retryOptions

      public DataLakePathClientBuilder retryOptions(com.azure.core.http.policy.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 com.azure.core.client.traits.HttpTrait<DataLakePathClientBuilder>
      Parameters:
      retryOptions - The RetryOptions to use for all the requests made through the client.
      Returns:
      the updated DataLakePathClientBuilder object

    • clientOptions

      public DataLakePathClientBuilder clientOptions(com.azure.core.util.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 com.azure.core.client.traits.HttpTrait<DataLakePathClientBuilder>
      Parameters:
      clientOptions - A configured instance of HttpClientOptions.
      Returns:
      the updated DataLakePathClientBuilder object
      Throws:
      NullPointerException - If clientOptions is null.
      See Also:
      • HttpClientOptions

    • pipeline

      public DataLakePathClientBuilder pipeline(com.azure.core.http.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 com.azure.core.client.traits.HttpTrait<DataLakePathClientBuilder>
      Parameters:
      httpPipeline - HttpPipeline to use for sending service requests and receiving responses.
      Returns:
      the updated DataLakePathClientBuilder object

    • 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

    • customerProvidedKey

      public DataLakePathClientBuilder customerProvidedKey(CustomerProvidedKey customerProvidedKey)
      Sets the customer provided key 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

    • 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