Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support the getStatus action in the Azure File Datalake getProperties API #43750

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Support the getStatus action in the Azure File Datalake getProperties API #43750

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6a48ebd
Support the getStatus action in the Azure File Datalake getProperties…
eduardotr-db Jan 8, 2025
9696e0c
Fix imports in tests and refactor Cpk test added
eduardotr-db Jan 8, 2025
16cc5a2
Fix nits
eduardotr-db Jan 8, 2025
f1c2dd5
Implement the getStatus method in the Async client
eduardotr-db Jan 8, 2025
bd98c6c
Fix imports
eduardotr-db Jan 8, 2025
08f37d0
Revert trailing space removal and fix method visibility causing javad…
eduardotr-db Jan 9, 2025
1a18955
Revert AccessorUtility changes
eduardotr-db Jan 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 85 additions & 0 deletions ...-file-datalake/src/main/java/com/azure/storage/file/datalake/DataLakePathAsyncClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,17 @@
import com.azure.storage.file.datalake.models.DataLakeAclChangeFailedException;
import com.azure.storage.file.datalake.models.DataLakeRequestConditions;
import com.azure.storage.file.datalake.models.DataLakeStorageException;
import com.azure.storage.file.datalake.models.LeaseDurationType;
import com.azure.storage.file.datalake.models.LeaseStatusType;
import com.azure.storage.file.datalake.models.LeaseStateType;
import com.azure.storage.file.datalake.models.PathAccessControl;
import com.azure.storage.file.datalake.models.PathAccessControlEntry;
import com.azure.storage.file.datalake.models.PathHttpHeaders;
import com.azure.storage.file.datalake.models.PathInfo;
import com.azure.storage.file.datalake.models.PathItem;
import com.azure.storage.file.datalake.models.PathPermissions;
import com.azure.storage.file.datalake.models.PathProperties;
import com.azure.storage.file.datalake.models.PathStatus;
import com.azure.storage.file.datalake.models.PathRemoveAccessControlEntry;
import com.azure.storage.file.datalake.models.UserDelegationKey;
import com.azure.storage.file.datalake.options.DataLakePathCreateOptions;
Expand Down Expand Up @@ -1603,6 +1607,87 @@ Mono<Response<PathAccessControl>> getAccessControlWithResponse(boolean userPrinc
response.getDeserializedHeaders().getXMsGroup(), response.getDeserializedHeaders().getXMsOwner())));
}

