com.azure.storage.file.share.options

Class ShareBreakLeaseOptions

java.lang.Object

com.azure.storage.file.share.options.ShareBreakLeaseOptions

public class ShareBreakLeaseOptions
extends Object

Extended options that may be passed when breaking a lease to a file or share.

Constructor Summary

Constructors

Constructor and Description
ShareBreakLeaseOptions()

Method Summary

Modifier and Type	Method and Description
Duration	getBreakPeriod()
ShareBreakLeaseOptions	setBreakPeriod(Duration breakPeriod)

Methods inherited from class java.lang.Object

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

Constructor Detail

ShareBreakLeaseOptions

public ShareBreakLeaseOptions()

Method Detail

getBreakPeriod

public Duration getBreakPeriod()

Returns:

An optional duration, between 0 and 60 seconds, that the lease should continue before it is broken. If the break period is longer than the time remaining on the lease the remaining time on the lease is used. A new lease will not be available before the break period has expired, but the lease may be held for longer than the break period.

setBreakPeriod

public ShareBreakLeaseOptions setBreakPeriod(Duration breakPeriod)

Parameters:

breakPeriod - An optional duration, between 0 and 60 seconds, that the lease should continue before it is broken. If the break period is longer than the time remaining on the lease the remaining time on the lease is used. A new lease will not be available before the break period has expired, but the lease may be held for longer than the break period.

Returns:

The updated options.