Package com.azure.compute.batch.models

Class BatchPoolUsageMetrics

java.lang.Object
com.azure.compute.batch.models.BatchPoolUsageMetrics
All Implemented Interfaces:
com.azure.json.JsonSerializable<BatchPoolUsageMetrics>
public final class BatchPoolUsageMetrics extends Object implements com.azure.json.JsonSerializable<BatchPoolUsageMetrics>
Usage metrics for a Pool across an aggregation interval.

  • Method Summary

    Modifier and Type
    Method
    Description
    static BatchPoolUsageMetrics
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of BatchPoolUsageMetrics from the JsonReader.
    OffsetDateTime
    getEndTime()
    Get the endTime property: The end time of the aggregation interval covered by this entry.
    String
    getPoolId()
    Get the poolId property: The ID of the Pool whose metrics are aggregated in this entry.
    OffsetDateTime
    getStartTime()
    Get the startTime property: The start time of the aggregation interval covered by this entry.
    double
    getTotalCoreHours()
    Get the totalCoreHours property: The total core hours used in the Pool during this aggregation interval.
    String
    getVmSize()
    Get the vmSize property: The size of virtual machines in the Pool.
    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

    • getPoolId

      public String getPoolId()
      Get the poolId property: The ID of the Pool whose metrics are aggregated in this entry.
      Returns:
      the poolId value.

    • getStartTime

      public OffsetDateTime getStartTime()
      Get the startTime property: The start time of the aggregation interval covered by this entry.
      Returns:
      the startTime value.

    • getEndTime

      public OffsetDateTime getEndTime()
      Get the endTime property: The end time of the aggregation interval covered by this entry.
      Returns:
      the endTime value.

    • getVmSize

      public String getVmSize()
      Get the vmSize property: The size of virtual machines in the Pool. All VMs in a Pool are the same size. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes).
      Returns:
      the vmSize value.

    • getTotalCoreHours

      public double getTotalCoreHours()
      Get the totalCoreHours property: The total core hours used in the Pool during this aggregation interval.
      Returns:
      the totalCoreHours value.

    • toJson

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

    • fromJson

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