Share via

FileSystemOperationsExtensions.ListFileStatusAsync Method

  • Reference

Definition

Namespace:
Microsoft.Azure.Management.DataLake.Store
Assembly:
Microsoft.Azure.Management.DataLake.Store.dll
Package:
Microsoft.Azure.Management.DataLake.Store v2.2.1
Package:
Microsoft.Azure.Management.DataLake.Store v2.4.2-preview

Get the list of file status objects specified by the file path, with optional pagination parameters

public static System.Threading.Tasks.Task<Microsoft.Azure.Management.DataLake.Store.Models.FileStatusesResult> ListFileStatusAsync (this Microsoft.Azure.Management.DataLake.Store.IFileSystemOperations operations, string accountName, string listFilePath, int? listSize = default, string listAfter = default, string listBefore = default, bool? tooId = default, System.Threading.CancellationToken cancellationToken = default);
public static System.Threading.Tasks.Task<Microsoft.Azure.Management.DataLake.Store.Models.FileStatusesResult> ListFileStatusAsync (this Microsoft.Azure.Management.DataLake.Store.IFileSystemOperations operations, string accountName, string path, int? listSize = default, string listAfter = default, string listBefore = default, bool? tooId = default, System.Threading.CancellationToken cancellationToken = default);
static member ListFileStatusAsync : Microsoft.Azure.Management.DataLake.Store.IFileSystemOperations * string * string * Nullable<int> * string * string * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Management.DataLake.Store.Models.FileStatusesResult>
static member ListFileStatusAsync : Microsoft.Azure.Management.DataLake.Store.IFileSystemOperations * string * string * Nullable<int> * string * string * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Management.DataLake.Store.Models.FileStatusesResult>
<Extension()>
Public Function ListFileStatusAsync (operations As IFileSystemOperations, accountName As String, listFilePath As String, Optional listSize As Nullable(Of Integer) = Nothing, Optional listAfter As String = Nothing, Optional listBefore As String = Nothing, Optional tooId As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of FileStatusesResult)
<Extension()>
Public Function ListFileStatusAsync (operations As IFileSystemOperations, accountName As String, path As String, Optional listSize As Nullable(Of Integer) = Nothing, Optional listAfter As String = Nothing, Optional listBefore As String = Nothing, Optional tooId As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of FileStatusesResult)

Parameters

operations
IFileSystemOperations

The operations group for this extension method.

accountName
String

The Azure Data Lake Store account to execute filesystem operations on.

listFilePathpath
String

The Data Lake Store path (starting with '/') of the directory to list.

listSize
Nullable<Int32>

Gets or sets the number of items to return. Optional.

listAfter
String

Gets or sets the item or lexographical index after which to begin returning results. For example, a file list of 'a','b','d' and listAfter='b' will return 'd', and a listAfter='c' will also return 'd'. Optional.

listBefore
String

Gets or sets the item or lexographical index before which to begin returning results. For example, a file list of 'a','b','d' and listBefore='d' will return 'a','b', and a listBefore='c' will also return 'a','b'. Optional.

tooId
Nullable<Boolean>

An optional switch to return friendly names in place of owner and group. tooid=false returns friendly names instead of the AAD Object ID. Default value is true, returning AAD object IDs.

cancellationToken
CancellationToken

The cancellation token.

Returns

Task<FileStatusesResult>

Applies to