Package com.azure.storage.file.datalake
Class DataLakeServiceClientBuilder
- java.lang.Object
-
- com.azure.storage.file.datalake.DataLakeServiceClientBuilder
-
public class DataLakeServiceClientBuilder extends Object
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()
.
- the endpoint through
-
-
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 a pipeline policy to apply on each request sent.DataLakeServiceAsyncClient
buildAsyncClient()
DataLakeServiceClient
buildClient()
DataLakeServiceClientBuilder
clientOptions(com.azure.core.util.ClientOptions clientOptions)
Sets the client options for all the requests made through the client.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.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
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 a receiving requests to and from the service.DataLakeServiceClientBuilder
httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
Sets theHttpLogOptions
for service requests.DataLakeServiceClientBuilder
pipeline(com.azure.core.http.HttpPipeline httpPipeline)
Sets theHttpPipeline
to use for the service 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.
-
buildAsyncClient
public DataLakeServiceAsyncClient buildAsyncClient()
- Returns:
- a
DataLakeServiceAsyncClient
created from the configurations in this builder. - Throws:
IllegalStateException
- If multiple credentials have been specified.
-
endpoint
public DataLakeServiceClientBuilder endpoint(String endpoint)
Sets the data lake service endpoint, additionally parses it for information (SAS token)- 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.TokenCredential credential)
Sets theTokenCredential
used to authorize requests sent to the service.- Parameters:
credential
-TokenCredential
.- 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.- 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 a receiving requests to and from the service.- Parameters:
httpClient
- 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. 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 DataLakeServiceClientBuilder object
- Throws:
NullPointerException
- IfpipelinePolicy
isnull
.
-
httpLogOptions
public DataLakeServiceClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
Sets theHttpLogOptions
for service requests.- Parameters:
logOptions
- The logging configuration to use when sending and receiving HTTP requests/responses.- 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.- 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.- Parameters:
retryOptions
-RequestRetryOptions
.- Returns:
- the updated DataLakeServiceClientBuilder object
- Throws:
NullPointerException
- IfretryOptions
isnull
.
-
pipeline
public DataLakeServiceClientBuilder pipeline(com.azure.core.http.HttpPipeline httpPipeline)
Sets theHttpPipeline
to use for the service client. Ifpipeline
is set, all other settings are ignored, aside fromendpoint
.- 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)
Sets the client options for all the requests made through the client.- Parameters:
clientOptions
-ClientOptions
.- Returns:
- the updated DataLakeServiceClientBuilder object
- Throws:
NullPointerException
- IfclientOptions
isnull
.
-
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
-
-