DataLakeDirectoryClient.GetPaths(Boolean, Boolean, CancellationToken) 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:: DataLakeDirectoryClient.cs

Source:: DataLakeDirectoryClient.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 GetPaths(Boolean, Boolean, 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.Pageable<Azure.Storage.Files.DataLake.Models.PathItem> GetPaths (bool recursive = false, bool userPrincipalName = false, System.Threading.CancellationToken cancellationToken = default);

abstract member GetPaths : bool * bool * System.Threading.CancellationToken -> Azure.Pageable<Azure.Storage.Files.DataLake.Models.PathItem>
override this.GetPaths : bool * bool * System.Threading.CancellationToken -> Azure.Pageable<Azure.Storage.Files.DataLake.Models.PathItem>

Public Overridable Function GetPaths (Optional recursive As Boolean = false, Optional userPrincipalName As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of PathItem)

Parameters

recursive: Boolean

If "true", all paths are listed; otherwise, only paths at the root of the filesystem are listed.

userPrincipalName: Boolean

Optional. Valid only when Hierarchical Namespace is enabled for the account. If "true", the user identity values returned in the owner and group fields of each list entry will be transformed from Azure Active Directory Object IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do not have unique friendly names.

cancellationToken: CancellationToken

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

Returns

Pageable<PathItem>

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

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to

Share via