Share via


DataLakeFileSystemClient.GetPaths Method

Definition

The GetPathsAsync(DataLakeGetPathsOptions, CancellationToken) operation returns an async sequence of paths in this file system. 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.Pageable<Azure.Storage.Files.DataLake.Models.PathItem> GetPaths(Azure.Storage.Files.DataLake.Models.DataLakeGetPathsOptions options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetPaths : Azure.Storage.Files.DataLake.Models.DataLakeGetPathsOptions * System.Threading.CancellationToken -> Azure.Pageable<Azure.Storage.Files.DataLake.Models.PathItem>
override this.GetPaths : Azure.Storage.Files.DataLake.Models.DataLakeGetPathsOptions * System.Threading.CancellationToken -> Azure.Pageable<Azure.Storage.Files.DataLake.Models.PathItem>
Public Overridable Function GetPaths (Optional options As DataLakeGetPathsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(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 file system.

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