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 ofDataLakeServiceClients
andDataLakeServiceAsyncClients
, callbuildClient
andbuildAsyncClient
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 ofhttps://{accountName}.dfs.core.windows.net
. - the credential through
.credential()
or.connectionString()
.
-
-
Constructor Summary
Constructors Constructor Description DataLakeServiceClientBuilder()
Creates a builder instance that is able to configure and constructDataLakeServiceClients
andDataLakeServiceAsyncClients
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description DataLakeServiceClientBuilder
addPolicy(com.azure.core.http.policy.HttpPipelinePolicy pipelinePolicy)
Adds apipeline policy
to apply on each request sent.DataLakeServiceAsyncClient
buildAsyncClient()
DataLakeServiceClient
buildClient()
DataLakeServiceClientBuilder
clientOptions(com.azure.core.util.ClientOptions clientOptions)
Allows for setting common properties such as application ID, headers, proxy configuration, etc.DataLakeServiceClientBuilder
configuration(com.azure.core.util.Configuration configuration)
Sets the configuration object used to retrieve environment configuration values during building of the client.DataLakeServiceClientBuilder
credential(com.azure.core.credential.AzureNamedKeyCredential credential)
Sets theAzureNamedKeyCredential
used to authorize requests sent to the service.DataLakeServiceClientBuilder
credential(com.azure.core.credential.AzureSasCredential credential)
Sets theAzureSasCredential
used to authorize requests sent to the service.DataLakeServiceClientBuilder
credential(com.azure.core.credential.TokenCredential credential)
Sets theTokenCredential
used to authorize requests sent to the service.DataLakeServiceClientBuilder
credential(com.azure.storage.common.StorageSharedKeyCredential credential)
Sets theStorageSharedKeyCredential
used to authorize requests sent to the service.DataLakeServiceClientBuilder
customerProvidedKey(CustomerProvidedKey customerProvidedKey)
Sets thecustomer provided key
that is used to encrypt file contents on the server.DataLakeServiceClientBuilder
endpoint(String endpoint)
Sets the data lake service endpoint, additionally parses it for information (SAS token)static com.azure.core.http.policy.HttpLogOptions
getDefaultHttpLogOptions()
Gets the default Storage allowlist log headers and query parameters.DataLakeServiceClientBuilder
httpClient(com.azure.core.http.HttpClient httpClient)
Sets theHttpClient
to use for sending and receiving requests to and from the service.DataLakeServiceClientBuilder
httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
Sets thelogging configuration
to use when sending and receiving requests to and from the service.DataLakeServiceClientBuilder
pipeline(com.azure.core.http.HttpPipeline httpPipeline)
Sets theHttpPipeline
to use for the service client.DataLakeServiceClientBuilder
retryOptions(com.azure.core.http.policy.RetryOptions retryOptions)
Sets theRetryOptions
for all the requests made through the client.DataLakeServiceClientBuilder
retryOptions(com.azure.storage.common.policy.RequestRetryOptions retryOptions)
Sets the request retry options for all the requests made through the client.DataLakeServiceClientBuilder
sasToken(String sasToken)
Sets the SAS token used to authorize requests sent to the service.DataLakeServiceClientBuilder
serviceVersion(DataLakeServiceVersion version)
Sets theDataLakeServiceVersion
that is used when making API requests.
-
-
-
Constructor Detail
-
DataLakeServiceClientBuilder
public DataLakeServiceClientBuilder()
Creates a builder instance that is able to configure and constructDataLakeServiceClients
andDataLakeServiceAsyncClients
.
-
-
Method Detail
-
buildClient
public DataLakeServiceClient buildClient()
- Returns:
- a
DataLakeServiceClient
created from the configurations in this builder. - Throws:
IllegalStateException
- If multiple credentials have been specified.IllegalStateException
- If bothretryOptions(RetryOptions)
andretryOptions(RequestRetryOptions)
have been set.
-
buildAsyncClient
public DataLakeServiceAsyncClient buildAsyncClient()
- Returns:
- a
DataLakeServiceAsyncClient
created from the configurations in this builder. - Throws:
IllegalStateException
- If multiple credentials have been specified.IllegalStateException
- If bothretryOptions(RetryOptions)
andretryOptions(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 interfacecom.azure.core.client.traits.EndpointTrait<DataLakeServiceClientBuilder>
- Parameters:
endpoint
- URL of the service- Returns:
- the updated DataLakeServiceClientBuilder object
- Throws:
IllegalArgumentException
- Ifendpoint
isnull
or is a malformed URL.
-
credential
public DataLakeServiceClientBuilder credential(com.azure.storage.common.StorageSharedKeyCredential credential)
Sets theStorageSharedKeyCredential
used to authorize requests sent to the service.- Parameters:
credential
-StorageSharedKeyCredential
.- Returns:
- the updated DataLakeServiceClientBuilder
- Throws:
NullPointerException
- Ifcredential
isnull
.
-
credential
public DataLakeServiceClientBuilder credential(com.azure.core.credential.AzureNamedKeyCredential credential)
Sets theAzureNamedKeyCredential
used to authorize requests sent to the service.- Specified by:
credential
in interfacecom.azure.core.client.traits.AzureNamedKeyCredentialTrait<DataLakeServiceClientBuilder>
- Parameters:
credential
-AzureNamedKeyCredential
.- Returns:
- the updated DataLakeServiceClientBuilder
- Throws:
NullPointerException
- Ifcredential
isnull
.
-
credential
public DataLakeServiceClientBuilder credential(com.azure.core.credential.TokenCredential credential)
Sets theTokenCredential
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 theTokenCredential
type.- Specified by:
credential
in interfacecom.azure.core.client.traits.TokenCredentialTrait<DataLakeServiceClientBuilder>
- Parameters:
credential
-TokenCredential
used to authorize requests sent to the service.- Returns:
- the updated DataLakeServiceClientBuilder
- Throws:
NullPointerException
- Ifcredential
isnull
.
-
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
- IfsasToken
isnull
.
-
credential
public DataLakeServiceClientBuilder credential(com.azure.core.credential.AzureSasCredential credential)
Sets theAzureSasCredential
used to authorize requests sent to the service.- Specified by:
credential
in interfacecom.azure.core.client.traits.AzureSasCredentialTrait<DataLakeServiceClientBuilder>
- Parameters:
credential
-AzureSasCredential
used to authorize requests sent to the service.- Returns:
- the updated DataLakeServiceClientBuilder
- Throws:
NullPointerException
- Ifcredential
isnull
.
-
httpClient
public DataLakeServiceClientBuilder httpClient(com.azure.core.http.HttpClient httpClient)
Sets theHttpClient
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 noHttpPipeline
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 anHttpPipeline
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 interfacecom.azure.core.client.traits.HttpTrait<DataLakeServiceClientBuilder>
- Parameters:
httpClient
- TheHttpClient
to use for requests.- Returns:
- the updated DataLakeServiceClientBuilder object
-
addPolicy
public DataLakeServiceClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy pipelinePolicy)
Adds apipeline 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 noHttpPipeline
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 anHttpPipeline
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 interfacecom.azure.core.client.traits.HttpTrait<DataLakeServiceClientBuilder>
- Parameters:
pipelinePolicy
- Apipeline policy
.- Returns:
- the updated DataLakeServiceClientBuilder object
- Throws:
NullPointerException
- IfpipelinePolicy
isnull
.
-
httpLogOptions
public DataLakeServiceClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
Sets thelogging configuration
to use when sending and receiving requests to and from the service. If alogLevel
is not provided, default value ofHttpLogDetailLevel.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 noHttpPipeline
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 anHttpPipeline
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 interfacecom.azure.core.client.traits.HttpTrait<DataLakeServiceClientBuilder>
- Parameters:
logOptions
- Thelogging configuration
to use when sending and receiving requests to and from the service.- Returns:
- the updated DataLakeServiceClientBuilder object
- Throws:
NullPointerException
- IflogOptions
isnull
.
-
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 interfacecom.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 usingretryOptions(RetryOptions)
.- Parameters:
retryOptions
-RequestRetryOptions
.- Returns:
- the updated DataLakeServiceClientBuilder object
-
retryOptions
public DataLakeServiceClientBuilder retryOptions(com.azure.core.http.policy.RetryOptions retryOptions)
Sets theRetryOptions
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 noHttpPipeline
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 anHttpPipeline
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 usingretryOptions(RequestRetryOptions)
to also set storage specific options.- Specified by:
retryOptions
in interfacecom.azure.core.client.traits.HttpTrait<DataLakeServiceClientBuilder>
- Parameters:
retryOptions
- TheRetryOptions
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 theHttpPipeline
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 noHttpPipeline
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 anHttpPipeline
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 whenpipeline
is set.- Specified by:
pipeline
in interfacecom.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 theHttpClientOptions
class (a subclass of theClientOptions
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 noHttpPipeline
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 anHttpPipeline
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 interfacecom.azure.core.client.traits.HttpTrait<DataLakeServiceClientBuilder>
- Parameters:
clientOptions
- A configured instance ofHttpClientOptions
.- Returns:
- the updated DataLakeServiceClientBuilder object
- Throws:
NullPointerException
- IfclientOptions
isnull
.- See Also:
HttpClientOptions
-
serviceVersion
public DataLakeServiceClientBuilder serviceVersion(DataLakeServiceVersion version)
Sets theDataLakeServiceVersion
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 thecustomer 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
-
-