Class BatchTaskCounts

java.lang.Object
com.azure.compute.batch.models.BatchTaskCounts
All Implemented Interfaces:
com.azure.json.JsonSerializable<BatchTaskCounts>

public final class BatchTaskCounts extends Object implements com.azure.json.JsonSerializable<BatchTaskCounts>
The Task counts for a Job.
  • Method Summary

    Modifier and Type
    Method
    Description
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of BatchTaskCounts from the JsonReader.
    int
    Get the active property: The number of Tasks in the active state.
    int
    Get the completed property: The number of Tasks in the completed state.
    int
    Get the failed property: The number of Tasks which failed.
    int
    Get the running property: The number of Tasks in the running or preparing state.
    int
    Get the succeeded property: The number of Tasks which succeeded.
    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

    • getActive

      public int getActive()
      Get the active property: The number of Tasks in the active state.
      Returns:
      the active value.
    • getRunning

      public int getRunning()
      Get the running property: The number of Tasks in the running or preparing state.
      Returns:
      the running value.
    • getCompleted

      public int getCompleted()
      Get the completed property: The number of Tasks in the completed state.
      Returns:
      the completed value.
    • getSucceeded

      public int getSucceeded()
      Get the succeeded property: The number of Tasks which succeeded. A Task succeeds if its result (found in the executionInfo property) is 'success'.
      Returns:
      the succeeded value.
    • getFailed

      public int getFailed()
      Get the failed property: The number of Tasks which failed. A Task fails if its result (found in the executionInfo property) is 'failure'.
      Returns:
      the failed value.
    • toJson

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

      public static BatchTaskCounts fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of BatchTaskCounts from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of BatchTaskCounts 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 BatchTaskCounts.