ch.rasc.darksky.model

Interface DsAlert

All Known Implementing Classes:

ImmutableDsAlert

@Value.Immutable
public interface DsAlert

An alert object represents a severe weather warning issued for the requested location by a governmental authority. (See the data sources page for a list of sources)

Method Summary

Modifier and Type	Method and Description
String	description() A detailed description of the alert.
long	expires() The UNIX time at which the alert will expire.
List<String>	regions() A list of String representing the names of the regions covered by this weather alert.
DsAlertSeverity	severity() The severity of the weather alert.
long	time() The UNIX time at which the alert was issued.
String	title() A brief description of the alert.
String	uri() An HTTP(S) URI that one may refer to for detailed information about the alert.

Method Detail

description

String description()

A detailed description of the alert.

expires

long expires()

The UNIX time at which the alert will expire.

regions

List<String> regions()

A list of String representing the names of the regions covered by this weather alert.

severity

DsAlertSeverity severity()

The severity of the weather alert. Will take one of the following values: DsAlertSeverity.ADVISORY (an individual should be aware of potentially severe weather), DsAlertSeverity.WATCH (an individual should prepare for potentially severe weather), or DsAlertSeverity.WARNING (an individual should take immediate action to protect themselves and others from potentially severe weather).

time

long time()

The UNIX time at which the alert was issued.

title

String title()

A brief description of the alert.

uri

String uri()

An HTTP(S) URI that one may refer to for detailed information about the alert.