/**
* Returns the system defined properties for a resource.
*
* <p><strong>Code Samples</strong></p>
*
* <!-- src_embed com.azure.storage.file.datalake.DataLakePathAsyncClient.getStatus -->
* <pre>
* client.getStatus&#40;&#41;.subscribe&#40;
* response -&gt; System.out.printf&#40;&quot;Creation Time: %s, Group: %s, Owner: %s, Permissions: %s&quot;,
* response.getCreationTime&#40;&#41;, response.getGroup&#40;&#41;,
* response.getOwner&#40;&#41;, response.getPermissions&#40;&#41;&#41;&#41;;
* </pre>
* <!-- end com.azure.storage.file.datalake.DataLakePathAsyncClient.getStatus -->
*
* <p>For more information, see the
* <a href="https://docs.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/getproperties">Azure Docs</a></p>
*
* @return A response containing the resource status.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono<PathStatus> getStatus() {
return getStatusWithResponse(null, Context.NONE).flatMap(FluxUtil::toMono);
}

/**
* Returns the system defined properties for a resource.
*
* <p><strong>Code Samples</strong></p>
*
* <!-- src_embed com.azure.storage.file.datalake.DataLakePathAsyncClient.getStatusWithResponse#DataLakeRequestConditions -->
* <pre>
* DataLakeRequestConditions requestConditions = new DataLakeRequestConditions&#40;&#41;.setLeaseId&#40;leaseId&#41;;
*
* client.getStatusWithResponse&#40;requestConditions&#41;.subscribe&#40;
* response -&gt; System.out.printf&#40;&quot;Creation Time: %s, Group: %s, Owner: %s, Permissions: %s&quot;,
* response.getValue&#40;&#41;.getCreationTime&#40;&#41;,
* response.getValue&#40;&#41;.getGroup&#40;&#41;, response.getValue&#40;&#41;.getOwner&#40;&#41;, response.getValue&#40;&#41;.getPermissions&#40;&#41;&#41;&#41;;
* </pre>
* <!-- end com.azure.storage.file.datalake.DataLakePathAsyncClient.getStatusWithResponse#DataLakeRequestConditions -->
*
* <p>For more information, see the
* <a href="https://docs.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/getproperties">Azure Docs</a></p>
*
* @param requestConditions {@link DataLakeRequestConditions}
* @return A response containing the resource status.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono<Response<PathStatus>> getStatusWithResponse(DataLakeRequestConditions requestConditions) {
try {
return withContext(context -> getStatusWithResponse(requestConditions, context));
} catch (RuntimeException ex) {
return monoError(LOGGER, ex);
}
}

Mono<Response<PathStatus>> getStatusWithResponse(DataLakeRequestConditions requestConditions, Context context) {
requestConditions = requestConditions == null ? new DataLakeRequestConditions() : requestConditions;

LeaseAccessConditions lac = new LeaseAccessConditions().setLeaseId(requestConditions.getLeaseId());
ModifiedAccessConditions mac = new ModifiedAccessConditions().setIfMatch(requestConditions.getIfMatch())
.setIfNoneMatch(requestConditions.getIfNoneMatch())
.setIfModifiedSince(requestConditions.getIfModifiedSince())
.setIfUnmodifiedSince(requestConditions.getIfUnmodifiedSince());

context = context == null ? Context.NONE : context;
return this.dataLakeStorage.getPaths()
.getPropertiesWithResponseAsync(null, null, PathGetPropertiesAction.GET_STATUS, false, lac, mac, context)
.map(response -> new SimpleResponse<>(response, new PathStatus(response.getDeserializedHeaders().getDate(),
response.getDeserializedHeaders().getLastModified(), response.getDeserializedHeaders().getETag(),
response.getDeserializedHeaders().getContentLength(),
LeaseStatusType.fromString(response.getDeserializedHeaders().getXMsLeaseStatus()),
LeaseStateType.fromString(response.getDeserializedHeaders().getXMsLeaseState()),
LeaseDurationType.fromString(response.getDeserializedHeaders().getXMsLeaseDuration()),
response.getDeserializedHeaders().isServerEncrypted(),
response.getDeserializedHeaders().getXMsEncryptionKeySha256(),
response.getDeserializedHeaders().getXMsEncryptionScope(),
response.getDeserializedHeaders().getXMsEncryptionContext(),
response.getDeserializedHeaders().getXMsOwner(), response.getDeserializedHeaders().getXMsGroup(),
response.getDeserializedHeaders().getXMsPermissions(), response.getDeserializedHeaders().getXMsAcl())));
}

/**
* Package-private rename method for use by {@link DataLakeFileAsyncClient} and {@link DataLakeDirectoryAsyncClient}
*
Expand Down
88 changes: 88 additions & 0 deletions ...orage-file-datalake/src/main/java/com/azure/storage/file/datalake/DataLakePathClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,16 @@
import com.azure.storage.file.datalake.models.DataLakeAclChangeFailedException;
import com.azure.storage.file.datalake.models.DataLakeRequestConditions;
import com.azure.storage.file.datalake.models.DataLakeStorageException;
import com.azure.storage.file.datalake.models.LeaseDurationType;
import com.azure.storage.file.datalake.models.LeaseStatusType;
import com.azure.storage.file.datalake.models.LeaseStateType;
import com.azure.storage.file.datalake.models.PathAccessControl;
import com.azure.storage.file.datalake.models.PathAccessControlEntry;
import com.azure.storage.file.datalake.models.PathHttpHeaders;
import com.azure.storage.file.datalake.models.PathInfo;
import com.azure.storage.file.datalake.models.PathPermissions;
import com.azure.storage.file.datalake.models.PathProperties;
import com.azure.storage.file.datalake.models.PathStatus;
import com.azure.storage.file.datalake.models.PathRemoveAccessControlEntry;
import com.azure.storage.file.datalake.models.UserDelegationKey;
import com.azure.storage.file.datalake.options.DataLakePathCreateOptions;
Expand Down Expand Up @@ -1371,6 +1375,90 @@ public Response<PathAccessControl> getAccessControlWithResponse(boolean userPrin
response.getDeserializedHeaders().getXMsGroup(), response.getDeserializedHeaders().getXMsOwner()));
}

/**
* Returns the system defined properties for a resource.
*
* <p><strong>Code Samples</strong></p>
*
* <!-- src_embed com.azure.storage.file.datalake.DataLakePathClient.getStatus -->
* <pre>
* PathStatus response = client.getStatus&#40;&#41;;
* System.out.printf&#40;&quot;CreationTime: %s, Group: %s, Owner: %s, Permissions: %s&quot;,
* response.getCreationTime&#40;&#41;, response.getGroup&#40;&#41;,
* response.getOwner&#40;&#41;, response.getPermissions&#40;&#41;&#41;;
* </pre>
* <!-- end com.azure.storage.file.datalake.DataLakePathClient.getStatus -->
*
* <p>For more information, see the
* <a href="https://docs.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/getproperties">Azure Docs</a></p>
*
* @return A response containing the resource status.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public PathStatus getStatus() {
return getStatusWithResponse(null, null, Context.NONE).getValue();
}

/**
* Returns the system defined properties for a resource.
*
* <p><strong>Code Samples</strong></p>
*
* <!-- src_embed com.azure.storage.file.datalake.DataLakePathClient.getStatusWithResponse#DataLakeRequestConditions-Duration-Context -->
* <pre>
* DataLakeRequestConditions requestConditions = new DataLakeRequestConditions&#40;&#41;.setLeaseId&#40;leaseId&#41;;
*
* Response&lt;PathStatus&gt; response = client.getStatusWithResponse&#40;
* requestConditions, timeout, new Context&#40;key1, value1&#41;&#41;;
*
* PathStatus ps = response.getValue&#40;&#41;;
*
* System.out.printf&#40;&quot;CreationTime: %s, Group: %s, Owner: %s, Permissions: %s&quot;,
* ps.getCreationTime&#40;&#41;, ps.getGroup&#40;&#41;, ps.getOwner&#40;&#41;,
* ps.getPermissions&#40;&#41;&#41;;
* </pre>
* <!-- end com.azure.storage.file.datalake.DataLakePathClient.getStatusWithResponse#DataLakeRequestConditions-Duration-Context -->
*
* <p>For more information, see the
* <a href="https://docs.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/getproperties">Azure Docs</a></p>
*
* @param requestConditions {@link DataLakeRequestConditions}
* @param timeout An optional timeout value beyond which a {@link RuntimeException} will be raised.
* @param context Additional context that is passed through the Http pipeline during the service call.
* @return A response containing the resource status.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Response<PathStatus> getStatusWithResponse(DataLakeRequestConditions requestConditions, Duration timeout,
Context context) {
requestConditions = requestConditions == null ? new DataLakeRequestConditions() : requestConditions;

LeaseAccessConditions lac = new LeaseAccessConditions().setLeaseId(requestConditions.getLeaseId());
ModifiedAccessConditions mac = new ModifiedAccessConditions().setIfMatch(requestConditions.getIfMatch())
.setIfNoneMatch(requestConditions.getIfNoneMatch())
.setIfModifiedSince(requestConditions.getIfModifiedSince())
.setIfUnmodifiedSince(requestConditions.getIfUnmodifiedSince());

Context finalContext = context == null ? Context.NONE : context;
Callable<ResponseBase<PathsGetPropertiesHeaders, Void>> operation = () -> this.dataLakeStorage.getPaths()
.getPropertiesWithResponse(null, null, PathGetPropertiesAction.GET_STATUS, false, lac, mac, finalContext);
ResponseBase<PathsGetPropertiesHeaders, Void> response
= sendRequest(operation, timeout, DataLakeStorageException.class);

return new SimpleResponse<>(response,
new PathStatus(response.getDeserializedHeaders().getDate(),
response.getDeserializedHeaders().getLastModified(), response.getDeserializedHeaders().getETag(),
response.getDeserializedHeaders().getContentLength(),
LeaseStatusType.fromString(response.getDeserializedHeaders().getXMsLeaseStatus()),
LeaseStateType.fromString(response.getDeserializedHeaders().getXMsLeaseState()),
LeaseDurationType.fromString(response.getDeserializedHeaders().getXMsLeaseDuration()),
response.getDeserializedHeaders().isServerEncrypted(),
response.getDeserializedHeaders().getXMsEncryptionKeySha256(),
response.getDeserializedHeaders().getXMsEncryptionScope(),
response.getDeserializedHeaders().getXMsEncryptionContext(),
response.getDeserializedHeaders().getXMsOwner(), response.getDeserializedHeaders().getXMsGroup(),
response.getDeserializedHeaders().getXMsPermissions(), response.getDeserializedHeaders().getXMsAcl()));
}

Response<DataLakePathClient> renameWithResponseWithTimeout(String destinationFileSystem, String destinationPath,
DataLakeRequestConditions sourceRequestConditions, DataLakeRequestConditions destinationRequestConditions,
Duration timeout, Context context) {
Expand Down
Loading
Loading