Package com.azure.storage.file.datalake.options

Class PathUpdateAccessControlRecursiveOptions

  • public class PathUpdateAccessControlRecursiveOptions
extends Object
    Optional parameters for Update Access Control Recursive.

    • Constructor Detail

      • PathUpdateAccessControlRecursiveOptions

        public PathUpdateAccessControlRecursiveOptions​(List<PathAccessControlEntry> accessControlList)
        Constructs a new options object.
        Parameters:
        accessControlList - The POSIX access control list for the file or directory.

    • Method Detail

      • getAccessControlList

        public List<PathAccessControlEntry> getAccessControlList()
        Returns the POSIX access control list for the file or directory.
        Returns:
        The POSIX access control list for the file or directory.

      • getBatchSize

        public Integer getBatchSize()
        Gets the batch size.

        If data set size exceeds batch size then operation will be split into multiple requests so that progress can be tracked. Batch size should be between 1 and 2000. The default when unspecified is 2000.

        Returns:
        The size of the batch.

      • setBatchSize

        public PathUpdateAccessControlRecursiveOptions setBatchSize​(Integer batchSize)
        Sets the batch size.

        If data set size exceeds batch size then operation will be split into multiple requests so that progress can be tracked. Batch size should be between 1 and 2000. The default when unspecified is 2000.

        Parameters:
        batchSize - The size of the batch.
        Returns:
        The updated object.

      • getMaxBatches

        public Integer getMaxBatches()
        Gets the maximum number of batches that single change Access Control operation can execute.

        If maximum is reached before all subpaths are processed then continuation token can be used to resume operation. Empty value indicates that maximum number of batches in unbound and operation continues till end. Operation may also halt if an error is hit and continueOnFailure is false.

        Returns:
        The maximum number of batches.

      • setMaxBatches

        public PathUpdateAccessControlRecursiveOptions setMaxBatches​(Integer maxBatches)
        Sets the maximum number of batches that single change Access Control operation can execute.

        If maximum is reached before all subpaths are processed then continuation token can be used to resume operation. Empty value indicates that maximum number of batches in unbound and operation continues till end. Operation may * also halt if an error is hit and continueOnFailure is false.

        Parameters:
        maxBatches - The maximum number of batches.
        Returns:
        The updated object.

      • getProgressHandler

        public Consumer<com.azure.core.http.rest.Response<AccessControlChanges>> getProgressHandler()
        Gets a callback where caller can track progress of the operation as well as collect paths that failed to change Access Control.
        Returns:
        The progress handler.

      • setProgressHandler

        public PathUpdateAccessControlRecursiveOptions setProgressHandler​(Consumer<com.azure.core.http.rest.Response<AccessControlChanges>> progressHandler)
        Sets a callback where caller can track progress of the operation as well as collect paths that failed to change Access Control.
        Parameters:
        progressHandler - The progress handler.
        Returns:
        The updated object.

      • getContinuationToken

        public String getContinuationToken()
        Returns a token that can be used to resume previously stopped operation.
        Returns:
        A token that can be used to resume previously stopped operation.

      • setContinuationToken

        public PathUpdateAccessControlRecursiveOptions setContinuationToken​(String continuationToken)
        Sets a token that can be used to resume previously stopped operation.
        Parameters:
        continuationToken - A token that can be used to resume previously stopped operation.
        Returns:
        The updated object.

      • isContinueOnFailure

        public boolean isContinueOnFailure()
        Returns if the operation should continue on user failure.

        If set to false, the operation will terminate quickly on encountering user failures. If true, the operation will ignore user failures and proceed with the operation on other sub-entities of the directory.

        Returns:
        If the operation should continue on user failure.

      • setContinueOnFailure

        public PathUpdateAccessControlRecursiveOptions setContinueOnFailure​(boolean continueOnFailure)
        Sets if the operation should continue on user failure.

        If set to false, the operation will terminate quickly on encountering user failures. If true, the operation will ignore user failures and proceed with the operation on other sub-entities of the directory.

        Parameters:
        continueOnFailure - Whether the operation should continue on user failure.
        Returns:
        The updated object.