Package com.azure.storage.blob.options

Class FindBlobsOptions

java.lang.Object

com.azure.storage.blob.options.FindBlobsOptions

public class FindBlobsOptions
extends Object

Defines options available to configure the behavior of a call to BlobServiceClient.findBlobsByTags(FindBlobsOptions, Duration, com.azure.core.util.Context) or BlobServiceAsyncClient.findBlobsByTags(FindBlobsOptions). See the constructor for details on each of the options.

Constructor Summary

Constructors

Constructor	Description
FindBlobsOptions(String query)	Creates a new instance of FindBlobsOptions.

Method Summary

Modifier and Type	Method	Description
Integer	getMaxResultsPerPage()	Specifies the maximum number of blobs to return.
String	getQuery()	Gets the filters the results to return only blobs whose tags match the specified expression.
FindBlobsOptions	setMaxResultsPerPage(Integer maxResultsPerPage)	Specifies the maximum number of blobs to return.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FindBlobsOptions

public FindBlobsOptions(String query)

Creates a new instance of FindBlobsOptions.

Parameters:

query - Filters the results to return only blobs whose tags match the specified expression.

Throws:

NullPointerException - If query is null.

Method Details

getQuery

public String getQuery()

Gets the filters the results to return only blobs whose tags match the specified expression.

Returns:

Filters the results to return only blobs whose tags match the specified expression.

getMaxResultsPerPage

public Integer getMaxResultsPerPage()

Specifies the maximum number of blobs to return. 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 FindBlobsOptions setMaxResultsPerPage(Integer maxResultsPerPage)

Specifies the maximum number of blobs to return. 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 FindBlobsOptions object

Throws:

IllegalArgumentException - If maxResultsPerPage is less than or equal to 0.