IFileSystemOperations.OpenWithHttpMessagesAsync 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

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.

Opens and reads from the specified file.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<System.IO.Stream>> OpenWithHttpMessagesAsync (string accountName, string directFilePath, long? length = default, long? offset = default, Guid? fileSessionId = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<System.IO.Stream>> OpenWithHttpMessagesAsync (string accountName, string path, long? length = default, long? offset = default, Guid? fileSessionId = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member OpenWithHttpMessagesAsync : string * string * Nullable<int64> * Nullable<int64> * Nullable<Guid> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<System.IO.Stream>>

abstract member OpenWithHttpMessagesAsync : string * string * Nullable<int64> * Nullable<int64> * Nullable<Guid> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<System.IO.Stream>>

Public Function OpenWithHttpMessagesAsync (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 customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of Stream))

Public Function OpenWithHttpMessagesAsync (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 customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of Stream))

Parameters

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.