Share via

BlobBreakLeaseOptions Class

  • Reference
Package:
com.azure.storage.blob.options
Maven Artifact:
com.azure:azure-storage-blob:12.28.1
  • java.lang.Object
    • com.azure.storage.blob.options.BlobBreakLeaseOptions

public class BlobBreakLeaseOptions

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

Constructor Summary

Constructor Description
BlobBreakLeaseOptions()

Method Summary

Modifier and Type Method and Description
Duration getBreakPeriod()
BlobLeaseRequestConditions getRequestConditions()
BlobBreakLeaseOptions setBreakPeriod(Duration breakPeriod)
BlobBreakLeaseOptions setRequestConditions(BlobLeaseRequestConditions requestConditions)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

BlobBreakLeaseOptions

public BlobBreakLeaseOptions()

Method Details

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.

getRequestConditions

public BlobLeaseRequestConditions getRequestConditions()

Returns:

setBreakPeriod

public BlobBreakLeaseOptions 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.

setRequestConditions

public BlobBreakLeaseOptions setRequestConditions(BlobLeaseRequestConditions requestConditions)

Parameters:

requestConditions - BlobLeaseRequestConditions

Returns:

The updated options.

Applies to