public final class ListSharesOptions extends Object
prefix
will filter selections to
shares
that that begin with the prefix.
maxResultsPerPage
will limit the number of
shares
returned in a single page.
includeMetadata
to true will include the
metadata of each share
, if false ShareItem.getMetadata()
metadata} for each share
will be null
.
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.
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 true
value.
Constructor and Description |
---|
ListSharesOptions() |
Modifier and Type | Method and 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.
|
public ListSharesOptions setPrefix(String prefix)
prefix
- The prefix that shares must start with to pass the filterpublic String getPrefix()
public ListSharesOptions setMaxResultsPerPage(Integer maxResultsPerPage)
maxResultsPerPage
- Maximum number of shares to include in a single response. This value must be between 1
and 5000.public Integer getMaxResultsPerPage()
public ListSharesOptions setIncludeMetadata(boolean includeMetadata)
includeMetadata
- Flag indicating if metadata should be including in the listingpublic boolean isIncludeMetadata()
public ListSharesOptions setIncludeSnapshots(boolean includeSnapshots)
includeSnapshots
- Flag indicating if snapshots should be included in the listingpublic boolean isIncludeSnapshots()
public ListSharesOptions setIncludeDeleted(boolean includeDeleted)
includeDeleted
- Flag indicating if deleted shares should be included in the listingpublic boolean isIncludeDeleted()
Copyright © 2020 Microsoft Corporation. All rights reserved.