Class AirQuality

java.lang.Object
com.azure.maps.weather.models.AirQuality

public final class AirQuality extends Object
Information about the air quality in a specific location at a specific time.
  • Method Summary

    Modifier and Type
    Method
    Description
    Get the category property: One-word description of the air quality in the requested language.
    Get the categoryColor property: A unique color corresponding to the category of this air quality result.
    Get the description property: A textual explanation of this air quality result in the requested language.
    Get the dominantPollutant property: The pollutant with the highest concentration.
    Get the globalIndex property: Internationally normalized air quality rating on a scale from 0 to 300 and up, with higher numbers representing worse air quality.
    Get the index property: Air quality rating on a scale set by local regulating bodies.
    Get the pollutants property: Information about individual pollutants.
    Get the timestamp property: Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Method Details

    • getTimestamp

      public OffsetDateTime getTimestamp()
      Get the timestamp property: Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00.
      Returns:
      the timestamp value.
    • getIndex

      public Float getIndex()
      Get the index property: Air quality rating on a scale set by local regulating bodies. Scales can vary widely based on location. See [Wikipedia](https://en.wikipedia.org/wiki/Air_quality_index) for more information.
      Returns:
      the index value.
    • getGlobalIndex

      public Float getGlobalIndex()
      Get the globalIndex property: Internationally normalized air quality rating on a scale from 0 to 300 and up, with higher numbers representing worse air quality.
      Returns:
      the globalIndex value.
    • getDominantPollutant

      public DominantPollutant getDominantPollutant()
      Get the dominantPollutant property: The pollutant with the highest concentration.
      Returns:
      the dominantPollutant value.
    • getCategory

      public String getCategory()
      Get the category property: One-word description of the air quality in the requested language. For example, "Excellent".
      Returns:
      the category value.
    • getCategoryColor

      public String getCategoryColor()
      Get the categoryColor property: A unique color corresponding to the category of this air quality result.
      Returns:
      the categoryColor value.
    • getDescription

      public String getDescription()
      Get the description property: A textual explanation of this air quality result in the requested language.
      Returns:
      the description value.
    • getPollutants

      public List<Pollutant> getPollutants()
      Get the pollutants property: Information about individual pollutants.
      Returns:
      the pollutants value.