Package com.azure.storage.file.share.models

Class ListSharesOptions

java.lang.Object

com.azure.storage.file.share.models.ListSharesOptions

public final class ListSharesOptions
extends Object

A set of options for selecting shares from Storage File service.

• Providing prefix will filter selections to shares that that begin with the prefix.
• Providing maxResultsPerPage will limit the number of shares returned in a single page.
• Setting includeMetadata to true will include the metadata of each share, if false ShareItem.getMetadata() metadata} for each share will be null.
• Setting includeSnapshots to true will include snapshots of each share, the snapshot will be included as separate items in the response and will be identifiable by ShareItem.getSnapshot() snapshot} having a value. The base share will contain null for the snapshot.
• Setting includeDeleted to true will include deleted shares, the deleted shares will be included as separate items in the response and will be identifiable by ShareItem.isDeleted() having a truevalue.

Constructor Summary

Constructors

Constructor	Description
ListSharesOptions()

Method Summary

Modifier and Type	Method	Description
Integer	getMaxResultsPerPage()
String	getPrefix()
boolean	isIncludeDeleted()
boolean	isIncludeMetadata()
boolean	isIncludeSnapshots()
ListSharesOptions	setIncludeDeleted(boolean includeDeleted)	Sets the status of including deleted shares when listing shares
ListSharesOptions	setIncludeMetadata(boolean includeMetadata)	Sets the status of including share metadata when listing shares If listing snapshots as well this will also determine if the snapshots have their metadata included as well.
ListSharesOptions	setIncludeSnapshots(boolean includeSnapshots)	Sets the status of including share snapshots when listing shares
ListSharesOptions	setMaxResultsPerPage(Integer maxResultsPerPage)	Sets the maximum number of shares to include in a single response.
ListSharesOptions	setPrefix(String prefix)	Sets the prefix that a share must match to be included in the listing.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListSharesOptions

public ListSharesOptions()

Method Detail

setPrefix

public ListSharesOptions setPrefix(String prefix)

Sets the prefix that a share must match to be included in the listing.

Parameters:

prefix - The prefix that shares must start with to pass the filter

Returns:

An updated ListSharesOptions object

getPrefix

public String getPrefix()

Returns:

the prefix that a share must match to be included in the listing

setMaxResultsPerPage

public ListSharesOptions setMaxResultsPerPage(Integer maxResultsPerPage)

Sets the maximum number of shares to include in a single response.

Parameters:

maxResultsPerPage - Maximum number of shares to include in a single response. This value must be between 1 and 5000.

Returns:

An updated ListSharesOptions object

getMaxResultsPerPage

public Integer getMaxResultsPerPage()

Returns:

the maximum number of shares to inlcude in a single response

setIncludeMetadata

public ListSharesOptions setIncludeMetadata(boolean includeMetadata)

Sets the status of including share metadata when listing shares If listing snapshots as well this will also determine if the snapshots have their metadata included as well.

Parameters:

includeMetadata - Flag indicating if metadata should be including in the listing

Returns:

An updated ListSharesOptions object

isIncludeMetadata

public boolean isIncludeMetadata()

Returns:

the status of include share metadata when listing shares

setIncludeSnapshots

public ListSharesOptions setIncludeSnapshots(boolean includeSnapshots)

Sets the status of including share snapshots when listing shares

Parameters:

includeSnapshots - Flag indicating if snapshots should be included in the listing

Returns:

An updated ListSharesOptions object

isIncludeSnapshots

public boolean isIncludeSnapshots()

Returns:

the status of including share snapshots when listing shares

setIncludeDeleted

public ListSharesOptions setIncludeDeleted(boolean includeDeleted)

Sets the status of including deleted shares when listing shares

Parameters:

includeDeleted - Flag indicating if deleted shares should be included in the listing

Returns:

An updated ListSharesOptions object

isIncludeDeleted

public boolean isIncludeDeleted()

Returns:

the status of including deleted shares when listing shares