BatchClient.GetTaskFileProperties Method

Definition

[Protocol Method] Gets the properties of the specified Task file.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual Azure.Response<Azure.Compute.Batch.BatchFileProperties> GetTaskFileProperties (string jobId, string taskId, string filePath, int? timeOutInSeconds = default, DateTimeOffset? ocpdate = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetTaskFileProperties : string * string * string * Nullable<int> * Nullable<DateTimeOffset> * System.Threading.CancellationToken -> Azure.Response<Azure.Compute.Batch.BatchFileProperties>
override this.GetTaskFileProperties : string * string * string * Nullable<int> * Nullable<DateTimeOffset> * System.Threading.CancellationToken -> Azure.Response<Azure.Compute.Batch.BatchFileProperties>
Public Overridable Function GetTaskFileProperties (jobId As String, taskId As String, filePath As String, Optional timeOutInSeconds As Nullable(Of Integer) = Nothing, Optional ocpdate As Nullable(Of DateTimeOffset) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of BatchFileProperties)

Parameters

jobId
String

The ID of the Job that contains the Task.

taskId
String

The ID of the Task whose file you want to retrieve.

filePath
String

The path to the Task file that you want to get the content of.

timeOutInSeconds
Nullable<Int32>

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".

ocpdate
Nullable<DateTimeOffset>

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

The response returned from the service.

Exceptions

jobId, taskId or filePath is null.

jobId, taskId or filePath is an empty string, and was expected to be non-empty.

Service returned a non-success status code.

Applies to