ComputeBatchModelFactory.BatchJobStatistics Method

Definition

Namespace:

Azure.Compute.Batch

Assembly:

Azure.Compute.Batch.dll

Package:

Azure.Compute.Batch v1.0.0-beta.1

Source:

ComputeBatchModelFactory.cs

Initializes a new instance of BatchJobStatistics.

public static Azure.Compute.Batch.BatchJobStatistics BatchJobStatistics (string url = default, DateTimeOffset startTime = default, DateTimeOffset lastUpdateTime = default, TimeSpan userCpuTime = default, TimeSpan kernelCpuTime = default, TimeSpan wallClockTime = default, long readIOps = 0, long writeIOps = 0, float readIOGiB = 0, float writeIOGiB = 0, long numSucceededTasks = 0, long numFailedTasks = 0, long numTaskRetries = 0, TimeSpan waitTime = default);

static member BatchJobStatistics : string * DateTimeOffset * DateTimeOffset * TimeSpan * TimeSpan * TimeSpan * int64 * int64 * single * single * int64 * int64 * int64 * TimeSpan -> Azure.Compute.Batch.BatchJobStatistics

Public Shared Function BatchJobStatistics (Optional url As String = Nothing, Optional startTime As DateTimeOffset = Nothing, Optional lastUpdateTime As DateTimeOffset = Nothing, Optional userCpuTime As TimeSpan = Nothing, Optional kernelCpuTime As TimeSpan = Nothing, Optional wallClockTime As TimeSpan = Nothing, Optional readIOps As Long = 0, Optional writeIOps As Long = 0, Optional readIOGiB As Single = 0, Optional writeIOGiB As Single = 0, Optional numSucceededTasks As Long = 0, Optional numFailedTasks As Long = 0, Optional numTaskRetries As Long = 0, Optional waitTime As TimeSpan = Nothing) As BatchJobStatistics

Parameters

url

String

The URL of the statistics.

startTime

DateTimeOffset

The start time of the time range covered by the statistics.

lastUpdateTime

DateTimeOffset

The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime.

userCpuTime

TimeSpan

The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job.

kernelCpuTime

TimeSpan

The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job.

wallClockTime

TimeSpan

The total wall clock time of all Tasks in the Job. The wall clock time is the elapsed time from when the Task started running on a Compute Node to when it finished (or to the last time the statistics were updated, if the Task had not finished by then). If a Task was retried, this includes the wall clock time of all the Task retries.

readIOps

Int64

The total number of disk read operations made by all Tasks in the Job.

writeIOps

Int64

The total number of disk write operations made by all Tasks in the Job.

readIOGiB

Single

The total amount of data in GiB read from disk by all Tasks in the Job.

writeIOGiB

Single

The total amount of data in GiB written to disk by all Tasks in the Job.

numSucceededTasks

Int64

The total number of Tasks successfully completed in the Job during the given time range. A Task completes successfully if it returns exit code 0.

numFailedTasks

Int64

The total number of Tasks in the Job that failed during the given time range. A Task fails if it exhausts its maximum retry count without returning exit code 0.

numTaskRetries

Int64

The total number of retries on all the Tasks in the Job during the given time range.

waitTime

TimeSpan

The total wait time of all Tasks in the Job. The wait time for a Task is defined as the elapsed time between the creation of the Task and the start of Task execution. (If the Task is retried due to failures, the wait time is the time to the most recent Task execution.) This value is only reported in the Account lifetime statistics; it is not included in the Job statistics.

Returns

BatchJobStatistics

A new BatchJobStatistics instance for mocking.