AdlsClient.EnumerateDeletedItemsAsync Method

Definition

Asynchronously gets the trash entries Caution: Undeleting files is a best effort operation. There are no guarantees that a file can be restored once it is deleted. The use of this API is enabled via whitelisting. If your ADL account is not whitelisted, then using this api will throw Not immplemented exception. For further information and assistance please contact Microsoft support.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.Azure.DataLake.Store.TrashEntry>> EnumerateDeletedItemsAsync (string hint, string listAfter, int numResults, IProgress<Microsoft.Azure.DataLake.Store.EnumerateDeletedItemsProgress> progressTracker, System.Threading.CancellationToken cancelToken);
abstract member EnumerateDeletedItemsAsync : string * string * int * IProgress<Microsoft.Azure.DataLake.Store.EnumerateDeletedItemsProgress> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Microsoft.Azure.DataLake.Store.TrashEntry>>
override this.EnumerateDeletedItemsAsync : string * string * int * IProgress<Microsoft.Azure.DataLake.Store.EnumerateDeletedItemsProgress> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Microsoft.Azure.DataLake.Store.TrashEntry>>
Public Overridable Function EnumerateDeletedItemsAsync (hint As String, listAfter As String, numResults As Integer, progressTracker As IProgress(Of EnumerateDeletedItemsProgress), cancelToken As CancellationToken) As Task(Of IEnumerable(Of TrashEntry))

Parameters

hint
System.String

String to match. Cannot be empty.

listAfter
System.String

Token returned by system in the previous API invocation

numResults
System.Int32

Search is executed until we find numResults or search completes. Maximum allowed value for this param is 4000. The number of returned entries could be more or less than numResults

progressTracker
System.IProgress<EnumerateDeletedItemsProgress>

Object to track progress of the task. Can be null

cancelToken
System.Threading.CancellationToken

CancellationToken to cancel the request

Returns

System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<TrashEntry>>

Applies to