public class DataLakeServiceClient extends Object
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 a data lake service account. Operations on a file system are available on
DataLakeFileSystemClient
through DataLakeServiceClient.getFileSystemClient(String)
, and operations on a file or directory
are available on DataLakeFileClient
and DataLakeDirectoryClient
respectively.
Modifier and Type | Method and Description |
---|---|
DataLakeFileSystemClient |
createFileSystem(String fileSystemName)
Creates a new file system within a storage account.
|
com.azure.core.http.rest.Response<DataLakeFileSystemClient> |
createFileSystemWithResponse(String fileSystemName,
Map<String,String> metadata,
PublicAccessType accessType,
com.azure.core.util.Context context)
Creates a new file system within a storage account.
|
void |
deleteFileSystem(String fileSystemName)
Deletes the specified file system in the storage account.
|
com.azure.core.http.rest.Response<Void> |
deleteFileSystemWithResponse(String fileSystemName,
DataLakeRequestConditions requestConditions,
com.azure.core.util.Context context)
Deletes the specified file system in the storage account.
|
String |
generateAccountSas(com.azure.storage.common.sas.AccountSasSignatureValues accountSasSignatureValues)
Generates an account SAS for the Azure Storage account using the specified
AccountSasSignatureValues . |
String |
getAccountName()
Get associated account name.
|
String |
getAccountUrl()
Gets the URL of the storage account represented by this client.
|
DataLakeFileSystemClient |
getFileSystemClient(String fileSystemName)
Initializes a
DataLakeFileSystemClient object pointing to the specified file system. |
com.azure.core.http.HttpPipeline |
getHttpPipeline()
Gets the
HttpPipeline powering this client. |
DataLakeServiceVersion |
getServiceVersion()
Gets the service version the client is using.
|
UserDelegationKey |
getUserDelegationKey(OffsetDateTime start,
OffsetDateTime expiry)
Gets a user delegation key for use with this account's data lake storage.
|
com.azure.core.http.rest.Response<UserDelegationKey> |
getUserDelegationKeyWithResponse(OffsetDateTime start,
OffsetDateTime expiry,
Duration timeout,
com.azure.core.util.Context context)
Gets a user delegation key for use with this account's data lake storage.
|
com.azure.core.http.rest.PagedIterable<FileSystemItem> |
listFileSystems()
Returns a lazy loaded list of file systems in this account.
|
com.azure.core.http.rest.PagedIterable<FileSystemItem> |
listFileSystems(ListFileSystemsOptions options,
Duration timeout)
Returns a lazy loaded list of file systems in this account.
|
public DataLakeFileSystemClient getFileSystemClient(String fileSystemName)
DataLakeFileSystemClient
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
DataLakeFileSystemClient dataLakeFileSystemClient = client.getFileSystemClient("fileSystemName");
fileSystemName
- The name of the file system to point to.DataLakeFileSystemClient
object pointing to the specified file systempublic com.azure.core.http.HttpPipeline getHttpPipeline()
HttpPipeline
powering this client.public DataLakeServiceVersion getServiceVersion()
public DataLakeFileSystemClient createFileSystem(String fileSystemName)
Code Samples
DataLakeFileSystemClient dataLakeFileSystemClient = client.createFileSystem("fileSystemName");
fileSystemName
- Name of the file system to createDataLakeFileSystemClient
used to interact with the file system created.public com.azure.core.http.rest.Response<DataLakeFileSystemClient> createFileSystemWithResponse(String fileSystemName, Map<String,String> metadata, PublicAccessType accessType, com.azure.core.util.Context context)
Code Samples
Map<String, String> metadata = Collections.singletonMap("metadata", "value"); Context context = new Context("Key", "Value"); DataLakeFileSystemClient dataLakeFileSystemClient = client.createFileSystemWithResponse( "fileSystemName", metadata, PublicAccessType.CONTAINER, context).getValue();
fileSystemName
- Name of the file system to createmetadata
- Metadata to associate with the file system.accessType
- Specifies how the data in this file system is available to the public. See the
x-ms-blob-public-access header in the Azure Docs for more information. Pass null for no public access.context
- Additional context that is passed through the Http pipeline during the service call.Response
whose value
contains the DataLakeFileSystemClient
used to interact with the file system created.public void deleteFileSystem(String fileSystemName)
Code Samples
try { client.deleteFileSystem("fileSystemName"); System.out.printf("Delete file system completed with status %n"); } catch (UnsupportedOperationException error) { System.out.printf("Delete file system failed: %s%n", error); }
fileSystemName
- Name of the file system to deletepublic com.azure.core.http.rest.Response<Void> deleteFileSystemWithResponse(String fileSystemName, DataLakeRequestConditions requestConditions, com.azure.core.util.Context context)
Code Samples
Context context = new Context("Key", "Value"); System.out.printf("Delete file system completed with status %d%n", client.deleteFileSystemWithResponse("fileSystemName", new DataLakeRequestConditions(), context) .getStatusCode());
fileSystemName
- Name of the file system to deleterequestConditions
- DataLakeRequestConditions
context
- Additional context that is passed through the Http pipeline during the service call.public String getAccountUrl()
public com.azure.core.http.rest.PagedIterable<FileSystemItem> listFileSystems()
PagedIterable
can be consumed
while new items are automatically retrieved as needed. For more information, see the Azure Docs.
Code Samples
client.listFileSystems().forEach(fileSystem -> System.out.printf("Name: %s%n", fileSystem.getName()));
public com.azure.core.http.rest.PagedIterable<FileSystemItem> listFileSystems(ListFileSystemsOptions options, Duration timeout)
PagedIterable
can be consumed
while new items are automatically retrieved as needed. For more information, see the Azure Docs.
Code Samples
ListFileSystemsOptions options = new ListFileSystemsOptions() .setPrefix("filSystemNamePrefixToMatch") .setDetails(new FileSystemListDetails().setRetrieveMetadata(true)); client.listFileSystems(options, timeout).forEach(fileSystem -> System.out.printf("Name: %s%n", fileSystem.getName()));
options
- A ListFileSystemsOptions
which specifies what data should be returned by the service.timeout
- An optional timeout value beyond which a RuntimeException
will be raised.public UserDelegationKey getUserDelegationKey(OffsetDateTime start, OffsetDateTime expiry)
TokenCredential
in this object's HttpPipeline
.
Code Samples
System.out.printf("User delegation key: %s%n", client.getUserDelegationKey(delegationKeyStartTime, delegationKeyExpiryTime));
start
- Start time for the key's validity. Null indicates immediate start.expiry
- Expiration of the key's validity.public com.azure.core.http.rest.Response<UserDelegationKey> getUserDelegationKeyWithResponse(OffsetDateTime start, OffsetDateTime expiry, Duration timeout, com.azure.core.util.Context context)
TokenCredential
in this object's HttpPipeline
.
Code Samples
System.out.printf("User delegation key: %s%n", client.getUserDelegationKeyWithResponse(delegationKeyStartTime, delegationKeyExpiryTime, timeout, context));
start
- Start time for the key's validity. Null indicates immediate start.expiry
- Expiration of the key's validity.timeout
- An optional timeout value beyond which a RuntimeException
will be raised.context
- Additional context that is passed through the Http pipeline during the service call.Response
whose value
contains the user delegation key.public String getAccountName()
public String generateAccountSas(com.azure.storage.common.sas.AccountSasSignatureValues accountSasSignatureValues)
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);
accountSasSignatureValues
- AccountSasSignatureValues
String
representing all SAS query parameters.Copyright © 2020 Microsoft Corporation. All rights reserved.