ShareFileListRangesDiffOptions Class

Package:

com.azure.storage.file.share.options

Maven Artifact:

com.azure:azure-storage-file-share:12.26.0

• java.lang.Object
• • com.azure.storage.file.share.options.ShareFileListRangesDiffOptions

public class ShareFileListRangesDiffOptions

Extended options that may be passed when listing ranges for a File.

Constructor Summary

Constructor	Description
ShareFileListRangesDiffOptions(String previousSnapshot)	Creates a new instance of ShareFileListRangesDiffOptions.

Method Summary

Modifier and Type	Method and Description
String	getPreviousSnapshot() Gets the previous snapshot to compare to.
ShareFileRange	getRange() Gets the range of bytes over which to list ranges, inclusively.
ShareRequestConditions	getRequestConditions() Gets the ShareRequestConditions.
Boolean	isRenameIncluded() Gets the supportRename value.
ShareFileListRangesDiffOptions	setRange(ShareFileRange range) Sets the range of bytes over which to list ranges, inclusively.
ShareFileListRangesDiffOptions	setRenameIncluded(Boolean renameIncluded) Sets the value for whether the changed ranges for a file that has been renamed or moved should appear in the snapshot dif.
ShareFileListRangesDiffOptions	setRequestConditions(ShareRequestConditions requestConditions) Sets the ShareRequestConditions.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ShareFileListRangesDiffOptions

public ShareFileListRangesDiffOptions(String previousSnapshot)

Creates a new instance of ShareFileListRangesDiffOptions.

Parameters:

previousSnapshot - Specifies that the response will contain only ranges that were changed between target file and previous snapshot. Changed ranges include both updated and cleared ranges. The target file may be a snapshot, as long as the snapshot specified by previousSnapshot is the older of the two.

Method Details

getPreviousSnapshot

public String getPreviousSnapshot()

Gets the previous snapshot to compare to.

Returns:

The previous snapshot to compare to.

getRange

public ShareFileRange getRange()

Gets the range of bytes over which to list ranges, inclusively.

Returns:

The range of bytes over which to list ranges, inclusively.

getRequestConditions

public ShareRequestConditions getRequestConditions()

Gets the ShareRequestConditions.

Returns:

ShareRequestConditions

isRenameIncluded

public Boolean isRenameIncluded()

Gets the supportRename value.

Returns:

Whether the changed ranges for a file that has been renamed or moved between the target snapshot (or the live file) and the previous snapshot should be listed.

setRange

public ShareFileListRangesDiffOptions setRange(ShareFileRange range)

Sets the range of bytes over which to list ranges, inclusively.

Parameters:

range - The range of bytes over which to list ranges, inclusively.

Returns:

The updated options.

setRenameIncluded

public ShareFileListRangesDiffOptions setRenameIncluded(Boolean renameIncluded)

Sets the value for whether the changed ranges for a file that has been renamed or moved should appear in the snapshot dif.

Parameters:

renameIncluded - Whether the changed ranges for a file that has been renamed or moved between the target snapshot (or the live file) and the previous snapshot should be listed.

Returns:

The updated options.

setRequestConditions

public ShareFileListRangesDiffOptions setRequestConditions(ShareRequestConditions requestConditions)

Sets the ShareRequestConditions.

Parameters:

requestConditions - ShareRequestConditions for the file.

Returns:

The updated options.