224 строки
25 KiB
YAML
224 строки
25 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.storage.file.datalake.specialized.DataLakeLeaseClient"
|
|
fullName: "com.azure.storage.file.datalake.specialized.DataLakeLeaseClient"
|
|
name: "DataLakeLeaseClient"
|
|
nameWithType: "DataLakeLeaseClient"
|
|
summary: "This class provides a client that contains all the leasing operations for <xref uid=\"com.azure.storage.file.datalake.DataLakeFileSystemClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"file systems\"></xref> and <xref uid=\"com.azure.storage.file.datalake.DataLakePathClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"files and directories\"></xref>."
|
|
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 final class **DataLakeLeaseClient**"
|
|
methods:
|
|
- uid: "com.azure.storage.file.datalake.specialized.DataLakeLeaseClient.acquireLease(int)"
|
|
fullName: "com.azure.storage.file.datalake.specialized.DataLakeLeaseClient.acquireLease(int durationInSeconds)"
|
|
name: "acquireLease(int durationInSeconds)"
|
|
nameWithType: "DataLakeLeaseClient.acquireLease(int durationInSeconds)"
|
|
summary: "Acquires a lease for write and delete operations."
|
|
parameters:
|
|
- description: "The duration of the lease between 15 and 60 seconds or -1 for an infinite duration."
|
|
name: "durationInSeconds"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public String acquireLease(int durationInSeconds)"
|
|
desc: "Acquires a lease for write and delete operations. The lease duration must be between 15 to 60 seconds or -1 for an infinite duration.\n\n**Code Samples**\n\n```java\nSystem.out.printf(\"Lease ID is %s%n\", client.acquireLease(60));\n```"
|
|
returns:
|
|
description: "The lease ID."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.file.datalake.specialized.DataLakeLeaseClient.acquireLeaseWithResponse(int,com.azure.core.http.RequestConditions,java.time.Duration,com.azure.core.util.Context)"
|
|
fullName: "com.azure.storage.file.datalake.specialized.DataLakeLeaseClient.acquireLeaseWithResponse(int durationInSeconds, RequestConditions modifiedRequestConditions, Duration timeout, Context context)"
|
|
name: "acquireLeaseWithResponse(int durationInSeconds, RequestConditions modifiedRequestConditions, Duration timeout, Context context)"
|
|
nameWithType: "DataLakeLeaseClient.acquireLeaseWithResponse(int durationInSeconds, RequestConditions modifiedRequestConditions, Duration timeout, Context context)"
|
|
summary: "Acquires a lease for write and delete operations."
|
|
parameters:
|
|
- description: "The duration of the lease between 15 and 60 seconds or -1 for an infinite duration."
|
|
name: "durationInSeconds"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Standard HTTP Access conditions related to the modification of data. ETag and\n LastModifiedTime are used to construct conditions related to when the resource was changed relative to the given\n request. The request will fail if the specified condition is not satisfied."
|
|
name: "modifiedRequestConditions"
|
|
type: "<xref href=\"com.azure.core.http.RequestConditions?alt=com.azure.core.http.RequestConditions&text=RequestConditions\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "An optional timeout value beyond which a <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RuntimeException\"></xref> will be raised."
|
|
name: "timeout"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- description: "Additional context that is passed through the Http pipeline during the service call."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<String> acquireLeaseWithResponse(int durationInSeconds, RequestConditions modifiedRequestConditions, Duration timeout, Context context)"
|
|
desc: "Acquires a lease for write and delete operations. The lease duration must be between 15 and 60 seconds or -1 for an infinite duration.\n\n**Code Samples**\n\n```java\n// Optional HTTP request conditions that can be used to narrow the scope of the request.\n // The request conditions can be used to have the leasing request only succeed if the resource has been\n // modified and/or unmodified within a certain time frame and/or matches and/or doesn't match a specific ETag,\n // or any ETag.\n RequestConditions modifiedRequestConditions = yourOptionalRequestConditions;\n\n System.out.printf(\"Lease ID is %s%n\", client\n .acquireLeaseWithResponse(60, modifiedRequestConditions, timeout, new Context(key, value))\n .getValue());\n```"
|
|
returns:
|
|
description: "The lease ID."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- uid: "com.azure.storage.file.datalake.specialized.DataLakeLeaseClient.breakLease()"
|
|
fullName: "com.azure.storage.file.datalake.specialized.DataLakeLeaseClient.breakLease()"
|
|
name: "breakLease()"
|
|
nameWithType: "DataLakeLeaseClient.breakLease()"
|
|
summary: "Breaks the previously acquired lease, if it exists."
|
|
syntax: "public Integer breakLease()"
|
|
desc: "Breaks the previously acquired lease, if it exists.\n\n**Code Samples**\n\n```java\nSystem.out.printf(\"The broken lease has %d seconds remaining on the lease\", client.breakLease());\n```"
|
|
returns:
|
|
description: "The remaining time in the broken lease in seconds."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.storage.file.datalake.specialized.DataLakeLeaseClient.breakLeaseWithResponse(java.lang.Integer,com.azure.core.http.RequestConditions,java.time.Duration,com.azure.core.util.Context)"
|
|
fullName: "com.azure.storage.file.datalake.specialized.DataLakeLeaseClient.breakLeaseWithResponse(Integer breakPeriodInSeconds, RequestConditions modifiedRequestConditions, Duration timeout, Context context)"
|
|
name: "breakLeaseWithResponse(Integer breakPeriodInSeconds, RequestConditions modifiedRequestConditions, Duration timeout, Context context)"
|
|
nameWithType: "DataLakeLeaseClient.breakLeaseWithResponse(Integer breakPeriodInSeconds, RequestConditions modifiedRequestConditions, Duration timeout, Context context)"
|
|
summary: "Breaks the previously acquired lease, if it exists."
|
|
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: "breakPeriodInSeconds"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- description: "Standard HTTP Access conditions related to the modification of data. ETag and\n LastModifiedTime are used to construct conditions related to when the resource was changed relative to the given\n request. The request will fail if the specified condition is not satisfied."
|
|
name: "modifiedRequestConditions"
|
|
type: "<xref href=\"com.azure.core.http.RequestConditions?alt=com.azure.core.http.RequestConditions&text=RequestConditions\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "An optional timeout value beyond which a <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RuntimeException\"></xref> will be raised."
|
|
name: "timeout"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- description: "Additional context that is passed through the Http pipeline during the service call."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<Integer> breakLeaseWithResponse(Integer breakPeriodInSeconds, RequestConditions modifiedRequestConditions, Duration timeout, Context context)"
|
|
desc: "Breaks the previously acquired lease, if it exists.\n\nIf `null` is passed for `breakPeriodInSeconds` a fixed duration lease will break after the remaining lease period elapses and an infinite lease will break immediately.\n\n**Code Samples**\n\n```java\nInteger retainLeaseInSeconds = 5;\n // Optional HTTP request conditions that can be used to narrow the scope of the request.\n // The request conditions can be used to have the leasing request only succeed if the resource has been\n // modified and/or unmodified within a certain time frame and/or matches and/or doesn't match a specific ETag,\n // or any ETag.\n RequestConditions modifiedRequestConditions = yourOptionalRequestConditions;\n\n System.out.printf(\"The broken lease has %d seconds remaining on the lease\", client\n .breakLeaseWithResponse(retainLeaseInSeconds, modifiedRequestConditions, timeout, new Context(key, value))\n .getValue());\n```"
|
|
returns:
|
|
description: "The remaining time in the broken lease in seconds."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>>"
|
|
- uid: "com.azure.storage.file.datalake.specialized.DataLakeLeaseClient.changeLease(java.lang.String)"
|
|
fullName: "com.azure.storage.file.datalake.specialized.DataLakeLeaseClient.changeLease(String proposedId)"
|
|
name: "changeLease(String proposedId)"
|
|
nameWithType: "DataLakeLeaseClient.changeLease(String proposedId)"
|
|
summary: "Changes the lease ID."
|
|
parameters:
|
|
- description: "A new lease ID in a valid GUID format."
|
|
name: "proposedId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public String changeLease(String proposedId)"
|
|
desc: "Changes the lease ID.\n\n**Code Samples**\n\n```java\nSystem.out.printf(\"Changed lease ID is %s%n\", client.changeLease(\"proposedId\"));\n```"
|
|
returns:
|
|
description: "The new lease ID."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.file.datalake.specialized.DataLakeLeaseClient.changeLeaseWithResponse(java.lang.String,com.azure.core.http.RequestConditions,java.time.Duration,com.azure.core.util.Context)"
|
|
fullName: "com.azure.storage.file.datalake.specialized.DataLakeLeaseClient.changeLeaseWithResponse(String proposedId, RequestConditions modifiedRequestConditions, Duration timeout, Context context)"
|
|
name: "changeLeaseWithResponse(String proposedId, RequestConditions modifiedRequestConditions, Duration timeout, Context context)"
|
|
nameWithType: "DataLakeLeaseClient.changeLeaseWithResponse(String proposedId, RequestConditions modifiedRequestConditions, Duration timeout, Context context)"
|
|
summary: "Changes the lease ID."
|
|
parameters:
|
|
- description: "A new lease ID in a valid GUID format."
|
|
name: "proposedId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Standard HTTP Access conditions related to the modification of data. ETag and\n LastModifiedTime are used to construct conditions related to when the resource was changed relative to the given\n request. The request will fail if the specified condition is not satisfied."
|
|
name: "modifiedRequestConditions"
|
|
type: "<xref href=\"com.azure.core.http.RequestConditions?alt=com.azure.core.http.RequestConditions&text=RequestConditions\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "An optional timeout value beyond which a <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RuntimeException\"></xref> will be raised."
|
|
name: "timeout"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- description: "Additional context that is passed through the Http pipeline during the service call."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<String> changeLeaseWithResponse(String proposedId, RequestConditions modifiedRequestConditions, Duration timeout, Context context)"
|
|
desc: "Changes the lease ID.\n\n**Code Samples**\n\n```java\n// Optional HTTP request conditions that can be used to narrow the scope of the request.\n // The request conditions can be used to have the leasing request only succeed if the resource has been\n // modified and/or unmodified within a certain time frame and/or matches and/or doesn't match a specific ETag,\n // or any ETag.\n RequestConditions modifiedRequestConditions = yourOptionalRequestConditions;\n\n System.out.printf(\"Changed lease ID is %s%n\",\n client.changeLeaseWithResponse(\"proposedId\", modifiedRequestConditions, timeout, new Context(key, value))\n .getValue());\n```"
|
|
returns:
|
|
description: "The new lease ID."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- uid: "com.azure.storage.file.datalake.specialized.DataLakeLeaseClient.getAccountName()"
|
|
fullName: "com.azure.storage.file.datalake.specialized.DataLakeLeaseClient.getAccountName()"
|
|
name: "getAccountName()"
|
|
nameWithType: "DataLakeLeaseClient.getAccountName()"
|
|
summary: "Get associated account name."
|
|
syntax: "public String getAccountName()"
|
|
desc: "Get associated account name."
|
|
returns:
|
|
description: "account name associated with this storage resource."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.file.datalake.specialized.DataLakeLeaseClient.getLeaseId()"
|
|
fullName: "com.azure.storage.file.datalake.specialized.DataLakeLeaseClient.getLeaseId()"
|
|
name: "getLeaseId()"
|
|
nameWithType: "DataLakeLeaseClient.getLeaseId()"
|
|
summary: "Get the lease ID for this lease."
|
|
syntax: "public String getLeaseId()"
|
|
desc: "Get the lease ID for this lease."
|
|
returns:
|
|
description: "the lease ID."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.file.datalake.specialized.DataLakeLeaseClient.getResourceUrl()"
|
|
fullName: "com.azure.storage.file.datalake.specialized.DataLakeLeaseClient.getResourceUrl()"
|
|
name: "getResourceUrl()"
|
|
nameWithType: "DataLakeLeaseClient.getResourceUrl()"
|
|
summary: "Gets the <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"URL\"></xref> of the lease client."
|
|
syntax: "public String getResourceUrl()"
|
|
desc: "Gets the <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"URL\"></xref> of the lease client.\n\nThe lease will either be a file system or path URL depending on which the lease client is associated."
|
|
returns:
|
|
description: "URL of the lease client."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.file.datalake.specialized.DataLakeLeaseClient.releaseLease()"
|
|
fullName: "com.azure.storage.file.datalake.specialized.DataLakeLeaseClient.releaseLease()"
|
|
name: "releaseLease()"
|
|
nameWithType: "DataLakeLeaseClient.releaseLease()"
|
|
summary: "Releases the previously acquired lease."
|
|
syntax: "public void releaseLease()"
|
|
desc: "Releases the previously acquired lease.\n\n**Code Samples**\n\n```java\nclient.releaseLease();\n System.out.println(\"Release lease completed\");\n```"
|
|
- uid: "com.azure.storage.file.datalake.specialized.DataLakeLeaseClient.releaseLeaseWithResponse(com.azure.core.http.RequestConditions,java.time.Duration,com.azure.core.util.Context)"
|
|
fullName: "com.azure.storage.file.datalake.specialized.DataLakeLeaseClient.releaseLeaseWithResponse(RequestConditions modifiedRequestConditions, Duration timeout, Context context)"
|
|
name: "releaseLeaseWithResponse(RequestConditions modifiedRequestConditions, Duration timeout, Context context)"
|
|
nameWithType: "DataLakeLeaseClient.releaseLeaseWithResponse(RequestConditions modifiedRequestConditions, Duration timeout, Context context)"
|
|
summary: "Releases the previously acquired lease."
|
|
parameters:
|
|
- description: "Standard HTTP Access conditions related to the modification of data. ETag and\n LastModifiedTime are used to construct conditions related to when the resource was changed relative to the given\n request. The request will fail if the specified condition is not satisfied."
|
|
name: "modifiedRequestConditions"
|
|
type: "<xref href=\"com.azure.core.http.RequestConditions?alt=com.azure.core.http.RequestConditions&text=RequestConditions\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "An optional timeout value beyond which a <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RuntimeException\"></xref> will be raised."
|
|
name: "timeout"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- description: "Additional context that is passed through the Http pipeline during the service call."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<Void> releaseLeaseWithResponse(RequestConditions modifiedRequestConditions, Duration timeout, Context context)"
|
|
desc: "Releases the previously acquired lease.\n\n**Code Samples**\n\n```java\n// Optional HTTP request conditions that can be used to narrow the scope of the request.\n // The request conditions can be used to have the leasing request only succeed if the resource has been\n // modified and/or unmodified within a certain time frame and/or matches and/or doesn't match a specific ETag,\n // or any ETag.\n RequestConditions modifiedRequestConditions = yourOptionalRequestConditions;\n\n System.out.printf(\"Release lease completed with status %d%n\",\n client.releaseLeaseWithResponse(modifiedRequestConditions, timeout, new Context(key, value))\n .getStatusCode());\n```"
|
|
returns:
|
|
description: "A response containing status code and HTTP headers."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.storage.file.datalake.specialized.DataLakeLeaseClient.renewLease()"
|
|
fullName: "com.azure.storage.file.datalake.specialized.DataLakeLeaseClient.renewLease()"
|
|
name: "renewLease()"
|
|
nameWithType: "DataLakeLeaseClient.renewLease()"
|
|
summary: "Renews the previously acquired lease."
|
|
syntax: "public String renewLease()"
|
|
desc: "Renews the previously acquired lease.\n\n**Code Samples**\n\n```java\nSystem.out.printf(\"Renewed lease ID is %s%n\", client.renewLease());\n```"
|
|
returns:
|
|
description: "The renewed lease ID."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.file.datalake.specialized.DataLakeLeaseClient.renewLeaseWithResponse(com.azure.core.http.RequestConditions,java.time.Duration,com.azure.core.util.Context)"
|
|
fullName: "com.azure.storage.file.datalake.specialized.DataLakeLeaseClient.renewLeaseWithResponse(RequestConditions modifiedRequestConditions, Duration timeout, Context context)"
|
|
name: "renewLeaseWithResponse(RequestConditions modifiedRequestConditions, Duration timeout, Context context)"
|
|
nameWithType: "DataLakeLeaseClient.renewLeaseWithResponse(RequestConditions modifiedRequestConditions, Duration timeout, Context context)"
|
|
summary: "Renews the previously-acquired lease."
|
|
parameters:
|
|
- description: "Standard HTTP Access conditions related to the modification of data. ETag and\n LastModifiedTime are used to construct conditions related to when the resource was changed relative to the given\n request. The request will fail if the specified condition is not satisfied."
|
|
name: "modifiedRequestConditions"
|
|
type: "<xref href=\"com.azure.core.http.RequestConditions?alt=com.azure.core.http.RequestConditions&text=RequestConditions\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "An optional timeout value beyond which a <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RuntimeException\"></xref> will be raised."
|
|
name: "timeout"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- description: "Additional context that is passed through the Http pipeline during the service call."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<String> renewLeaseWithResponse(RequestConditions modifiedRequestConditions, Duration timeout, Context context)"
|
|
desc: "Renews the previously-acquired lease.\n\n**Code Samples**\n\n```java\n// Optional HTTP request conditions that can be used to narrow the scope of the request.\n // The request conditions can be used to have the leasing request only succeed if the resource has been\n // modified and/or unmodified within a certain time frame and/or matches and/or doesn't match a specific ETag,\n // or any ETag.\n RequestConditions modifiedRequestConditions = yourOptionalRequestConditions;\n\n System.out.printf(\"Renewed lease ID is %s%n\",\n client.renewLeaseWithResponse(modifiedRequestConditions, timeout, new Context(key, value))\n .getValue());\n```"
|
|
returns:
|
|
description: "The renewed lease ID."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
type: "class"
|
|
desc: "This class provides a client that contains all the leasing operations for <xref uid=\"com.azure.storage.file.datalake.DataLakeFileSystemClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"file systems\"></xref> and <xref uid=\"com.azure.storage.file.datalake.DataLakePathClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"files and directories\"></xref>. This client acts as a supplement to those clients and only handles leasing operations.\n\n**Instantiating a DataLakeLeaseClient**\n\n```java\nDataLakeLeaseClient dataLakeLeaseClient = new DataLakeLeaseClientBuilder()\n .fileClient(fileClient)\n .buildClient();\n```\n\n```java\nDataLakeLeaseClient dataLakeLeaseClient = new DataLakeLeaseClientBuilder()\n .directoryClient(directoryClient)\n .buildClient();\n```\n\n```java\nDataLakeLeaseClient dataLakeLeaseClient = new DataLakeLeaseClientBuilder()\n .fileSystemClient(dataLakeFileSystemClient)\n .buildClient();\n```\n\nView <xref uid=\"com.azure.storage.file.datalake.specialized.DataLakeLeaseClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"this\"></xref> for additional ways to construct the client.\n\nFor more information about leasing see the [file system leasing][] or [path leasing][] documentation.\n\n\n[file system leasing]: https://docs.microsoft.com/rest/api/storageservices/lease-container\n[path leasing]: https://docs.microsoft.com/rest/api/storageservices/lease-blob"
|
|
metadata: {}
|
|
package: "com.azure.storage.file.datalake.specialized"
|
|
artifact: com.azure:azure-storage-file-datalake:12.21.0
|