Package com.azure.storage.file.datalake.models

Class ListFileSystemsOptions

java.lang.Object
com.azure.storage.file.datalake.models.ListFileSystemsOptions
public final class ListFileSystemsOptions extends Object
Defines options available to configure the behavior of a call to listFileSystemsSegment on a DataLakeServiceAsyncClient 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 Details

  • Method Details

    • getDetails

      public FileSystemListDetails getDetails()
      Returns:
      the details for listing specific file systems

    • setDetails

      public ListFileSystemsOptions setDetails(FileSystemListDetails details)
      Parameters:
      details - The details for listing specific file systems
      Returns:
      the updated FileSystemListDetails object

    • getPrefix

      public String getPrefix()
      Filters the results to return only paths whose names begin with the specified prefix.
      Returns:
      the prefix a file system must start with to be returned

    • setPrefix

      public ListFileSystemsOptions setPrefix(String prefix)
      Filters the results to return only paths whose names begin with the specified prefix.
      Parameters:
      prefix - The prefix that a file system must match to be returned
      Returns:
      the updated ListFileSystemsOptions object

    • getMaxResultsPerPage

      public Integer getMaxResultsPerPage()
      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:
      the number of file systems to be returned in a single response

    • setMaxResultsPerPage

      public ListFileSystemsOptions setMaxResultsPerPage(Integer maxResultsPerPage)
      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.
      Parameters:
      maxResultsPerPage - The number of file systems to return in a single response
      Returns:
      the updated ListFileSystemsOptions object
      Throws:
      IllegalArgumentException - If maxResultsPerPage is less than or equal to 0.