Package com.azure.maps.weather.models

Class DailyIndex

java.lang.Object
com.azure.maps.weather.models.DailyIndex
public final class DailyIndex extends Object
Information about a daily index.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCategoryDescription()
    Get the categoryDescription property: Textual description for `categoryValue` corresponding to the level that the index value falls under, for example "Very Good".
    Integer
    getCategoryValue()
    Get the categoryValue property: Level that the index value falls under, represented by an integer.
    OffsetDateTime
    getDateTime()
    Get the dateTime property: Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00.
    String
    getDescription()
    Get the description property: A textual explanation that can be used for display purposes to summarize the index value and category.
    Integer
    getIndexId()
    Get the indexId property: Numeric ID used to identify the specific index.
    String
    getIndexName()
    Get the indexName property: Name of the index, for example, "Construction", "Outdoor Activity", "Flight Delays".
    Float
    getValue()
    Get the value property: Index value.
    Boolean
    isAscending()
    Get the isAscending property: Describes the direction of the `value` and `categoryValue`.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • getIndexName

      public String getIndexName()
      Get the indexName property: Name of the index, for example, "Construction", "Outdoor Activity", "Flight Delays".
      Returns:
      the indexName value.

    • getIndexId

      public Integer getIndexId()
      Get the indexId property: Numeric ID used to identify the specific index. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported index IDs. For example, the index ID can support UI visualization scenarios.
      Returns:
      the indexId value.

    • getDateTime

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

    • getValue

      public Float getValue()
      Get the value property: Index value. Ranges from 0.0 to 10.0. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported ranges.
      Returns:
      the value value.

    • getCategoryDescription

      public String getCategoryDescription()
      Get the categoryDescription property: Textual description for `categoryValue` corresponding to the level that the index value falls under, for example "Very Good".
      Returns:
      the categoryDescription value.

    • getCategoryValue

      public Integer getCategoryValue()
      Get the categoryValue property: Level that the index value falls under, represented by an integer. This value can be 1 through 5 and should be used in combination with the `ascending` flag because it can differ among indices. For example, the following values apply for Mosquito Activity: Low=1, Moderate=2, High=3, Very High=4, and Extreme=5.
      Returns:
      the categoryValue value.

    • isAscending

      public Boolean isAscending()
      Get the isAscending property: Describes the direction of the `value` and `categoryValue`. For example, when set to `true`, the poorest index value is 0 and the best index value is 10. When set to `true`, the poorest index value is 10 and the best index value is 0.
      Returns:
      the isAscending value.

    • getDescription

      public String getDescription()
      Get the description property: A textual explanation that can be used for display purposes to summarize the index value and category. For example, when the index value for Flight Delays is very good, the description will be "Conditions are excellent for flying!".
      Returns:
      the description value.