DataLakeServiceAsyncClient Class
- java.
lang. Object - com.
azure. storage. file. datalake. DataLakeServiceAsyncClient
- com.
public class DataLakeServiceAsyncClient
Client to a storage account. It may only be instantiated through a DataLakeServiceClientBuilder. This class does not hold any state about a particular storage account but is instead a convenient way of sending off appropriate requests to the resource on the service. It may also be used to construct URLs to file systems, files and directories.
This client contains operations on the main data lake service account. Operations on a file system are available on DataLakeFileSystemAsyncClient through getFileSystemAsyncClient(String fileSystemName), and operations on a file or directory are available on DataLakeFileAsyncClient or DataLakeDirectoryAsyncClient.
Note this client is an async client that returns reactive responses from Spring Reactor Core project (https://projectreactor.io/). Calling the methods in this client will NOT start the actual network operation, until .subscribe() is called on the reactive response. You can simply convert one of these responses to a CompletableFuture object through Mono#toFuture().
Method Summary
Methods inherited from java.lang.Object
Method Details
createFileSystem
public Mono
Creates a new file system within a storage account. If a file system with the same name already exists, the operation fails. For more information, see the Azure Docs.
Code Samples
DataLakeFileSystemAsyncClient dataLakeFileSystemAsyncClient =
client.createFileSystem("fileSystemName").block();
Parameters:
Returns:
createFileSystemWithResponse
public Mono<>
Creates a new file system within a storage account. If a file system with the same name already exists, the operation fails. For more information, see the Azure Docs.
Code Samples
Map<String, String> metadata = Collections.singletonMap("metadata", "value");
DataLakeFileSystemAsyncClient dataLakeFileSystemAsyncClient = client
.createFileSystemWithResponse("fileSystemName", metadata, PublicAccessType.CONTAINER).block().getValue();
Parameters:
Returns:
deleteFileSystem
public Mono
Deletes the specified file system in the storage account. If the file system doesn't exist the operation fails. For more information see the Azure Docs.
Code Samples
client.deleteFileSystem("fileSystemName").subscribe(
response -> System.out.printf("Delete file system completed%n"),
error -> System.out.printf("Delete file system failed: %s%n", error));
Parameters:
Returns:
deleteFileSystemWithResponse
public Mono<>
Deletes the specified file system in the storage account. If the file system doesn't exist the operation fails. For more information see the Azure Docs.
Code Samples
client.deleteFileSystemWithResponse("fileSystemName", new DataLakeRequestConditions()).subscribe(response ->
System.out.printf("Delete file system completed with status %d%n", response.getStatusCode()));
Parameters:
Returns:
generateAccountSas
public String generateAccountSas(AccountSasSignatureValues accountSasSignatureValues)
Generates an account SAS for the Azure Storage account using the specified AccountSasSignatureValues.
Note : The client must be authenticated via StorageSharedKeyCredential
See AccountSasSignatureValues for more information on how to construct an account SAS.
The snippet below generates a SAS that lasts for two days and gives the user read and list access to file systems and file shares.
AccountSasPermission permissions = new AccountSasPermission()
.setListPermission(true)
.setReadPermission(true);
AccountSasResourceType resourceTypes = new AccountSasResourceType().setContainer(true);
AccountSasService services = new AccountSasService().setBlobAccess(true).setFileAccess(true);
OffsetDateTime expiryTime = OffsetDateTime.now().plus(Duration.ofDays(2));
AccountSasSignatureValues sasValues =
new AccountSasSignatureValues(expiryTime, permissions, services, resourceTypes);
// Client must be authenticated via StorageSharedKeyCredential
String sas = client.generateAccountSas(sasValues);
Parameters:
Returns:
String representing the SAS query parameters.generateAccountSas
public String generateAccountSas(AccountSasSignatureValues accountSasSignatureValues, Context context)
Generates an account SAS for the Azure Storage account using the specified AccountSasSignatureValues.
Note : The client must be authenticated via StorageSharedKeyCredential
See AccountSasSignatureValues for more information on how to construct an account SAS.
The snippet below generates a SAS that lasts for two days and gives the user read and list access to file systems and file shares.
AccountSasPermission permissions = new AccountSasPermission()
.setListPermission(true)
.setReadPermission(true);
AccountSasResourceType resourceTypes = new AccountSasResourceType().setContainer(true);
AccountSasService services = new AccountSasService().setBlobAccess(true).setFileAccess(true);
OffsetDateTime expiryTime = OffsetDateTime.now().plus(Duration.ofDays(2));
AccountSasSignatureValues sasValues =
new AccountSasSignatureValues(expiryTime, permissions, services, resourceTypes);
// Client must be authenticated via StorageSharedKeyCredential
String sas = client.generateAccountSas(sasValues, new Context("key", "value"));
Parameters:
Returns:
String representing the SAS query parameters.getAccountName
public String getAccountName()
Get associated account name.
Returns:
getAccountUrl
public String getAccountUrl()
Gets the URL of the storage account represented by this client.
Returns:
getFileSystemAsyncClient
public DataLakeFileSystemAsyncClient getFileSystemAsyncClient(String fileSystemName)
Initializes a DataLakeFileSystemAsyncClient object pointing to the specified file system. This method does not create a file system. It simply constructs the URL to the file system and offers access to methods relevant to file systems.
Code Samples
DataLakeFileSystemAsyncClient dataLakeFileSystemAsyncClient = client.getFileSystemAsyncClient("fileSystemName");
Parameters:
Returns:
getHttpPipeline
public HttpPipeline getHttpPipeline()
Gets the HttpPipeline powering this client.
Returns:
getProperties
public Mono
Gets the properties of a storage account\u2019s DataLake service. For more information, see the Azure Docs.
Code Samples
client.getProperties().subscribe(response ->
System.out.printf("Hour metrics enabled: %b, Minute metrics enabled: %b%n",
response.getHourMetrics().isEnabled(),
response.getMinuteMetrics().isEnabled()));
Returns:
getPropertiesWithResponse
public Mono<>
Gets the properties of a storage account\u2019s DataLake service. For more information, see the Azure Docs.
Code Samples
client.getPropertiesWithResponse().subscribe(response ->
System.out.printf("Hour metrics enabled: %b, Minute metrics enabled: %b%n",
response.getValue().getHourMetrics().isEnabled(),
response.getValue().getMinuteMetrics().isEnabled()));
Returns:
getServiceVersion
public DataLakeServiceVersion getServiceVersion()
Gets the service version the client is using.
Returns:
getUserDelegationKey
public Mono
Gets a user delegation key for use with this account's data lake storage. Note: This method call is only valid when using TokenCredential in this object's HttpPipeline.
Code Samples
client.getUserDelegationKey(delegationKeyStartTime, delegationKeyExpiryTime).subscribe(response ->
System.out.printf("User delegation key: %s%n", response.getValue()));
Parameters:
Returns:
getUserDelegationKeyWithResponse
public Mono<>
Gets a user delegation key for use with this account's data lake storage. Note: This method call is only valid when using TokenCredential in this object's HttpPipeline.
Code Samples
client.getUserDelegationKeyWithResponse(delegationKeyStartTime, delegationKeyExpiryTime).subscribe(response ->
System.out.printf("User delegation key: %s%n", response.getValue().getValue()));
Parameters:
Returns:
listFileSystems
public PagedFlux
Returns a reactive Publisher emitting all the file systems in this account lazily as needed. For more information, see the Azure Docs.
Code Samples
client.listFileSystems().subscribe(fileSystem -> System.out.printf("Name: %s%n", fileSystem.getName()));
Returns:
listFileSystems
public PagedFlux
Returns a reactive Publisher emitting all the file systems in this account lazily as needed. For more information, see the Azure Docs.
Code Samples
ListFileSystemsOptions options = new ListFileSystemsOptions()
.setPrefix("fileSystemNamePrefixToMatch")
.setDetails(new FileSystemListDetails().setRetrieveMetadata(true));
client.listFileSystems(options).subscribe(fileSystem -> System.out.printf("Name: %s%n", fileSystem.getName()));
Parameters:
Returns:
setProperties
public Mono
Sets properties for a storage account's DataLake service endpoint. For more information, see the Azure Docs. Note that setting the default service version has no effect when using this client because this client explicitly sets the version header on each request, overriding the default.
This method checks to ensure the properties being sent follow the specifications indicated in the Azure Docs. If CORS policies are set, CORS parameters that are not set default to the empty string.
Code Samples
DataLakeRetentionPolicy loggingRetentionPolicy = new DataLakeRetentionPolicy().setEnabled(true).setDays(3);
DataLakeRetentionPolicy metricsRetentionPolicy = new DataLakeRetentionPolicy().setEnabled(true).setDays(1);
DataLakeServiceProperties properties = new DataLakeServiceProperties()
.setLogging(new DataLakeAnalyticsLogging()
.setWrite(true)
.setDelete(true)
.setVersion("1.0")
.setRetentionPolicy(loggingRetentionPolicy))
.setHourMetrics(new DataLakeMetrics()
.setEnabled(true)
.setVersion("1.0")
.setIncludeApis(true)
.setRetentionPolicy(metricsRetentionPolicy))
.setMinuteMetrics(new DataLakeMetrics()
.setEnabled(true)
.setVersion("1.0")
.setIncludeApis(true)
.setRetentionPolicy(metricsRetentionPolicy));
client.setProperties(properties).subscribe(
response -> System.out.printf("Setting properties completed%n"),
error -> System.out.printf("Setting properties failed: %s%n", error));
Parameters:
Returns:
setPropertiesWithResponse
public Mono<>
Sets properties for a storage account's DataLake service endpoint. For more information, see the Azure Docs. Note that setting the default service version has no effect when using this client because this client explicitly sets the version header on each request, overriding the default.
This method checks to ensure the properties being sent follow the specifications indicated in the Azure Docs. If CORS policies are set, CORS parameters that are not set default to the empty string.
Code Samples
loggingRetentionPolicy = new DataLakeRetentionPolicy().setEnabled(true).setDays(3);
metricsRetentionPolicy = new DataLakeRetentionPolicy().setEnabled(true).setDays(1);
properties = new DataLakeServiceProperties()
.setLogging(new DataLakeAnalyticsLogging()
.setWrite(true)
.setDelete(true)
.setVersion("1.0")
.setRetentionPolicy(loggingRetentionPolicy))
.setHourMetrics(new DataLakeMetrics()
.setEnabled(true)
.setVersion("1.0")
.setIncludeApis(true)
.setRetentionPolicy(metricsRetentionPolicy))
.setMinuteMetrics(new DataLakeMetrics()
.setEnabled(true)
.setVersion("1.0")
.setIncludeApis(true)
.setRetentionPolicy(metricsRetentionPolicy));
client.setPropertiesWithResponse(properties).subscribe(response ->
System.out.printf("Setting properties completed with status %d%n", response.getStatusCode()));
Parameters:
Returns:
undeleteFileSystem
public Mono
Restores a previously deleted file system. If the file system associated with provided deletedFileSystemName already exists, this call will result in a 409 (conflict). This API is only functional if Container Soft Delete is enabled for the storage account associated with the file system.
Code Samples
ListFileSystemsOptions listFileSystemsOptions = new ListFileSystemsOptions();
listFileSystemsOptions.getDetails().setRetrieveDeleted(true);
client.listFileSystems(listFileSystemsOptions).flatMap(
deletedFileSystem -> {
Mono<DataLakeFileSystemAsyncClient> fileSystemClient = client.undeleteFileSystem(
deletedFileSystem.getName(), deletedFileSystem.getVersion());
return fileSystemClient;
}
).then().block();
Parameters:
Returns:
undeleteFileSystemWithResponse
public Mono<>
Restores a previously deleted file system. The restored file system will be renamed to the destinationFileSystemName if provided in options. Otherwise deletedFileSystemName is used as the destination file system name. If the file system associated with provided destinationFileSystemName already exists, this call will result in a 409 (conflict). This API is only functional if Container Soft Delete is enabled for the storage account associated with the file system.
Code Samples
ListFileSystemsOptions listFileSystemsOptions = new ListFileSystemsOptions();
listFileSystemsOptions.getDetails().setRetrieveDeleted(true);
client.listFileSystems(listFileSystemsOptions).flatMap(
deletedFileSystem -> {
Mono<DataLakeFileSystemAsyncClient> fileSystemClient = client.undeleteFileSystemWithResponse(
new FileSystemUndeleteOptions(deletedFileSystem.getName(), deletedFileSystem.getVersion()))
.map(Response::getValue);
return fileSystemClient;
}
).then().block();
Parameters:
Returns:
Applies to
Azure SDK for Java
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for