FileSystemOperationsExtensions.OpenAsync Method

Definition

Opens and reads from the specified file.

public static System.Threading.Tasks.Task<System.IO.Stream> OpenAsync (this Microsoft.Azure.Management.DataLake.Store.IFileSystemOperations operations, string accountName, string directFilePath, long? length = default, long? offset = default, Guid? fileSessionId = default, System.Threading.CancellationToken cancellationToken = default);
public static System.Threading.Tasks.Task<System.IO.Stream> OpenAsync (this Microsoft.Azure.Management.DataLake.Store.IFileSystemOperations operations, string accountName, string path, long? length = default, long? offset = default, Guid? fileSessionId = default, System.Threading.CancellationToken cancellationToken = default);
static member OpenAsync : Microsoft.Azure.Management.DataLake.Store.IFileSystemOperations * string * string * Nullable<int64> * Nullable<int64> * Nullable<Guid> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>
static member OpenAsync : Microsoft.Azure.Management.DataLake.Store.IFileSystemOperations * string * string * Nullable<int64> * Nullable<int64> * Nullable<Guid> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>
<Extension()>
Public Function OpenAsync (operations As IFileSystemOperations, accountName As String, directFilePath As String, Optional length As Nullable(Of Long) = Nothing, Optional offset As Nullable(Of Long) = Nothing, Optional fileSessionId As Nullable(Of Guid) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Stream)
<Extension()>
Public Function OpenAsync (operations As IFileSystemOperations, accountName As String, path As String, Optional length As Nullable(Of Long) = Nothing, Optional offset As Nullable(Of Long) = Nothing, Optional fileSessionId As Nullable(Of Guid) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Stream)

Parameters

operations
IFileSystemOperations

The operations group for this extension method.

accountName
String

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

directFilePathpath
String

The Data Lake Store path (starting with '/') of the file to open.

length
Nullable<Int64>

The number of bytes that the server will attempt to retrieve. It will retrieve <= length bytes.

offset
Nullable<Int64>

The byte offset to start reading data from.

fileSessionId
Nullable<Guid>

Optional unique GUID per file indicating all the reads with the same fileSessionId are from the same client and same session. This will give a performance benefit.

cancellationToken
CancellationToken

The cancellation token.

Returns

Applies to