DataLakePathClient.DeleteIfExistsAsync Method

Reference

Definition

Namespace:: Azure.Storage.Files.DataLake

Assembly:: Azure.Storage.Files.DataLake.dll

Package:: Azure.Storage.Files.DataLake v12.18.0

Package:: Azure.Storage.Files.DataLake v12.18.0-beta.2

Source:: DataLakePathClient.cs

Source:: DataLakePathClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The DeleteIfExistsAsync(Nullable<Boolean>, DataLakeRequestConditions, CancellationToken) operation marks the specified path deletion, if the path exists. The path is later deleted during garbage collection which could take several minutes.

For more information, see Delete Path.

public virtual System.Threading.Tasks.Task<Azure.Response<bool>> DeleteIfExistsAsync (bool? recursive = default, Azure.Storage.Files.DataLake.Models.DataLakeRequestConditions conditions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteIfExistsAsync : Nullable<bool> * Azure.Storage.Files.DataLake.Models.DataLakeRequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<bool>>
override this.DeleteIfExistsAsync : Nullable<bool> * Azure.Storage.Files.DataLake.Models.DataLakeRequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<bool>>

Public Overridable Function DeleteIfExistsAsync (Optional recursive As Nullable(Of Boolean) = Nothing, Optional conditions As DataLakeRequestConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of Boolean))

Parameters

recursive: Nullable<Boolean>

Required and valid only when the resource is a directory. If "true", all paths beneath the directory will be deleted. If "false" and the directory is non-empty, an error occurs.

conditions: DataLakeRequestConditions

Optional DataLakeRequestConditions to add conditions on deleting this path.

cancellationToken: CancellationToken

Optional CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Task<Response<Boolean>>

A Response on successfully marking for deletion.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to

Aracılığıyla paylaş