Package com.azure.storage.file.datalake

Class DataLakeServiceClientBuilder

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

  • Method Details

    • buildClient

      public DataLakeServiceClient buildClient()
      Creates a DataLakeServiceClient based on options set in the builder. Every time buildClient() is called, a new instance of DataLakeServiceClient is created.
      Returns:
      a DataLakeServiceClient 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 DataLakeServiceAsyncClient buildAsyncClient()
      Creates a DataLakeServiceAsyncClient based on options set in the builder. Every time buildAsyncClient() is called, a new instance of DataLakeServiceAsyncClient is created.
      Returns:
      a DataLakeServiceAsyncClient 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 DataLakeServiceClientBuilder endpoint(String endpoint)
      Sets the data lake service endpoint, additionally parses it for information (SAS token)
      Specified by:
      endpoint in interface com.azure.core.client.traits.EndpointTrait<DataLakeServiceClientBuilder>
      Parameters:
      endpoint - URL of the service
      Returns:
      the updated DataLakeServiceClientBuilder object
      Throws:
      IllegalArgumentException - If endpoint is null or is a malformed URL.

    • credential

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

    • credential

      public DataLakeServiceClientBuilder 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<DataLakeServiceClientBuilder>
      Parameters:
      credential - AzureNamedKeyCredential.
      Returns:
      the updated DataLakeServiceClientBuilder
      Throws:
      NullPointerException - If credential is null.

    • credential

      public DataLakeServiceClientBuilder 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<DataLakeServiceClientBuilder>
      Parameters:
      credential - TokenCredential used to authorize requests sent to the service.
      Returns:
      the updated DataLakeServiceClientBuilder
      Throws:
      NullPointerException - If credential is null.

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

    • credential

      public DataLakeServiceClientBuilder 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<DataLakeServiceClientBuilder>
      Parameters:
      credential - AzureSasCredential used to authorize requests sent to the service.
      Returns:
      the updated DataLakeServiceClientBuilder
      Throws:
      NullPointerException - If credential is null.

    • 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
      Throws:
      IllegalArgumentException - If connectionString in invalid.
      NullPointerException - If connectionString is null.

    • httpClient

      public DataLakeServiceClientBuilder 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<DataLakeServiceClientBuilder>
      Parameters:
      httpClient - The HttpClient to use for requests.
      Returns:
      the updated DataLakeServiceClientBuilder object

    • addPolicy

      public DataLakeServiceClientBuilder 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<DataLakeServiceClientBuilder>
      Parameters:
      pipelinePolicy - A pipeline policy.
      Returns:
      the updated DataLakeServiceClientBuilder object
      Throws:
      NullPointerException - If pipelinePolicy is null.

    • httpLogOptions

      public DataLakeServiceClientBuilder 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<DataLakeServiceClientBuilder>
      Parameters:
      logOptions - The logging configuration to use when sending and receiving requests to and from the service.
      Returns:
      the updated DataLakeServiceClientBuilder object
      Throws:
      NullPointerException - If logOptions 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.

    • configuration

      public DataLakeServiceClientBuilder 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<DataLakeServiceClientBuilder>
      Parameters:
      configuration - Configuration store used to retrieve environment configurations.
      Returns:
      the updated DataLakeServiceClientBuilder object

    • retryOptions

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

    • retryOptions

      public DataLakeServiceClientBuilder 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<DataLakeServiceClientBuilder>
      Parameters:
      retryOptions - The RetryOptions to use for all the requests made through the client.
      Returns:
      the updated DataLakeServiceClientBuilder object

    • pipeline

      public DataLakeServiceClientBuilder 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<DataLakeServiceClientBuilder>
      Parameters:
      httpPipeline - HttpPipeline to use for sending service requests and receiving responses.
      Returns:
      the updated DataLakeServiceClientBuilder object

    • clientOptions

      public DataLakeServiceClientBuilder 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<DataLakeServiceClientBuilder>
      Parameters:
      clientOptions - A configured instance of HttpClientOptions.
      Returns:
      the updated DataLakeServiceClientBuilder object
      Throws:
      NullPointerException - If clientOptions is null.
      See Also:
      • HttpClientOptions

    • 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

    • customerProvidedKey

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

    • fileSystemEncryptionScopeOptions

      public DataLakeServiceClientBuilder fileSystemEncryptionScopeOptions(FileSystemEncryptionScopeOptions fileSystemEncryptionScopeOptions)
      Sets the encryption scope 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

    • 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

    • 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