public class DataLakePathClient extends Object
Modifier and Type | Method and Description |
---|---|
PathInfo |
create()
Creates a resource.
|
PathInfo |
create(boolean overwrite)
Creates a resource.
|
com.azure.core.http.rest.Response<PathInfo> |
createWithResponse(String permissions,
String umask,
PathHttpHeaders headers,
Map<String,String> metadata,
DataLakeRequestConditions requestConditions,
Duration timeout,
com.azure.core.util.Context context)
Creates a resource.
|
Boolean |
exists()
Gets if the path this client represents exists in the cloud.
|
com.azure.core.http.rest.Response<Boolean> |
existsWithResponse(Duration timeout,
com.azure.core.util.Context context)
Gets if the path this client represents exists in the cloud.
|
String |
generateSas(DataLakeServiceSasSignatureValues dataLakeServiceSasSignatureValues)
Generates a service SAS for the path using the specified
DataLakeServiceSasSignatureValues
Note : The client must be authenticated via StorageSharedKeyCredential |
String |
generateUserDelegationSas(DataLakeServiceSasSignatureValues dataLakeServiceSasSignatureValues,
UserDelegationKey userDelegationKey)
Generates a user delegation SAS for the path using the specified
DataLakeServiceSasSignatureValues . |
PathAccessControl |
getAccessControl()
Returns the access control for a resource.
|
com.azure.core.http.rest.Response<PathAccessControl> |
getAccessControlWithResponse(boolean userPrincipalNameReturned,
DataLakeRequestConditions requestConditions,
Duration timeout,
com.azure.core.util.Context context)
Returns the access control for a resource.
|
String |
getAccountName()
Gets the associated account name.
|
String |
getFileSystemName()
Gets the name of the File System in which this object lives.
|
com.azure.core.http.HttpPipeline |
getHttpPipeline()
Gets the
HttpPipeline powering this client. |
PathProperties |
getProperties()
Returns the resources's metadata and properties.
|
com.azure.core.http.rest.Response<PathProperties> |
getPropertiesWithResponse(DataLakeRequestConditions requestConditions,
Duration timeout,
com.azure.core.util.Context context)
Returns the resource's metadata and properties.
|
DataLakeServiceVersion |
getServiceVersion()
Gets the service version the client is using.
|
PathInfo |
setAccessControlList(List<PathAccessControlEntry> accessControlList,
String group,
String owner)
Changes the access control list, group and/or owner for a resource.
|
com.azure.core.http.rest.Response<PathInfo> |
setAccessControlListWithResponse(List<PathAccessControlEntry> accessControlList,
String group,
String owner,
DataLakeRequestConditions requestConditions,
Duration timeout,
com.azure.core.util.Context context)
Changes the access control list, group and/or owner for a resource.
|
void |
setHttpHeaders(PathHttpHeaders headers)
Changes a resources's HTTP header properties.
|
com.azure.core.http.rest.Response<Void> |
setHttpHeadersWithResponse(PathHttpHeaders headers,
DataLakeRequestConditions requestConditions,
Duration timeout,
com.azure.core.util.Context context)
Changes a resources's HTTP header properties.
|
void |
setMetadata(Map<String,String> metadata)
Changes a resource's metadata.
|
com.azure.core.http.rest.Response<Void> |
setMetadataWithResponse(Map<String,String> metadata,
DataLakeRequestConditions requestConditions,
Duration timeout,
com.azure.core.util.Context context)
Changes a resource's metadata.
|
PathInfo |
setPermissions(PathPermissions permissions,
String group,
String owner)
Changes the permissions, group and/or owner for a resource.
|
com.azure.core.http.rest.Response<PathInfo> |
setPermissionsWithResponse(PathPermissions permissions,
String group,
String owner,
DataLakeRequestConditions requestConditions,
Duration timeout,
com.azure.core.util.Context context)
Changes the permissions, group and/or owner for a resource.
|
public String getAccountName()
public String getFileSystemName()
public com.azure.core.http.HttpPipeline getHttpPipeline()
HttpPipeline
powering this client.public DataLakeServiceVersion getServiceVersion()
public PathInfo create()
Code Samples
System.out.printf("Last Modified Time:%s", client.create().getLastModified());
For more information see the Azure Docs
public PathInfo create(boolean overwrite)
Code Samples
boolean overwrite = true; System.out.printf("Last Modified Time:%s", client.create(true).getLastModified());
For more information see the Azure Docs
overwrite
- Whether or not to overwrite, should data exist on the path.public com.azure.core.http.rest.Response<PathInfo> createWithResponse(String permissions, String umask, PathHttpHeaders headers, Map<String,String> metadata, DataLakeRequestConditions requestConditions, Duration timeout, com.azure.core.util.Context context)
Code Samples
PathHttpHeaders httpHeaders = new PathHttpHeaders() .setContentLanguage("en-US") .setContentType("binary"); DataLakeRequestConditions requestConditions = new DataLakeRequestConditions() .setLeaseId(leaseId); String permissions = "permissions"; String umask = "umask"; Response<PathInfo> response = client.createWithResponse(permissions, umask, httpHeaders, Collections.singletonMap("metadata", "value"), requestConditions, timeout, new Context(key1, value1)); System.out.printf("Last Modified Time:%s", response.getValue().getLastModified());
For more information see the Azure Docs
permissions
- POSIX access permissions for the resource owner, the resource owning group, and others.umask
- Restricts permissions of the resource to be created.headers
- PathHttpHeaders
metadata
- Metadata to associate with the resource.requestConditions
- DataLakeRequestConditions
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.public void setMetadata(Map<String,String> metadata)
Code Samples
client.setMetadata(Collections.singletonMap("metadata", "value")); System.out.println("Set metadata completed");
For more information, see the Azure Docs
metadata
- Metadata to associate with the resource.public com.azure.core.http.rest.Response<Void> setMetadataWithResponse(Map<String,String> metadata, DataLakeRequestConditions requestConditions, Duration timeout, com.azure.core.util.Context context)
Code Samples
DataLakeRequestConditions requestConditions = new DataLakeRequestConditions().setLeaseId(leaseId); client.setMetadataWithResponse(Collections.singletonMap("metadata", "value"), requestConditions, timeout, new Context(key2, value2)); System.out.println("Set metadata completed");
For more information, see the Azure Docs
metadata
- Metadata to associate with the resource.requestConditions
- DataLakeRequestConditions
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.public void setHttpHeaders(PathHttpHeaders headers)
Code Samples
client.setHttpHeaders(new PathHttpHeaders() .setContentLanguage("en-US") .setContentType("binary"));
For more information, see the Azure Docs
headers
- PathHttpHeaders
public com.azure.core.http.rest.Response<Void> setHttpHeadersWithResponse(PathHttpHeaders headers, DataLakeRequestConditions requestConditions, Duration timeout, com.azure.core.util.Context context)
Code Samples
DataLakeRequestConditions requestConditions = new DataLakeRequestConditions().setLeaseId(leaseId); Response<Void> response = client.setHttpHeadersWithResponse(new PathHttpHeaders() .setContentLanguage("en-US") .setContentType("binary"), requestConditions, timeout, new Context(key2, value2)); System.out.printf("Set HTTP headers completed with status %d%n", response.getStatusCode());
For more information, see the Azure Docs
headers
- PathHttpHeaders
requestConditions
- DataLakeRequestConditions
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.public PathInfo setAccessControlList(List<PathAccessControlEntry> accessControlList, String group, String owner)
Code Samples
PathAccessControlEntry pathAccessControlEntry = new PathAccessControlEntry() .setEntityId("entityId") .setPermissions(new RolePermissions().setReadPermission(true)); List<PathAccessControlEntry> pathAccessControlEntries = new ArrayList<>(); pathAccessControlEntries.add(pathAccessControlEntry); String group = "group"; String owner = "owner"; System.out.printf("Last Modified Time: %s", client.setAccessControlList(pathAccessControlEntries, group, owner) .getLastModified());
For more information, see the Azure Docs
accessControlList
- A list of PathAccessControlEntry
objects.group
- The group of the resource.owner
- The owner of the resource.public com.azure.core.http.rest.Response<PathInfo> setAccessControlListWithResponse(List<PathAccessControlEntry> accessControlList, String group, String owner, DataLakeRequestConditions requestConditions, Duration timeout, com.azure.core.util.Context context)
Code Samples
DataLakeRequestConditions requestConditions = new DataLakeRequestConditions().setLeaseId(leaseId); PathAccessControlEntry pathAccessControlEntry = new PathAccessControlEntry() .setEntityId("entityId") .setPermissions(new RolePermissions().setReadPermission(true)); List<PathAccessControlEntry> pathAccessControlEntries = new ArrayList<>(); pathAccessControlEntries.add(pathAccessControlEntry); String group = "group"; String owner = "owner"; Response<PathInfo> response = client.setAccessControlListWithResponse(pathAccessControlEntries, group, owner, requestConditions, timeout, new Context(key2, value2)); System.out.printf("Last Modified Time: %s", response.getValue().getLastModified());
For more information, see the Azure Docs
accessControlList
- A list of PathAccessControlEntry
objects.group
- The group of the resource.owner
- The owner of the resource.requestConditions
- DataLakeRequestConditions
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.public PathInfo setPermissions(PathPermissions permissions, String group, String owner)
Code Samples
PathPermissions permissions = new PathPermissions() .setGroup(new RolePermissions().setExecutePermission(true).setReadPermission(true)) .setOwner(new RolePermissions().setExecutePermission(true).setReadPermission(true).setWritePermission(true)) .setOther(new RolePermissions().setReadPermission(true)); String group = "group"; String owner = "owner"; System.out.printf("Last Modified Time: %s", client.setPermissions(permissions, group, owner) .getLastModified());
For more information, see the Azure Docs
permissions
- PathPermissions
group
- The group of the resource.owner
- The owner of the resource.public com.azure.core.http.rest.Response<PathInfo> setPermissionsWithResponse(PathPermissions permissions, String group, String owner, DataLakeRequestConditions requestConditions, Duration timeout, com.azure.core.util.Context context)
Code Samples
DataLakeRequestConditions requestConditions = new DataLakeRequestConditions().setLeaseId(leaseId); PathPermissions permissions = new PathPermissions() .setGroup(new RolePermissions().setExecutePermission(true).setReadPermission(true)) .setOwner(new RolePermissions().setExecutePermission(true).setReadPermission(true).setWritePermission(true)) .setOther(new RolePermissions().setReadPermission(true)); String group = "group"; String owner = "owner"; Response<PathInfo> response = client.setPermissionsWithResponse(permissions, group, owner, requestConditions, timeout, new Context(key2, value2)); System.out.printf("Last Modified Time: %s", response.getValue().getLastModified());
For more information, see the Azure Docs
permissions
- PathPermissions
group
- The group of the resource.owner
- The owner of the resource.requestConditions
- DataLakeRequestConditions
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.public PathAccessControl getAccessControl()
Code Samples
PathAccessControl response = client.getAccessControl(); System.out.printf("Access Control List: %s, Group: %s, Owner: %s, Permissions: %s", PathAccessControlEntry.serializeList(response.getAccessControlList()), response.getGroup(), response.getOwner(), response.getPermissions());
For more information, see the Azure Docs
public com.azure.core.http.rest.Response<PathAccessControl> getAccessControlWithResponse(boolean userPrincipalNameReturned, DataLakeRequestConditions requestConditions, Duration timeout, com.azure.core.util.Context context)
Code Samples
DataLakeRequestConditions requestConditions = new DataLakeRequestConditions().setLeaseId(leaseId); boolean userPrincipalNameReturned = false; Response<PathAccessControl> response = client.getAccessControlWithResponse(userPrincipalNameReturned, requestConditions, timeout, new Context(key1, value1)); PathAccessControl pac = response.getValue(); System.out.printf("Access Control List: %s, Group: %s, Owner: %s, Permissions: %s", PathAccessControlEntry.serializeList(pac.getAccessControlList()), pac.getGroup(), pac.getOwner(), pac.getPermissions());
For more information, see the Azure Docs
userPrincipalNameReturned
- When true, user identity values returned as User Principal Names. When false,
user identity values returned as Azure Active Directory Object IDs. Default value is false.requestConditions
- DataLakeRequestConditions
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.public PathProperties getProperties()
Code Samples
System.out.printf("Creation Time: %s, Size: %d%n", client.getProperties().getCreationTime(), client.getProperties().getFileSize());
For more information, see the Azure Docs
public com.azure.core.http.rest.Response<PathProperties> getPropertiesWithResponse(DataLakeRequestConditions requestConditions, Duration timeout, com.azure.core.util.Context context)
Code Samples
DataLakeRequestConditions requestConditions = new DataLakeRequestConditions().setLeaseId(leaseId); Response<PathProperties> response = client.getPropertiesWithResponse(requestConditions, timeout, new Context(key2, value2)); System.out.printf("Creation Time: %s, Size: %d%n", response.getValue().getCreationTime(), response.getValue().getFileSize());
For more information, see the Azure Docs
requestConditions
- DataLakeRequestConditions
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.public Boolean exists()
Note that this method does not guarantee that the path type (file/directory) matches expectations.
For example, a DataLakeFileClient representing a path to a datalake directory will return true, and vice versa.
Code Samples
System.out.printf("Exists? %b%n", client.exists());
public com.azure.core.http.rest.Response<Boolean> existsWithResponse(Duration timeout, com.azure.core.util.Context context)
Note that this method does not guarantee that the path type (file/directory) matches expectations.
For example, a DataLakeFileClient representing a path to a datalake directory will return true, and vice versa.
Code Samples
System.out.printf("Exists? %b%n", client.existsWithResponse(timeout, new Context(key2, value2)).getValue());
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.public String generateUserDelegationSas(DataLakeServiceSasSignatureValues dataLakeServiceSasSignatureValues, UserDelegationKey userDelegationKey)
DataLakeServiceSasSignatureValues
.
See DataLakeServiceSasSignatureValues
for more information on how to construct a user delegation SAS.
Code Samples
OffsetDateTime myExpiryTime = OffsetDateTime.now().plusDays(1); PathSasPermission myPermission = new PathSasPermission().setReadPermission(true); DataLakeServiceSasSignatureValues myValues = new DataLakeServiceSasSignatureValues(expiryTime, permission) .setStartTime(OffsetDateTime.now()); client.generateUserDelegationSas(values, userDelegationKey);
dataLakeServiceSasSignatureValues
- DataLakeServiceSasSignatureValues
userDelegationKey
- A UserDelegationKey
object used to sign the SAS values.String
representing all SAS query parameters.for more information on how to
get a user delegation key.
public String generateSas(DataLakeServiceSasSignatureValues dataLakeServiceSasSignatureValues)
DataLakeServiceSasSignatureValues
Note : The client must be authenticated via StorageSharedKeyCredential
See DataLakeServiceSasSignatureValues
for more information on how to construct a service SAS.
Code Samples
OffsetDateTime expiryTime = OffsetDateTime.now().plusDays(1); PathSasPermission permission = new PathSasPermission().setReadPermission(true); DataLakeServiceSasSignatureValues values = new DataLakeServiceSasSignatureValues(expiryTime, permission) .setStartTime(OffsetDateTime.now()); client.generateSas(values); // Client must be authenticated via StorageSharedKeyCredential
dataLakeServiceSasSignatureValues
- DataLakeServiceSasSignatureValues
String
representing all SAS query parameters.Copyright © 2020 Microsoft Corporation. All rights reserved.