ListBlobsOptions Class

  • Reference
Package:
com.azure.storage.blob.models
Maven Artifact:
com.azure:azure-storage-blob:12.28.1
  • java.lang.Object
    • com.azure.storage.blob.models.ListBlobsOptions

public final class ListBlobsOptions

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 Summary

Constructor Description
ListBlobsOptions()

Constructs an unpopulated ListBlobsOptions.

Method Summary

Modifier and Type Method and Description
BlobListDetails getDetails()
Integer getMaxResultsPerPage()

Specifies the maximum number of blobs to return, including all BlobPrefix elements.
String getPrefix()

Filters the results to return only blobs whose names begin with the specified prefix.
ListBlobsOptions setDetails(BlobListDetails details)
ListBlobsOptions setMaxResultsPerPage(Integer maxResultsPerPage)

Specifies the maximum number of blobs to return, including all BlobPrefix elements.
ListBlobsOptions setPrefix(String prefix)

Filters the results to return only blobs whose names begin with the specified prefix.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ListBlobsOptions

public ListBlobsOptions()

Constructs an unpopulated ListBlobsOptions.

Method Details

getDetails

public BlobListDetails getDetails()

Returns:

the details for listing specific blobs

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

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

setDetails

public ListBlobsOptions setDetails(BlobListDetails details)

Parameters:

details - The details for listing specific blobs

Returns:

the updated ListBlobsOptions object

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

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

Applies to