Package com.azure.storage.blob.options

Class BlobBreakLeaseOptions

java.lang.Object

com.azure.storage.blob.options.BlobBreakLeaseOptions

public class BlobBreakLeaseOptions
extends Object

Extended options that may be passed when breaking a lease to a blob or container.

Constructor Summary

Constructors

Constructor	Description
BlobBreakLeaseOptions()	Creates a new instance of BlobBreakLeaseOptions.

Method Summary

Modifier and Type	Method	Description
Duration	getBreakPeriod()	Gets the break period of the lease.
BlobLeaseRequestConditions	getRequestConditions()	Gets the BlobLeaseRequestConditions.
BlobBreakLeaseOptions	setBreakPeriod(Duration breakPeriod)	Sets the break period of the lease.
BlobBreakLeaseOptions	setRequestConditions(BlobLeaseRequestConditions requestConditions)	Sets the BlobLeaseRequestConditions.

Methods inherited from class java.lang.Object

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

Constructor Details

BlobBreakLeaseOptions

public BlobBreakLeaseOptions()

Creates a new instance of BlobBreakLeaseOptions.

Method Details

getBreakPeriod

public Duration getBreakPeriod()

Gets the break period of the lease.

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 BlobBreakLeaseOptions setBreakPeriod(Duration breakPeriod)

Sets the break period of the lease.

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.

getRequestConditions

public BlobLeaseRequestConditions getRequestConditions()

Gets the BlobLeaseRequestConditions.

Returns:

BlobLeaseRequestConditions

setRequestConditions

public BlobBreakLeaseOptions setRequestConditions(BlobLeaseRequestConditions requestConditions)

Sets the BlobLeaseRequestConditions.

Parameters:

requestConditions - BlobLeaseRequestConditions

Returns:

The updated options.