Share via


DataLakeDirectoryClient.GetPathsAsync Method

Definition

The GetPathsAsync(DataLakeGetPathsOptions, CancellationToken) operation returns an async sequence of paths in this directory. Enumerating the paths may make multiple requests to the service while fetching all the values.

For more information, see List Path(s).

public virtual Azure.AsyncPageable<Azure.Storage.Files.DataLake.Models.PathItem> GetPathsAsync(Azure.Storage.Files.DataLake.Models.DataLakeGetPathsOptions options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetPathsAsync : Azure.Storage.Files.DataLake.Models.DataLakeGetPathsOptions * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Storage.Files.DataLake.Models.PathItem>
override this.GetPathsAsync : Azure.Storage.Files.DataLake.Models.DataLakeGetPathsOptions * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Storage.Files.DataLake.Models.PathItem>
Public Overridable Function GetPathsAsync (Optional options As DataLakeGetPathsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of PathItem)

Parameters

options
DataLakeGetPathsOptions

Optional parameters.

cancellationToken
CancellationToken

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

Returns

An Pageable<T> describing the paths in the directory.

Remarks

A RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an AggregateException will be thrown, containing each failure instance.

Applies to