Class ListBlobsOptions

java.lang.Object
com.azure.storage.blob.models.ListBlobsOptions
public final class ListBlobsOptions extends Object
Defines options available to configure the behavior of a call to listBlobsFlatSegment on a BlobContainerClient object. See the constructor for details on each of the options.

  • Constructor Details

    • ListBlobsOptions

      public ListBlobsOptions()
      Constructs an unpopulated ListBlobsOptions.

  • Method Details

    • getDetails

      public BlobListDetails getDetails()
      Gets the details for listing specific blobs.
      Returns:
      the details for listing specific blobs

    • setDetails

      public ListBlobsOptions setDetails(BlobListDetails details)
      Sets the details for listing specific blobs.
      Parameters:
      details - The details for listing specific blobs
      Returns:
      the updated ListBlobsOptions object

    • getPrefix

      public String getPrefix()
      Filters the results to return only blobs whose names begin with the specified prefix. May be null to return all blobs.
      Returns:
      the prefix that a blob must match to be returned in the listing

    • setPrefix

      public ListBlobsOptions setPrefix(String prefix)
      Filters the results to return only blobs whose names begin with the specified prefix. May be null to return all blobs.
      Parameters:
      prefix - A prefix that a blob must match to be returned
      Returns:
      the updated ListBlobsOptions object

    • getStartFrom

      public String getStartFrom()
      Gets an optional parameter that specifies an absolute path within the container. This parameter is similar to the prefix filter: it allows listing blobs starting from the specified path, rather than from the beginning of the container. For non-recursive lists, only one entity level is supported.
      Returns:
      the marker indicating where to start listing blobs

    • setStartFrom

      public ListBlobsOptions setStartFrom(String startFrom)
      Sets an optional parameter that specifies an absolute path within the container. This parameter is similar to the prefix filter: it allows listing blobs starting from the specified path, rather than from the beginning of the container. For non-recursive lists, only one entity level is supported.
      Parameters:
      startFrom - The marker indicating where to start listing blobs
      Returns:
      the updated ListBlobsOptions 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 blobs that will be returned in a single response

    • setMaxResultsPerPage

      public ListBlobsOptions 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 blobs to returned in a single response
      Returns:
      the updated ListBlobsOptions object
      Throws:
      IllegalArgumentException - If maxResultsPerPage is less than or equal to 0.