Package com.azure.compute.batch.models

Class BatchJobStatistics

java.lang.Object
com.azure.compute.batch.models.BatchJobStatistics
All Implemented Interfaces:
com.azure.json.JsonSerializable<BatchJobStatistics>
public final class BatchJobStatistics extends Object implements com.azure.json.JsonSerializable<BatchJobStatistics>
Resource usage statistics for a Job.

  • Method Summary

    Modifier and Type
    Method
    Description
    static BatchJobStatistics
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of BatchJobStatistics from the JsonReader.
    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.
    long
    getNumFailedTasks()
    Get the numFailedTasks property: The total number of Tasks in the Job that failed during the given time range.
    long
    getNumSucceededTasks()
    Get the numSucceededTasks property: The total number of Tasks successfully completed in the Job during the given time range.
    long
    getNumTaskRetries()
    Get the numTaskRetries property: The total number of retries on all the Tasks in the Job during the given time range.
    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.
    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.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Method Details

    • getUrl

      public String getUrl()
      Get the url property: The URL of the statistics.
      Returns:
      the url value.

    • getStartTime

      public OffsetDateTime getStartTime()
      Get the startTime property: The start time of the time range covered by the statistics.
      Returns:
      the startTime 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.

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

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

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

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

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

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

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

    • getNumSucceededTasks

      public long getNumSucceededTasks()
      Get the numSucceededTasks 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 numSucceededTasks value.

    • getNumFailedTasks

      public long getNumFailedTasks()
      Get the numFailedTasks 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 numFailedTasks value.

    • getNumTaskRetries

      public long getNumTaskRetries()
      Get the numTaskRetries property: The total number of retries on all the Tasks in the Job during the given time range.
      Returns:
      the numTaskRetries 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.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<BatchJobStatistics>
      Throws:
      IOException

    • fromJson

      public static BatchJobStatistics fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the BatchJobStatistics.