Package com.azure.maps.weather.models
Class AlertDetails
java.lang.Object
com.azure.maps.weather.models.AlertDetails
Information about a severe weather alert issued within an affected area(s). If multiple alerts are active for the
same location, the alerts will be returned in order of `priority` within the API response, with the highest priority
alert being returned at the top of the response.
-
Method Summary
Modifier and TypeMethodDescriptionGet the description property: Text summarizing the alert in the returned area.Get the details property: Full details associated with the alert.Get the endTime property: The end date and time of the alert in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00.Get the language property: Language of the `alertDetails`.Get the latestStatus property: The latest status of the alert in the current area.getName()
Get the name property: The name of an area which is affected by the alert.Get the startTime property: The start date and time of the alert in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00.
-
Method Details
-
getName
Get the name property: The name of an area which is affected by the alert. The location that was requested falls under the alert area.- Returns:
- the name value.
-
getDescription
Get the description property: Text summarizing the alert in the returned area.- Returns:
- the description value.
-
getStartTime
Get the startTime property: The start date and time of the alert in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. If the alert crosses multiple time zones the returned time in the response is the local time to the requested coordinate location.- Returns:
- the startTime value.
-
getEndTime
Get the endTime property: The end date and time of the alert in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. If the alert crosses multiple time zones the returned time in the response is the local time to the requested coordinate location.- Returns:
- the endTime value.
-
getLatestStatus
Get the latestStatus property: The latest status of the alert in the current area.- Returns:
- the latestStatus value.
-
getDetails
Get the details property: Full details associated with the alert. Returned if `details`=True. This field is always returned in the language(s) of choice by the issuing provider and Azure Maps only returns what is created by the provider. Please note, some countries/regions may offer their native language and English. Language parameter won’t apply to this field.- Returns:
- the details value.
-
getLanguage
Get the language property: Language of the `alertDetails`. This field helps to point out that the language of the `alertDetails` may differ from the requested language parameter. Returned if `details`=True. Language code has been derived from the ISO 639-1 Alpha-2 codes.- Returns:
- the language value.
-