com.azure.storage.file.datalake.models.ListPathsOptions.yml

### YamlMime:JavaType
uid: "com.azure.storage.file.datalake.models.ListPathsOptions"
fullName: "com.azure.storage.file.datalake.models.ListPathsOptions"
name: "ListPathsOptions"
nameWithType: "ListPathsOptions"
summary: "Defines options available to configure the behavior of a call to list<wbr>Containers<wbr>Segment on a <xref uid=\"com.azure.storage.file.datalake.DataLakeFileSystemClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeFileSystemClient\"></xref> or a <xref uid=\"com.azure.storage.file.datalake.DataLakeFileSystemAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeFileSystemAsyncClient\"></xref> object."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public class **ListPathsOptions**"
constructors:
- uid: "com.azure.storage.file.datalake.models.ListPathsOptions.ListPathsOptions()"
  fullName: "com.azure.storage.file.datalake.models.ListPathsOptions.ListPathsOptions()"
  name: "ListPathsOptions()"
  nameWithType: "ListPathsOptions.ListPathsOptions()"
  summary: "Constructs an unpopulated <xref uid=\"com.azure.storage.file.datalake.models.ListPathsOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ListPathsOptions\"></xref>."
  syntax: "public ListPathsOptions()"
  desc: "Constructs an unpopulated <xref uid=\"com.azure.storage.file.datalake.models.ListPathsOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ListPathsOptions\"></xref>."
methods:
- uid: "com.azure.storage.file.datalake.models.ListPathsOptions.getMaxResults()"
  fullName: "com.azure.storage.file.datalake.models.ListPathsOptions.getMaxResults()"
  name: "getMaxResults()"
  nameWithType: "ListPathsOptions.getMaxResults()"
  summary: "Specifies the maximum number of blobs to return per page, including all Blob<wbr>Prefix elements."
  syntax: "public Integer getMaxResults()"
  desc: "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:
    description: "the number of containers to be returned in a single response"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.storage.file.datalake.models.ListPathsOptions.getPath()"
  fullName: "com.azure.storage.file.datalake.models.ListPathsOptions.getPath()"
  name: "getPath()"
  nameWithType: "ListPathsOptions.getPath()"
  summary: "Specifies the path to filter the results to."
  syntax: "public String getPath()"
  desc: "Specifies the path to filter the results to. An error occurs if the path does not exist."
  returns:
    description: "the path value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.datalake.models.ListPathsOptions.isRecursive()"
  fullName: "com.azure.storage.file.datalake.models.ListPathsOptions.isRecursive()"
  name: "isRecursive()"
  nameWithType: "ListPathsOptions.isRecursive()"
  summary: "Specifies if the call to list<wbr>Containers<wbr>Segment should recursively include all paths."
  syntax: "public boolean isRecursive()"
  desc: "Specifies if the call to listContainersSegment should recursively include all paths."
  returns:
    description: "<code>true</code> if the call to listContainerSegment recursively includes all paths."
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.ListPathsOptions.isUserPrincipalNameReturned()"
  fullName: "com.azure.storage.file.datalake.models.ListPathsOptions.isUserPrincipalNameReturned()"
  name: "isUserPrincipalNameReturned()"
  nameWithType: "ListPathsOptions.isUserPrincipalNameReturned()"
  summary: "Valid only when Hierarchical Namespace is enabled for the account."
  syntax: "public boolean isUserPrincipalNameReturned()"
  desc: "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:
    description: "the userPrincipalNameReturned value."
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.ListPathsOptions.setMaxResults(java.lang.Integer)"
  fullName: "com.azure.storage.file.datalake.models.ListPathsOptions.setMaxResults(Integer maxResults)"
  name: "setMaxResults(Integer maxResults)"
  nameWithType: "ListPathsOptions.setMaxResults(Integer maxResults)"
  summary: "Specifies the maximum number of blobs to return, including all Blob<wbr>Prefix elements."
  parameters:
  - description: "The number of containers to return in a single response"
    name: "maxResults"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
  syntax: "public ListPathsOptions setMaxResults(Integer maxResults)"
  desc: "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."
  returns:
    description: "the updated ListBlobContainersOptions object"
    type: "<xref href=\"com.azure.storage.file.datalake.models.ListPathsOptions?alt=com.azure.storage.file.datalake.models.ListPathsOptions&text=ListPathsOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.ListPathsOptions.setPath(java.lang.String)"
  fullName: "com.azure.storage.file.datalake.models.ListPathsOptions.setPath(String path)"
  name: "setPath(String path)"
  nameWithType: "ListPathsOptions.setPath(String path)"
  summary: "Specifies the path to filter the results to."
  parameters:
  - description: "The path value"
    name: "path"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public ListPathsOptions setPath(String path)"
  desc: "Specifies the path to filter the results to. An error occurs if the path does not exist."
  returns:
    description: "the updated ListPathsOptions object"
    type: "<xref href=\"com.azure.storage.file.datalake.models.ListPathsOptions?alt=com.azure.storage.file.datalake.models.ListPathsOptions&text=ListPathsOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.ListPathsOptions.setRecursive(boolean)"
  fullName: "com.azure.storage.file.datalake.models.ListPathsOptions.setRecursive(boolean recursive)"
  name: "setRecursive(boolean recursive)"
  nameWithType: "ListPathsOptions.setRecursive(boolean recursive)"
  summary: "Specifies if the call to list<wbr>Containers<wbr>Segment should recursively include all paths."
  parameters:
  - description: "<code>true</code> if the call to listContainerSegment recursively includes all paths."
    name: "recursive"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public ListPathsOptions setRecursive(boolean recursive)"
  desc: "Specifies if the call to listContainersSegment should recursively include all paths."
  returns:
    description: "the updated ListPathsOptions object."
    type: "<xref href=\"com.azure.storage.file.datalake.models.ListPathsOptions?alt=com.azure.storage.file.datalake.models.ListPathsOptions&text=ListPathsOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.ListPathsOptions.setUserPrincipalNameReturned(boolean)"
  fullName: "com.azure.storage.file.datalake.models.ListPathsOptions.setUserPrincipalNameReturned(boolean isUserPrincipalNameReturned)"
  name: "setUserPrincipalNameReturned(boolean isUserPrincipalNameReturned)"
  nameWithType: "ListPathsOptions.setUserPrincipalNameReturned(boolean isUserPrincipalNameReturned)"
  summary: "Valid only when Hierarchical Namespace is enabled for the account."
  parameters:
  - description: "The userPrincipalNameReturned value"
    name: "isUserPrincipalNameReturned"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public ListPathsOptions setUserPrincipalNameReturned(boolean isUserPrincipalNameReturned)"
  desc: "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:
    description: "the updated ListPathsOptions object"
    type: "<xref href=\"com.azure.storage.file.datalake.models.ListPathsOptions?alt=com.azure.storage.file.datalake.models.ListPathsOptions&text=ListPathsOptions\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Defines options available to configure the behavior of a call to listContainersSegment on a <xref uid=\"com.azure.storage.file.datalake.DataLakeFileSystemClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeFileSystemClient\"></xref> or a <xref uid=\"com.azure.storage.file.datalake.DataLakeFileSystemAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeFileSystemAsyncClient\"></xref> 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."
metadata: {}
package: "com.azure.storage.file.datalake.models"
artifact: com.azure:azure-storage-file-datalake:12.19.0