Share via

ListPathsOptions interface

Package:
@azure/storage-file-datalake

An interface for options common to every remote operation.

Extends
CommonOptions

Properties

abortSignal
path
recursive
startFrom

Optional. A relative path within the specified directory where the listing will start from. For example, a recursive listing under directory folder1/folder2 with startFrom as folder3/readmefile.txt will start listing from folder1/folder2/folder3/readmefile.txt. Please note that, multiple entity levels are supported for recursive listing. Non-recursive listing supports only one entity level. An error will appear if multiple entity levels are specified for non-recursive listing.
userPrincipalName

Inherited Properties

tracingOptions

Property Details

abortSignal 

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

path 

path?: string

Property Value

string

recursive 

recursive?: boolean

Property Value

boolean

startFrom

Optional. A relative path within the specified directory where the listing will start from. For example, a recursive listing under directory folder1/folder2 with startFrom as folder3/readmefile.txt will start listing from folder1/folder2/folder3/readmefile.txt. Please note that, multiple entity levels are supported for recursive listing. Non-recursive listing supports only one entity level. An error will appear if multiple entity levels are specified for non-recursive listing.

startFrom?: string

Property Value

string

userPrincipalName 

userPrincipalName?: boolean

Property Value

boolean

Inherited Property Details

tracingOptions 

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From CommonOptions.tracingOptions