com.azure.storage.blob.options.BlobBreakLeaseOptions.yml

### YamlMime:JavaType
uid: "com.azure.storage.blob.options.BlobBreakLeaseOptions"
fullName: "com.azure.storage.blob.options.BlobBreakLeaseOptions"
name: "BlobBreakLeaseOptions"
nameWithType: "BlobBreakLeaseOptions"
summary: "Extended options that may be passed when breaking a lease to a blob or container."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public class **BlobBreakLeaseOptions**"
constructors:
- uid: "com.azure.storage.blob.options.BlobBreakLeaseOptions.BlobBreakLeaseOptions()"
  fullName: "com.azure.storage.blob.options.BlobBreakLeaseOptions.BlobBreakLeaseOptions()"
  name: "BlobBreakLeaseOptions()"
  nameWithType: "BlobBreakLeaseOptions.BlobBreakLeaseOptions()"
  syntax: "public BlobBreakLeaseOptions()"
methods:
- uid: "com.azure.storage.blob.options.BlobBreakLeaseOptions.getBreakPeriod()"
  fullName: "com.azure.storage.blob.options.BlobBreakLeaseOptions.getBreakPeriod()"
  name: "getBreakPeriod()"
  nameWithType: "BlobBreakLeaseOptions.getBreakPeriod()"
  syntax: "public Duration getBreakPeriod()"
  returns:
    description: "An optional duration, between 0 and 60 seconds, that the lease should continue before\n it is broken. If the break period is longer than the time remaining on the lease the remaining time on the lease\n is used. A new lease will not be available before the break period has expired, but the lease may be held for\n longer than the break period."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
- uid: "com.azure.storage.blob.options.BlobBreakLeaseOptions.getRequestConditions()"
  fullName: "com.azure.storage.blob.options.BlobBreakLeaseOptions.getRequestConditions()"
  name: "getRequestConditions()"
  nameWithType: "BlobBreakLeaseOptions.getRequestConditions()"
  syntax: "public BlobLeaseRequestConditions getRequestConditions()"
  returns:
    description: "<xref uid=\"com.azure.storage.blob.models.BlobLeaseRequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobLeaseRequestConditions\"></xref>"
    type: "<xref href=\"com.azure.storage.blob.models.BlobLeaseRequestConditions?alt=com.azure.storage.blob.models.BlobLeaseRequestConditions&text=BlobLeaseRequestConditions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.BlobBreakLeaseOptions.setBreakPeriod(java.time.Duration)"
  fullName: "com.azure.storage.blob.options.BlobBreakLeaseOptions.setBreakPeriod(Duration breakPeriod)"
  name: "setBreakPeriod(Duration breakPeriod)"
  nameWithType: "BlobBreakLeaseOptions.setBreakPeriod(Duration breakPeriod)"
  parameters:
  - description: "An optional duration, between 0 and 60 seconds, that the lease should continue before\n it is broken. If the break period is longer than the time remaining on the lease the remaining time on the lease\n is used. A new lease will not be available before the break period has expired, but the lease may be held for\n longer than the break period."
    name: "breakPeriod"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
  syntax: "public BlobBreakLeaseOptions setBreakPeriod(Duration breakPeriod)"
  returns:
    description: "The updated options."
    type: "<xref href=\"com.azure.storage.blob.options.BlobBreakLeaseOptions?alt=com.azure.storage.blob.options.BlobBreakLeaseOptions&text=BlobBreakLeaseOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.BlobBreakLeaseOptions.setRequestConditions(com.azure.storage.blob.models.BlobLeaseRequestConditions)"
  fullName: "com.azure.storage.blob.options.BlobBreakLeaseOptions.setRequestConditions(BlobLeaseRequestConditions requestConditions)"
  name: "setRequestConditions(BlobLeaseRequestConditions requestConditions)"
  nameWithType: "BlobBreakLeaseOptions.setRequestConditions(BlobLeaseRequestConditions requestConditions)"
  parameters:
  - description: "<xref uid=\"com.azure.storage.blob.models.BlobLeaseRequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobLeaseRequestConditions\"></xref>"
    name: "requestConditions"
    type: "<xref href=\"com.azure.storage.blob.models.BlobLeaseRequestConditions?alt=com.azure.storage.blob.models.BlobLeaseRequestConditions&text=BlobLeaseRequestConditions\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public BlobBreakLeaseOptions setRequestConditions(BlobLeaseRequestConditions requestConditions)"
  returns:
    description: "The updated options."
    type: "<xref href=\"com.azure.storage.blob.options.BlobBreakLeaseOptions?alt=com.azure.storage.blob.options.BlobBreakLeaseOptions&text=BlobBreakLeaseOptions\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Extended options that may be passed when breaking a lease to a blob or container."
metadata: {}
package: "com.azure.storage.blob.options"
artifact: com.azure:azure-storage-blob:12.26.1