IFileOperations.ListFromTaskWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.Batch.Protocol

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.2.0

Source:

IFileOperations.cs

Lists the files in a Task's directory on its 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.FileListFromTaskHeaders>> ListFromTaskWithHttpMessagesAsync (string jobId, string taskId, bool? recursive = default, Microsoft.Azure.Batch.Protocol.Models.FileListFromTaskOptions fileListFromTaskOptions = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ListFromTaskWithHttpMessagesAsync : string * string * Nullable<bool> * Microsoft.Azure.Batch.Protocol.Models.FileListFromTaskOptions * 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.FileListFromTaskHeaders>>

Public Function ListFromTaskWithHttpMessagesAsync (jobId As String, taskId As String, Optional recursive As Nullable(Of Boolean) = Nothing, Optional fileListFromTaskOptions As FileListFromTaskOptions = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of IPage(Of NodeFile), FileListFromTaskHeaders))

Parameters

jobId

String

The ID of the Job that contains the Task.

taskId

String

The ID of the Task whose files you want to list.

recursive

Nullable<Boolean>

Whether to list children of the Task directory. This parameter can be used in combination with the filter parameter to list specific type of files.

fileListFromTaskOptions

FileListFromTaskOptions

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>,FileListFromTaskHeaders>>

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