Package com.azure.resourcemanager.cosmos.fluent.models

Class PartitionMetricInner

java.lang.Object
com.azure.resourcemanager.cosmos.fluent.models.MetricInner
com.azure.resourcemanager.cosmos.fluent.models.PartitionMetricInner
All Implemented Interfaces:
com.azure.json.JsonSerializable<MetricInner>
public final class PartitionMetricInner extends MetricInner
The metric values for a single partition.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PartitionMetricInner()
    Creates an instance of PartitionMetricInner class.

  • Method Summary

    Modifier and Type
    Method
    Description
    OffsetDateTime
    endTime()
    Get the endTime property: The end time for the metric (ISO-8601 format).
    static PartitionMetricInner
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of PartitionMetricInner from the JsonReader.
    List<MetricValue>
    metricValues()
    Get the metricValues property: The metric values for the specified time window and timestep.
    MetricName
    name()
    Get the name property: The name information for the metric.
    String
    partitionId()
    Get the partitionId property: The partition id (GUID identifier) of the metric values.
    String
    partitionKeyRangeId()
    Get the partitionKeyRangeId property: The partition key range id (integer identifier) of the metric values.
    OffsetDateTime
    startTime()
    Get the startTime property: The start time for the metric (ISO-8601 format).
    String
    timeGrain()
    Get the timeGrain property: The time grain to be used to summarize the metric values.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)
    UnitType
    unit()
    Get the unit property: The unit of the metric.
    void
    validate()
    Validates the instance.

    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

  • Constructor Details

    • PartitionMetricInner

      public PartitionMetricInner()
      Creates an instance of PartitionMetricInner class.

  • Method Details

    • partitionId

      public String partitionId()
      Get the partitionId property: The partition id (GUID identifier) of the metric values.
      Returns:
      the partitionId value.

    • partitionKeyRangeId

      public String partitionKeyRangeId()
      Get the partitionKeyRangeId property: The partition key range id (integer identifier) of the metric values.
      Returns:
      the partitionKeyRangeId value.

    • metricValues

      public List<MetricValue> metricValues()
      Get the metricValues property: The metric values for the specified time window and timestep.
      Overrides:
      metricValues in class MetricInner
      Returns:
      the metricValues value.

    • name

      public MetricName name()
      Get the name property: The name information for the metric.
      Overrides:
      name in class MetricInner
      Returns:
      the name value.

    • unit

      public UnitType unit()
      Get the unit property: The unit of the metric.
      Overrides:
      unit in class MetricInner
      Returns:
      the unit value.

    • timeGrain

      public String timeGrain()
      Get the timeGrain property: The time grain to be used to summarize the metric values.
      Overrides:
      timeGrain in class MetricInner
      Returns:
      the timeGrain value.

    • endTime

      public OffsetDateTime endTime()
      Get the endTime property: The end time for the metric (ISO-8601 format).
      Overrides:
      endTime in class MetricInner
      Returns:
      the endTime value.

    • startTime

      public OffsetDateTime startTime()
      Get the startTime property: The start time for the metric (ISO-8601 format).
      Overrides:
      startTime in class MetricInner
      Returns:
      the startTime value.

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class MetricInner
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

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

    • fromJson

      public static PartitionMetricInner fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of PartitionMetricInner from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of PartitionMetricInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the PartitionMetricInner.