Class MetricAvailability

java.lang.Object
com.azure.resourcemanager.monitor.models.MetricAvailability
All Implemented Interfaces:
com.azure.json.JsonSerializable<MetricAvailability>

public final class MetricAvailability extends Object implements com.azure.json.JsonSerializable<MetricAvailability>
Metric availability specifies the time grain (aggregation interval or frequency) and the retention period for that time grain.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Creates an instance of MetricAvailability class.
  • Method Summary

    Modifier and Type
    Method
    Description
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of MetricAvailability from the JsonReader.
    Get the retention property: the retention period for the metric at the specified timegrain.
    Get the timeGrain property: the time grain specifies the aggregation interval for the metric.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)
    void
    Validates the instance.
    Set the retention property: the retention period for the metric at the specified timegrain.
    Set the timeGrain property: the time grain specifies the aggregation interval for the metric.

    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

    • MetricAvailability

      public MetricAvailability()
      Creates an instance of MetricAvailability class.
  • Method Details

    • timeGrain

      public Duration timeGrain()
      Get the timeGrain property: the time grain specifies the aggregation interval for the metric. Expressed as a duration 'PT1M', 'P1D', etc.
      Returns:
      the timeGrain value.
    • withTimeGrain

      public MetricAvailability withTimeGrain(Duration timeGrain)
      Set the timeGrain property: the time grain specifies the aggregation interval for the metric. Expressed as a duration 'PT1M', 'P1D', etc.
      Parameters:
      timeGrain - the timeGrain value to set.
      Returns:
      the MetricAvailability object itself.
    • retention

      public Duration retention()
      Get the retention property: the retention period for the metric at the specified timegrain. Expressed as a duration 'PT1M', 'P1D', etc.
      Returns:
      the retention value.
    • withRetention

      public MetricAvailability withRetention(Duration retention)
      Set the retention property: the retention period for the metric at the specified timegrain. Expressed as a duration 'PT1M', 'P1D', etc.
      Parameters:
      retention - the retention value to set.
      Returns:
      the MetricAvailability object itself.
    • validate

      public void validate()
      Validates the instance.
      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<MetricAvailability>
      Throws:
      IOException
    • fromJson

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