Class ListPathsOptions
- java.lang.Object
-
- com.azure.storage.file.datalake.models.ListPathsOptions
-
public class ListPathsOptions extends Object
Defines options available to configure the behavior of a call to listContainersSegment on aDataLakeFileSystemClient
or aDataLakeFileSystemAsyncClient
object. See the constructor for details on each of the options. Null may be passed in place of an object of this type if no options are desirable.
-
-
Constructor Summary
Constructors Constructor Description ListPathsOptions()
Constructs an unpopulatedListPathsOptions
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Integer
getMaxResults()
Specifies the maximum number of blobs to return per page, including all BlobPrefix elements.String
getPath()
Specifies the path to filter the results to.boolean
isRecursive()
Specifies if the call to listContainersSegment should recursively include all paths.boolean
isUserPrincipalNameReturned()
Valid only when Hierarchical Namespace is enabled for the account.ListPathsOptions
setMaxResults(Integer maxResults)
Specifies the maximum number of blobs to return, including all BlobPrefix elements.ListPathsOptions
setPath(String path)
Specifies the path to filter the results to.ListPathsOptions
setRecursive(boolean recursive)
Specifies if the call to listContainersSegment should recursively include all paths.ListPathsOptions
setUserPrincipalNameReturned(boolean isUserPrincipalNameReturned)
Valid only when Hierarchical Namespace is enabled for the account.
-
-
-
Constructor Detail
-
ListPathsOptions
public ListPathsOptions()
Constructs an unpopulatedListPathsOptions
.
-
-
Method Detail
-
getPath
public String getPath()
Specifies the path to filter the results to. An error occurs if the path does not exist.- Returns:
- the path value.
-
isRecursive
public boolean isRecursive()
Specifies if the call to listContainersSegment should recursively include all paths.- Returns:
true
if the call to listContainerSegment recursively includes all paths.
-
isUserPrincipalNameReturned
public boolean isUserPrincipalNameReturned()
Valid only when Hierarchical Namespace is enabled for the account. If "true", the user identity values returned by the x-ms-owner, x-ms-group, and x-ms-acl response headers will be transformed from Azure Active Directory Object IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do not have unique friendly names.- Returns:
- the userPrincipalNameReturned value.
-
setPath
public ListPathsOptions setPath(String path)
Specifies the path to filter the results to. An error occurs if the path does not exist.- Parameters:
path
- The path value- Returns:
- the updated ListPathsOptions object
-
setRecursive
public ListPathsOptions setRecursive(boolean recursive)
Specifies if the call to listContainersSegment should recursively include all paths.- Parameters:
recursive
-true
if the call to listContainerSegment recursively includes all paths.- Returns:
- the updated ListPathsOptions object.
-
setUserPrincipalNameReturned
public ListPathsOptions setUserPrincipalNameReturned(boolean isUserPrincipalNameReturned)
Valid only when Hierarchical Namespace is enabled for the account. If "true", the user identity values returned by the x-ms-owner, x-ms-group, and x-ms-acl response headers will be transformed from Azure Active Directory Object IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do not have unique friendly names.- Parameters:
isUserPrincipalNameReturned
- The userPrincipalNameReturned value- Returns:
- the updated ListPathsOptions object
-
getMaxResults
public Integer getMaxResults()
Specifies the maximum number of blobs to return per page, including all BlobPrefix elements. If the request does not specify maxResults or specifies a value greater than 5,000, the server will return up to 5,000 items per page.- Returns:
- the number of containers to be returned in a single response
-
setMaxResults
public ListPathsOptions setMaxResults(Integer maxResults)
Specifies the maximum number of blobs to return, including all BlobPrefix elements. If the request does not specify maxResults or specifies a value greater than 5,000, the server will return up to 5,000 items.- Parameters:
maxResults
- The number of containers to return in a single response- Returns:
- the updated ListBlobContainersOptions object
- Throws:
IllegalArgumentException
- IfmaxResults
is less than or equal to0
.
-
-