IFileOperations.ListFromComputeNodeWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.Batch.Protocol

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.3.1

Source:

IFileOperations.cs

Lists all of the files in Task directories on the specified Compute Node.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Batch.Protocol.Models.NodeFile>,Microsoft.Azure.Batch.Protocol.Models.FileListFromComputeNodeHeaders>> ListFromComputeNodeWithHttpMessagesAsync (string poolId, string nodeId, bool? recursive = default, Microsoft.Azure.Batch.Protocol.Models.FileListFromComputeNodeOptions fileListFromComputeNodeOptions = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ListFromComputeNodeWithHttpMessagesAsync : string * string * Nullable<bool> * Microsoft.Azure.Batch.Protocol.Models.FileListFromComputeNodeOptions * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Batch.Protocol.Models.NodeFile>, Microsoft.Azure.Batch.Protocol.Models.FileListFromComputeNodeHeaders>>

Public Function ListFromComputeNodeWithHttpMessagesAsync (poolId As String, nodeId As String, Optional recursive As Nullable(Of Boolean) = Nothing, Optional fileListFromComputeNodeOptions As FileListFromComputeNodeOptions = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of IPage(Of NodeFile), FileListFromComputeNodeHeaders))

Parameters

poolId

String

The ID of the Pool that contains the Compute Node.

nodeId

String

The ID of the Compute Node whose files you want to list.

recursive

Nullable<Boolean>

Whether to list children of a directory.

fileListFromComputeNodeOptions

FileListFromComputeNodeOptions

Additional parameters for the operation

customHeaders

Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<IPage<NodeFile>,FileListFromComputeNodeHeaders>>

Exceptions

BatchErrorException

Thrown when the operation returned an invalid status code

SerializationException

Thrown when unable to deserialize the response

ValidationException

Thrown when a required parameter is null