JobStatistics Class

  • Reference
Package:
com.microsoft.azure.batch.protocol.models
Maven Artifact:
com.microsoft.azure:azure-batch:11.2.0
  • java.lang.Object
    • com.microsoft.azure.batch.protocol.models.JobStatistics

public class JobStatistics

Resource usage statistics for a Job.

Constructor Summary

Constructor Description
JobStatistics()

Method Summary

Modifier and Type Method and Description
org.joda.time.Period kernelCPUTime()

Get the kernelCPUTime value.
org.joda.time.DateTime lastUpdateTime()

Get the lastUpdateTime value.
long numFailedTasks()

Get a Task fails if it exhausts its maximum retry count without returning exit code 0.
long numSucceededTasks()

Get a Task completes successfully if it returns exit code 0.
long numTaskRetries()

Get the numTaskRetries value.
double readIOGiB()

Get the readIOGiB value.
long readIOps()

Get the readIOps value.
org.joda.time.DateTime startTime()

Get the startTime value.
String url()

Get the url value.
org.joda.time.Period userCPUTime()

Get the userCPUTime value.
org.joda.time.Period waitTime()

Get the wait time for a Task is defined as the elapsed time between the creation of the Task and the start of Task execution.
org.joda.time.Period wallClockTime()

Get 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).
JobStatistics withKernelCPUTime(Period kernelCPUTime)

Set the kernelCPUTime value.
JobStatistics withLastUpdateTime(DateTime lastUpdateTime)

Set the lastUpdateTime value.
JobStatistics withNumFailedTasks(long numFailedTasks)

Set a Task fails if it exhausts its maximum retry count without returning exit code 0.
JobStatistics withNumSucceededTasks(long numSucceededTasks)

Set a Task completes successfully if it returns exit code 0.
JobStatistics withNumTaskRetries(long numTaskRetries)

Set the numTaskRetries value.
JobStatistics withReadIOGiB(double readIOGiB)

Set the readIOGiB value.
JobStatistics withReadIOps(long readIOps)

Set the readIOps value.
JobStatistics withStartTime(DateTime startTime)

Set the startTime value.
JobStatistics withUrl(String url)

Set the url value.
JobStatistics withUserCPUTime(Period userCPUTime)

Set the userCPUTime value.
JobStatistics withWaitTime(Period waitTime)

Set the wait time for a Task is defined as the elapsed time between the creation of the Task and the start of Task execution.
JobStatistics withWallClockTime(Period wallClockTime)

Set 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).
JobStatistics withWriteIOGiB(double writeIOGiB)

Set the writeIOGiB value.
JobStatistics withWriteIOps(long writeIOps)

Set the writeIOps value.
double writeIOGiB()

Get the writeIOGiB value.
long writeIOps()

Get the writeIOps value.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

JobStatistics

public JobStatistics()

Method Details

kernelCPUTime

public Period kernelCPUTime()

Get the kernelCPUTime value.

Returns:

the kernelCPUTime value

lastUpdateTime

public DateTime lastUpdateTime()

Get the lastUpdateTime value.

Returns:

the lastUpdateTime value

numFailedTasks

public long numFailedTasks()

Get a Task fails if it exhausts its maximum retry count without returning exit code 0.

Returns:

the numFailedTasks value

numSucceededTasks

public long numSucceededTasks()

Get a Task completes successfully if it returns exit code 0.

Returns:

the numSucceededTasks value

numTaskRetries

public long numTaskRetries()

Get the numTaskRetries value.

Returns:

the numTaskRetries value

readIOGiB

public double readIOGiB()

Get the readIOGiB value.

Returns:

the readIOGiB value

readIOps

public long readIOps()

Get the readIOps value.

Returns:

the readIOps value

startTime

public DateTime startTime()

Get the startTime value.

Returns:

the startTime value

url

public String url()

Get the url value.

Returns:

the url value

userCPUTime

public Period userCPUTime()

Get the userCPUTime value.

Returns:

the userCPUTime value

waitTime

public Period waitTime()

Get 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

wallClockTime

public Period wallClockTime()

Get 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

withKernelCPUTime

public JobStatistics withKernelCPUTime(Period kernelCPUTime)

Set the kernelCPUTime value.

Parameters:

kernelCPUTime - the kernelCPUTime value to set

Returns:

the JobStatistics object itself.

withLastUpdateTime

public JobStatistics withLastUpdateTime(DateTime lastUpdateTime)

Set the lastUpdateTime value.

Parameters:

lastUpdateTime - the lastUpdateTime value to set

Returns:

the JobStatistics object itself.

withNumFailedTasks

public JobStatistics withNumFailedTasks(long numFailedTasks)

Set a Task fails if it exhausts its maximum retry count without returning exit code 0.

Parameters:

numFailedTasks - the numFailedTasks value to set

Returns:

the JobStatistics object itself.

withNumSucceededTasks

public JobStatistics withNumSucceededTasks(long numSucceededTasks)

Set a Task completes successfully if it returns exit code 0.

Parameters:

numSucceededTasks - the numSucceededTasks value to set

Returns:

the JobStatistics object itself.

withNumTaskRetries

public JobStatistics withNumTaskRetries(long numTaskRetries)

Set the numTaskRetries value.

Parameters:

numTaskRetries - the numTaskRetries value to set

Returns:

the JobStatistics object itself.

withReadIOGiB

public JobStatistics withReadIOGiB(double readIOGiB)

Set the readIOGiB value.

Parameters:

readIOGiB - the readIOGiB value to set

Returns:

the JobStatistics object itself.

withReadIOps

public JobStatistics withReadIOps(long readIOps)

Set the readIOps value.

Parameters:

readIOps - the readIOps value to set

Returns:

the JobStatistics object itself.

withStartTime

public JobStatistics withStartTime(DateTime startTime)

Set the startTime value.

Parameters:

startTime - the startTime value to set

Returns:

the JobStatistics object itself.

withUrl

public JobStatistics withUrl(String url)

Set the url value.

Parameters:

url - the url value to set

Returns:

the JobStatistics object itself.

withUserCPUTime

public JobStatistics withUserCPUTime(Period userCPUTime)

Set the userCPUTime value.

Parameters:

userCPUTime - the userCPUTime value to set

Returns:

the JobStatistics object itself.

withWaitTime

public JobStatistics withWaitTime(Period waitTime)

Set 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.

Parameters:

waitTime - the waitTime value to set

Returns:

the JobStatistics object itself.

withWallClockTime

public JobStatistics withWallClockTime(Period wallClockTime)

Set 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.

Parameters:

wallClockTime - the wallClockTime value to set

Returns:

the JobStatistics object itself.

withWriteIOGiB

public JobStatistics withWriteIOGiB(double writeIOGiB)

Set the writeIOGiB value.

Parameters:

writeIOGiB - the writeIOGiB value to set

Returns:

the JobStatistics object itself.

withWriteIOps

public JobStatistics withWriteIOps(long writeIOps)

Set the writeIOps value.

Parameters:

writeIOps - the writeIOps value to set

Returns:

the JobStatistics object itself.

writeIOGiB

public double writeIOGiB()

Get the writeIOGiB value.

Returns:

the writeIOGiB value

writeIOps

public long writeIOps()

Get the writeIOps value.

Returns:

the writeIOps value

Applies to