Class DataLakeFileSystemClientBuilder
- java.lang.Object
-
- com.azure.storage.file.datalake.DataLakeFileSystemClientBuilder
-
- All Implemented Interfaces:
com.azure.core.client.traits.AzureNamedKeyCredentialTrait<DataLakeFileSystemClientBuilder>
,com.azure.core.client.traits.AzureSasCredentialTrait<DataLakeFileSystemClientBuilder>
,com.azure.core.client.traits.ConfigurationTrait<DataLakeFileSystemClientBuilder>
,com.azure.core.client.traits.EndpointTrait<DataLakeFileSystemClientBuilder>
,com.azure.core.client.traits.HttpTrait<DataLakeFileSystemClientBuilder>
,com.azure.core.client.traits.TokenCredentialTrait<DataLakeFileSystemClientBuilder>
public class DataLakeFileSystemClientBuilder extends Object implements com.azure.core.client.traits.TokenCredentialTrait<DataLakeFileSystemClientBuilder>, com.azure.core.client.traits.AzureNamedKeyCredentialTrait<DataLakeFileSystemClientBuilder>, com.azure.core.client.traits.AzureSasCredentialTrait<DataLakeFileSystemClientBuilder>, com.azure.core.client.traits.HttpTrait<DataLakeFileSystemClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<DataLakeFileSystemClientBuilder>, com.azure.core.client.traits.EndpointTrait<DataLakeFileSystemClientBuilder>
This class provides a fluent builder API to help aid the configuration and instantiation ofFileSystemClients
andFileSystemAsyncClients
, callbuildClient
andbuildAsyncClient
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 ofhttps://{accountName}.dfs.core.windows.net/{fileSystemName}
. - the credential through
.credential()
or.connectionString()
if the file system is not publicly accessible.
-
-
Constructor Summary
Constructors Constructor Description DataLakeFileSystemClientBuilder()
Creates a builder instance that is able to configure and constructFileSystemClients
andFileSystemAsyncClients
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description DataLakeFileSystemClientBuilder
addPolicy(com.azure.core.http.policy.HttpPipelinePolicy pipelinePolicy)
Adds apipeline policy
to apply on each request sent.DataLakeFileSystemAsyncClient
buildAsyncClient()
Code SamplesDataLakeFileSystemClient
buildClient()
Code SamplesDataLakeFileSystemClientBuilder
clientOptions(com.azure.core.util.ClientOptions clientOptions)
Allows for setting common properties such as application ID, headers, proxy configuration, etc.DataLakeFileSystemClientBuilder
configuration(com.azure.core.util.Configuration configuration)
Sets the configuration object used to retrieve environment configuration values during building of the client.DataLakeFileSystemClientBuilder
credential(com.azure.core.credential.AzureNamedKeyCredential credential)
Sets theAzureNamedKeyCredential
used to authorize requests sent to the service.DataLakeFileSystemClientBuilder
credential(com.azure.core.credential.AzureSasCredential credential)
Sets theAzureSasCredential
used to authorize requests sent to the service.DataLakeFileSystemClientBuilder
credential(com.azure.core.credential.TokenCredential credential)
Sets theTokenCredential
used to authorize requests sent to the service.DataLakeFileSystemClientBuilder
credential(com.azure.storage.common.StorageSharedKeyCredential credential)
Sets theStorageSharedKeyCredential
used to authorize requests sent to the service.DataLakeFileSystemClientBuilder
customerProvidedKey(CustomerProvidedKey customerProvidedKey)
Sets thecustomer provided key
that is used to encrypt file contents on the server.DataLakeFileSystemClientBuilder
endpoint(String endpoint)
Sets the service endpoint, additionally parses it for information (SAS token, file system name)DataLakeFileSystemClientBuilder
fileSystemName(String fileSystemName)
Sets the name of the file system.static com.azure.core.http.policy.HttpLogOptions
getDefaultHttpLogOptions()
Gets the default Storage allowlist log headers and query parameters.DataLakeFileSystemClientBuilder
httpClient(com.azure.core.http.HttpClient httpClient)
Sets theHttpClient
to use for sending and receiving requests to and from the service.DataLakeFileSystemClientBuilder
httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
Sets thelogging configuration
to use when sending and receiving requests to and from the service.DataLakeFileSystemClientBuilder
pipeline(com.azure.core.http.HttpPipeline httpPipeline)
Sets theHttpPipeline
to use for the service client.DataLakeFileSystemClientBuilder
retryOptions(com.azure.core.http.policy.RetryOptions retryOptions)
Sets theRetryOptions
for all the requests made through the client.DataLakeFileSystemClientBuilder
retryOptions(com.azure.storage.common.policy.RequestRetryOptions retryOptions)
Sets the request retry options for all the requests made through the client.DataLakeFileSystemClientBuilder
sasToken(String sasToken)
Sets the SAS token used to authorize requests sent to the service.DataLakeFileSystemClientBuilder
serviceVersion(DataLakeServiceVersion version)
Sets theDataLakeServiceVersion
that is used when making API requests.DataLakeFileSystemClientBuilder
setAnonymousAccess()
Clears the credential used to authorize the request.
-
-
-
Constructor Detail
-
DataLakeFileSystemClientBuilder
public DataLakeFileSystemClientBuilder()
Creates a builder instance that is able to configure and constructFileSystemClients
andFileSystemAsyncClients
.
-
-
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.IllegalStateException
- If bothretryOptions(RetryOptions)
andretryOptions(RequestRetryOptions)
have been set.
-
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.IllegalStateException
- If bothretryOptions(RetryOptions)
andretryOptions(RequestRetryOptions)
have been set.
-
endpoint
public DataLakeFileSystemClientBuilder endpoint(String endpoint)
Sets the service endpoint, additionally parses it for information (SAS token, file system name)- Specified by:
endpoint
in interfacecom.azure.core.client.traits.EndpointTrait<DataLakeFileSystemClientBuilder>
- Parameters:
endpoint
- URL of the service- Returns:
- the updated DataLakeFileSystemClientBuilder object
- Throws:
IllegalArgumentException
- Ifendpoint
isnull
or is a malformed URL.
-
credential
public DataLakeFileSystemClientBuilder credential(com.azure.storage.common.StorageSharedKeyCredential credential)
Sets theStorageSharedKeyCredential
used to authorize requests sent to the service.- Parameters:
credential
-StorageSharedKeyCredential
.- Returns:
- the updated DataLakeFileSystemClientBuilder
- Throws:
NullPointerException
- Ifcredential
isnull
.
-
credential
public DataLakeFileSystemClientBuilder 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<DataLakeFileSystemClientBuilder>
- Parameters:
credential
-AzureNamedKeyCredential
.- Returns:
- the updated DataLakeFileSystemClientBuilder
- Throws:
NullPointerException
- Ifcredential
isnull
.
-
credential
public DataLakeFileSystemClientBuilder 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<DataLakeFileSystemClientBuilder>
- Parameters:
credential
-TokenCredential
used to authorize requests sent to the service.- Returns:
- the updated DataLakeFileSystemClientBuilder
- Throws:
NullPointerException
- Ifcredential
isnull
.
-
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
- IfsasToken
isnull
.
-
credential
public DataLakeFileSystemClientBuilder 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<DataLakeFileSystemClientBuilder>
- Parameters:
credential
-AzureSasCredential
used to authorize requests sent to the service.- Returns:
- the updated DataLakeFileSystemClientBuilder
- Throws:
NullPointerException
- Ifcredential
isnull
.
-
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 valuenull
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 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<DataLakeFileSystemClientBuilder>
- Parameters:
httpClient
- TheHttpClient
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 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<DataLakeFileSystemClientBuilder>
- Parameters:
pipelinePolicy
- Apipeline policy
.- Returns:
- the updated DataLakeFileSystemClientBuilder object
- Throws:
NullPointerException
- IfpipelinePolicy
isnull
.
-
httpLogOptions
public DataLakeFileSystemClientBuilder 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<DataLakeFileSystemClientBuilder>
- Parameters:
logOptions
- Thelogging configuration
to use when sending and receiving requests to and from the service.- Returns:
- the updated DataLakeFileSystemClientBuilder object
- Throws:
NullPointerException
- IflogOptions
isnull
.
-
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.- Specified by:
configuration
in interfacecom.azure.core.client.traits.ConfigurationTrait<DataLakeFileSystemClientBuilder>
- 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. Setting this is mutually exclusive with usingretryOptions(RetryOptions)
.- Parameters:
retryOptions
-RequestRetryOptions
.- Returns:
- the updated DataLakeFileSystemClientBuilder object.
-
retryOptions
public DataLakeFileSystemClientBuilder 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<DataLakeFileSystemClientBuilder>
- Parameters:
retryOptions
- TheRetryOptions
to use for all the requests made through the client.- Returns:
- the updated DataLakeFileSystemClientBuilder object
-
pipeline
public DataLakeFileSystemClientBuilder 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<DataLakeFileSystemClientBuilder>
- 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)
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<DataLakeFileSystemClientBuilder>
- Parameters:
clientOptions
- A configured instance ofHttpClientOptions
.- Returns:
- the updated DataLakeFileSystemClientBuilder object
- Throws:
NullPointerException
- IfclientOptions
isnull
.- See Also:
HttpClientOptions
-
serviceVersion
public DataLakeFileSystemClientBuilder 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 DataLakeFileSystemClientBuilder object
-
customerProvidedKey
public DataLakeFileSystemClientBuilder 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 DataLakeFileSystemClientBuilder object
-
-