Class ListBlobContainersOptions

java.lang.Object
com.azure.storage.blob.models.ListBlobContainersOptions

public final class ListBlobContainersOptions extends Object
Defines options available to configure the behavior of a call to listContainersSegment on a BlobServiceClient 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 BlobContainerListDetails getDetails()
      Returns:
      the details for listing specific containers
    • setDetails

      Parameters:
      details - The details for listing specific containers
      Returns:
      the updated ListBlobContainersOptions object
    • getPrefix

      public String getPrefix()
      Filters the results to return only blobs whose names begin with the specified prefix.
      Returns:
      the prefix a container must start with to be returned
    • setPrefix

      public ListBlobContainersOptions setPrefix(String prefix)
      Filters the results to return only blobs whose names begin with the specified prefix.
      Parameters:
      prefix - The prefix that a container must match to be returned
      Returns:
      the updated ListBlobContainersOptions object
    • getMaxResultsPerPage

      public Integer getMaxResultsPerPage()
      Specifies the maximum number of blobs to return, including all BlobPrefix 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 containers to be returned in a single response
    • setMaxResultsPerPage

      public ListBlobContainersOptions setMaxResultsPerPage(Integer maxResultsPerPage)
      Specifies the maximum number of blobs to return, including all BlobPrefix 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 containers to return in a single response
      Returns:
      the updated ListBlobContainersOptions object
      Throws:
      IllegalArgumentException - If maxResultsPerPage is less than or equal to 0.