BatchJobStatistics Class

Package:

com.azure.compute.batch.models

Maven Artifact:

com.azure:azure-compute-batch:1.0.0-beta.5

• java.lang.Object
• • com.azure.compute.batch.models.BatchJobStatistics

Implements

JsonSerializable<BatchJobStatistics>

public final class BatchJobStatistics
implements JsonSerializable<BatchJobStatistics>

Resource usage statistics for a Job.

Method Summary

Modifier and Type	Method and Description
static BatchJobStatistics	fromJson(JsonReader jsonReader) Reads an instance of BatchJobStatistics from the JsonReader.
long	getFailedTasksCount() Get the failedTasksCount property: The total number of Tasks in the Job that failed during the given time range.
Duration	getKernelCpuTime() Get the kernelCpuTime property: The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job.
OffsetDateTime	getLastUpdateTime() Get the lastUpdateTime property: The time at which the statistics were last updated.
double	getReadIoGiB() Get the readIoGiB property: The total amount of data in GiB read from disk by all Tasks in the Job.
long	getReadIops() Get the readIops property: The total number of disk read operations made by all Tasks in the Job.
OffsetDateTime	getStartTime() Get the startTime property: The start time of the time range covered by the statistics.
long	getSucceededTasksCount() Get the succeededTasksCount property: The total number of Tasks successfully completed in the Job during the given time range.
long	getTaskRetriesCount() Get the taskRetriesCount property: The total number of retries on all the Tasks in the Job during the given time range.
String	getUrl() Get the url property: The URL of the statistics.
Duration	getUserCpuTime() Get the userCpuTime property: The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job.
Duration	getWaitTime() Get the waitTime property: The total wait time of all Tasks in the Job.
Duration	getWallClockTime() Get the wallClockTime property: The total wall clock time of all Tasks in the Job.
double	getWriteIoGiB() Get the writeIoGiB property: The total amount of data in GiB written to disk by all Tasks in the Job.
long	getWriteIops() Get the writeIops property: The total number of disk write operations made by all Tasks in the Job.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static BatchJobStatistics fromJson(JsonReader jsonReader)

Reads an instance of BatchJobStatistics from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of BatchJobStatistics if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

getFailedTasksCount

public long getFailedTasksCount()

Get the failedTasksCount property: 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.

Returns:

the failedTasksCount value.

getKernelCpuTime

public Duration getKernelCpuTime()

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

Returns:

the kernelCpuTime value.

getLastUpdateTime

public OffsetDateTime getLastUpdateTime()

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

Returns:

the lastUpdateTime value.

getReadIoGiB

public double getReadIoGiB()

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

Returns:

the readIoGiB value.

getReadIops

public long getReadIops()

Get the readIops property: The total number of disk read operations made by all Tasks in the Job.

Returns:

the readIops value.

getStartTime

public OffsetDateTime getStartTime()

Get the startTime property: The start time of the time range covered by the statistics.

Returns:

the startTime value.

getSucceededTasksCount

public long getSucceededTasksCount()

Get the succeededTasksCount property: 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.

Returns:

the succeededTasksCount value.

getTaskRetriesCount

public long getTaskRetriesCount()

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

Returns:

the taskRetriesCount value.

getUrl

public String getUrl()

Get the url property: The URL of the statistics.

Returns:

the url value.

getUserCpuTime

public Duration getUserCpuTime()

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

Returns:

the userCpuTime value.

getWaitTime

public Duration getWaitTime()

Get the waitTime property: 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:

the waitTime value.

getWallClockTime

public Duration getWallClockTime()

Get the wallClockTime property: 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.

Returns:

the wallClockTime value.

getWriteIoGiB

public double getWriteIoGiB()

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

Returns:

the writeIoGiB value.

getWriteIops

public long getWriteIops()

Get the writeIops property: The total number of disk write operations made by all Tasks in the Job.

Returns:

the writeIops value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException