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

### YamlMime:JavaType
uid: "com.azure.storage.file.datalake.models.ListFileSystemsOptions"
fullName: "com.azure.storage.file.datalake.models.ListFileSystemsOptions"
name: "ListFileSystemsOptions"
nameWithType: "ListFileSystemsOptions"
summary: "Defines options available to configure the behavior of a call to list<wbr>File<wbr>Systems<wbr>Segment on a <xref uid=\"com.azure.storage.file.datalake.DataLakeServiceAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeServiceAsyncClient\"></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 final class **ListFileSystemsOptions**"
constructors:
- uid: "com.azure.storage.file.datalake.models.ListFileSystemsOptions.ListFileSystemsOptions()"
  fullName: "com.azure.storage.file.datalake.models.ListFileSystemsOptions.ListFileSystemsOptions()"
  name: "ListFileSystemsOptions()"
  nameWithType: "ListFileSystemsOptions.ListFileSystemsOptions()"
  summary: "Constructs an unpopulated <xref uid=\"com.azure.storage.file.datalake.models.ListFileSystemsOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ListFileSystemsOptions\"></xref>."
  syntax: "public ListFileSystemsOptions()"
  desc: "Constructs an unpopulated <xref uid=\"com.azure.storage.file.datalake.models.ListFileSystemsOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ListFileSystemsOptions\"></xref>."
methods:
- uid: "com.azure.storage.file.datalake.models.ListFileSystemsOptions.getDetails()"
  fullName: "com.azure.storage.file.datalake.models.ListFileSystemsOptions.getDetails()"
  name: "getDetails()"
  nameWithType: "ListFileSystemsOptions.getDetails()"
  syntax: "public FileSystemListDetails getDetails()"
  returns:
    description: "the details for listing specific file systems"
    type: "<xref href=\"com.azure.storage.file.datalake.models.FileSystemListDetails?alt=com.azure.storage.file.datalake.models.FileSystemListDetails&text=FileSystemListDetails\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.ListFileSystemsOptions.getMaxResultsPerPage()"
  fullName: "com.azure.storage.file.datalake.models.ListFileSystemsOptions.getMaxResultsPerPage()"
  name: "getMaxResultsPerPage()"
  nameWithType: "ListFileSystemsOptions.getMaxResultsPerPage()"
  summary: "Specifies the maximum number of paths to return, including all Path<wbr>Prefix elements."
  syntax: "public Integer getMaxResultsPerPage()"
  desc: "Specifies the maximum number of paths to return, including all PathPrefix elements. If the request does not specify maxResultsPerPage or specifies a value greater than 5,000, the server will return up to 5,000 items."
  returns:
    description: "the number of file systems 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.ListFileSystemsOptions.getPrefix()"
  fullName: "com.azure.storage.file.datalake.models.ListFileSystemsOptions.getPrefix()"
  name: "getPrefix()"
  nameWithType: "ListFileSystemsOptions.getPrefix()"
  summary: "Filters the results to return only paths whose names begin with the specified prefix."
  syntax: "public String getPrefix()"
  desc: "Filters the results to return only paths whose names begin with the specified prefix."
  returns:
    description: "the prefix a file system must start with to be returned"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.datalake.models.ListFileSystemsOptions.setDetails(com.azure.storage.file.datalake.models.FileSystemListDetails)"
  fullName: "com.azure.storage.file.datalake.models.ListFileSystemsOptions.setDetails(FileSystemListDetails details)"
  name: "setDetails(FileSystemListDetails details)"
  nameWithType: "ListFileSystemsOptions.setDetails(FileSystemListDetails details)"
  parameters:
  - description: "The details for listing specific file systems"
    name: "details"
    type: "<xref href=\"com.azure.storage.file.datalake.models.FileSystemListDetails?alt=com.azure.storage.file.datalake.models.FileSystemListDetails&text=FileSystemListDetails\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public ListFileSystemsOptions setDetails(FileSystemListDetails details)"
  returns:
    description: "the updated FileSystemListDetails object"
    type: "<xref href=\"com.azure.storage.file.datalake.models.ListFileSystemsOptions?alt=com.azure.storage.file.datalake.models.ListFileSystemsOptions&text=ListFileSystemsOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.ListFileSystemsOptions.setMaxResultsPerPage(java.lang.Integer)"
  fullName: "com.azure.storage.file.datalake.models.ListFileSystemsOptions.setMaxResultsPerPage(Integer maxResultsPerPage)"
  name: "setMaxResultsPerPage(Integer maxResultsPerPage)"
  nameWithType: "ListFileSystemsOptions.setMaxResultsPerPage(Integer maxResultsPerPage)"
  summary: "Specifies the maximum number of paths to return, including all Path<wbr>Prefix elements."
  parameters:
  - description: "The number of file systems to return in a single response"
    name: "maxResultsPerPage"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
  syntax: "public ListFileSystemsOptions setMaxResultsPerPage(Integer maxResultsPerPage)"
  desc: "Specifies the maximum number of paths to return, including all PathPrefix elements. If the request does not specify maxResultsPerPage or specifies a value greater than 5,000, the server will return up to 5,000 items."
  returns:
    description: "the updated ListFileSystemsOptions object"
    type: "<xref href=\"com.azure.storage.file.datalake.models.ListFileSystemsOptions?alt=com.azure.storage.file.datalake.models.ListFileSystemsOptions&text=ListFileSystemsOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.ListFileSystemsOptions.setPrefix(java.lang.String)"
  fullName: "com.azure.storage.file.datalake.models.ListFileSystemsOptions.setPrefix(String prefix)"
  name: "setPrefix(String prefix)"
  nameWithType: "ListFileSystemsOptions.setPrefix(String prefix)"
  summary: "Filters the results to return only paths whose names begin with the specified prefix."
  parameters:
  - description: "The prefix that a file system must match to be returned"
    name: "prefix"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public ListFileSystemsOptions setPrefix(String prefix)"
  desc: "Filters the results to return only paths whose names begin with the specified prefix."
  returns:
    description: "the updated ListFileSystemsOptions object"
    type: "<xref href=\"com.azure.storage.file.datalake.models.ListFileSystemsOptions?alt=com.azure.storage.file.datalake.models.ListFileSystemsOptions&text=ListFileSystemsOptions\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Defines options available to configure the behavior of a call to listFileSystemsSegment on a <xref uid=\"com.azure.storage.file.datalake.DataLakeServiceAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataLakeServiceAsyncClient\"></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.20.1