java.lang.Object
- java.lang.Enum<EndpointType>
- - com.aerisweather.aeris.communication.EndpointType

All Implemented Interfaces:

Serializable, Comparable<EndpointType>
```
public enum EndpointType
extends Enum<EndpointType>
```
Types of endpoints that are supported by Aeris.

Enum Constant Summary

Enum Constants
Enum Constant	Description
`ADVISORIES`	Deprecated.
`AIR_QUALITY`	Deprecated.
`AIR_QUALITY_FORECASTS`	Deprecated.
`AIRQUALITY`	The airquality endpoint provides latest air quality information globally Available `Action`: id, closest, within, search, route.
`AIRQUALITY_FORECASTS`	The airquality endpoint provides latest air quality forecast information globally Available `Action`: id, route.
`ALERTS`	The alerts data set provides access to all currently active alerts as issued by the National Weather Service (NWS), Environment Canada, MeteoAlarm. Available `Action`: id, route.
`ALERTS_SUMMARY`	Summary of active weather events across Canada and US.
`CONDITIONS`	The conditions endpoint provides current and previous weather conditions globally Available `Action`: id, route For more information
`CONDITIONS_SUMMARY`	Global current and past conditions as a daily summary or a summary in specified intervals.
`CONVECTIVE_OUTLOOK`	The convective/outlook endpoint provides convective outlook information based on the SPC convective outlooks.
`COUNTRIES`	The countries dataset provides the core data for countries, returning the full name, abbreviations, capital, population area, and neighboring countries. Available `Action`: id, search For more information
`CUSTOM`	Used to know when a custom endpoint was used.
`DROUGHTS_MONITOR`	Official drought areas per the National Drought Mitigation Center.
`EARTHQUAKES`	The earthquake data set provides information on US and international earthquakes, including location, mangnitude, depth and more. Available `Action`: id, closest, within, search For more information
`FIRES`	The fires data set contains data for all of the active wildfires across the U.S., including type of fire, area, cause and percent contained.
`FIRES_OUTLOOK`	The fires/outlook endpoint provides fire weather outlook information based on the SPC fire weather outlooks.
`FORECASTS`	The forecasts endpoint provides the core forecast data for US and international locations.
`INDICES_ARTHRITIS`	Returns index on how current and forecast weather conditions may affect people with arthritis.
`INDICES_BEES`	Returns index on how current and forecast weather conditions as related to bees being active.
`INDICES_BIKING`	Returns index on how current and forecast weather conditions are conducive to biking.
`INDICES_CAMPFIRES`	Returns index on how current and forecast weather conditions are conducive to campfires and/or grilling.
`INDICES_COLDFLU`	Returns index on how current and forecast weather conditions may relate to catching a cold or flu.
`INDICES_GOLF`	Returns index on how current and forecast weather conditions are conducive to golfing.
`INDICES_MIGRAINE`	Returns index on how current and forecast weather conditions may affect migraines.
`INDICES_OUTDOORS`	Returns index on how current and forecast weather conditions are conducive to general outdoor activities.
`INDICES_SINUS`	Returns index on how current and forecast weather conditions may affect sinus headaches.
`INDICES_SWIMMING`	Returns index on how current and forecast weather conditions are conducive to swimming.
`LIGHTNING`	Lightning strike data.
`LIGHTNING_SUMMARY`	A summary of lightning strikes that took place across the globe.
`NORMALS`	The normals endpoints provides access to the climate normals for US locations.
`NORMALS_STATIONS`	The normals_stations dataset provides access to the complete Coop/Station information that normals are available for.
`OAUTH2`
`OBSERVATIONS`	The observations data set provides access to current and archived weather observations from a variety of reporting stations.
`OBSERVATIONS_ARCHIVE`	The observations/archive endpoint provides access to a full day of observations from our archive based on your subscription level.
`OBSERVATIONS_RECENT`	Deprecated.
`OBSERVATIONS_SUMMARY`	The observations/summaryPeriod endpoint provides access to daily summaries based on received observations.
`PERMISSIONS`
`PHRASES_OUTLOOK`	Deprecated.
`PHRASES_SUMMARY`	Returns text phrases for the period Available `Action`: id.
`PLACES`	The places dataset provides the core data for geographical locations, including cities, reporting stations, airports, points of interest (poi), etc.
`PLACES_AIRPORTS`	The places/airports endpoint provides place information on airports, heliports.
`PLACES_POSTALCODES`	The places/postalcodes endpoint provides information on US zip codes and Canadian Postal Codes.
`RECORDS`	Deprecated.
`RIVERS`	The rivers endpoint provides access to the latest river and lakes gauge observations.
`RIVERS_GAUGES`	The rivers/gauges endpoint provides access to enhanced information for the river and lake gauges utilized within the rivers endpoint.
`STORMCELLS`	The storm cells dataset provides observed and forecast data for all storm cells across the United States.
`STORMCELLS_SUMMARY`	Returns summary data for storm cells
`STORMREPORTS`	The storm reports data set provides access to all local storm reports (LSR) as transmitted by the National Weather Service (NWS).
`STORMREPORTS_SUMMARY`	Returns summary data for storm reports
`SUNMOON`	The sunmoon endpoint provides sunrise/set, twilight, moon rise/set and moon phase information for requested locations and time frames.
`SUNMOON_MOONPHASES`	The Moonphases endpoint is an extension of the sunmoon endpoint and provides easy access to the moon phase calendar information.
`THREATS`	Returns summary data for threats
`TIDES`	The Tides endpoints provides access to the predicted tidal information for US locations.
`TIDES_STATIONS`	The tides_stations dataset provides access to the complete station information that tides are available for.
`TROPICAL_CYCLONES`	The tropicalcyclones endpoint provides access to information on the active tropical cyclones, such as tropical storms, hurricanes, and typhoons, across the globe.
`TROPICAL_CYCLONES_ARCHIVES`
`VERSION`	Provides the version of the Aeris API
`WINTER_SNOWDEPTH`	Estimated snow depth across North America.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getCode()`
`boolean`	`isActionSupported(Action action)`	TODO: Implement for all endpoint types.
`static EndpointType`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static EndpointType[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - CUSTOM
```
public static final EndpointType CUSTOM
```
    Used to know when a custom endpoint was used.
  - AIRQUALITY
```
public static final EndpointType AIRQUALITY
```
    The airquality endpoint provides latest air quality information globally
    Available Action: id, closest, within, search, route.
    For more information
  - AIR_QUALITY
```
@Deprecated
public static final EndpointType AIR_QUALITY
```
    Deprecated.
    
    Deprecated Alias for AIRQAULITY
  - AIRQUALITY_FORECASTS
```
public static final EndpointType AIRQUALITY_FORECASTS
```
    The airquality endpoint provides latest air quality forecast information globally
    Available Action: id, route.
    For more information
  - AIR_QUALITY_FORECASTS
```
@Deprecated
public static final EndpointType AIR_QUALITY_FORECASTS
```
    Deprecated.
    
    Deprecated Alias for AIRQUALITY_FORECASTS
  - ADVISORIES
```
@Deprecated
public static final EndpointType ADVISORIES
```
    Deprecated.
    
    Deprecated. See Alerts
    Available Action: id, route.
  - ALERTS
```
public static final EndpointType ALERTS
```
    The alerts data set provides access to all currently active alerts as issued by the National Weather Service (NWS), Environment Canada, MeteoAlarm.
    Available Action: id, route. For more information
  - ALERTS_SUMMARY
```
public static final EndpointType ALERTS_SUMMARY
```
    Summary of active weather events across Canada and US. This endpoint is derived from the /alerts endpoint. Available Action: id, within, search For more information
  - CONDITIONS
```
public static final EndpointType CONDITIONS
```
    The conditions endpoint provides current and previous weather conditions globally
    Available Action: id, route
    For more information
  - CONDITIONS_SUMMARY
```
public static final EndpointType CONDITIONS_SUMMARY
```
    Global current and past conditions as a daily summary or a summary in specified intervals.
    Available Action: id, route
    For more information
  - CONVECTIVE_OUTLOOK
```
public static final EndpointType CONVECTIVE_OUTLOOK
```
    The convective/outlook endpoint provides convective outlook information based on the SPC convective outlooks. Coverage of this endpoint is for the US only.
    Available Action: id, affets, contains, search
    For more information
  - COUNTRIES
```
public static final EndpointType COUNTRIES
```
    The countries dataset provides the core data for countries, returning the full name, abbreviations, capital, population area, and neighboring countries.
    Available Action: id, search
    For more information
  - DROUGHTS_MONITOR
```
public static final EndpointType DROUGHTS_MONITOR
```
    Official drought areas per the National Drought Mitigation Center. Coverage of this endpoint is for the US only.
    Available Action: id, search
    For more information
  - EARTHQUAKES
```
public static final EndpointType EARTHQUAKES
```
    The earthquake data set provides information on US and international earthquakes, including location, mangnitude, depth and more.
    Available Action: id, closest, within, search
    For more information
  - FIRES
```
public static final EndpointType FIRES
```
    The fires data set contains data for all of the active wildfires across the U.S., including type of fire, area, cause and percent contained. etc.
    Available Action: id, closest, within, search
    For more information
  - FIRES_OUTLOOK
```
public static final EndpointType FIRES_OUTLOOK
```
    The fires/outlook endpoint provides fire weather outlook information based on the SPC fire weather outlooks. Coverage of this endpoint is for the US only.
    Available Action: id, affects, contains, closest, within, search
    For more information
  - FORECASTS
```
public static final EndpointType FORECASTS
```
    The forecasts endpoint provides the core forecast data for US and international locations. Forecast data is available in various intervals, such as 24-, 12-, 6-, 3- and 1-hour intervals.
    Available Action: id, route.
    For more information
  - INDICES_ARTHRITIS
```
public static final EndpointType INDICES_ARTHRITIS
```
    Returns index on how current and forecast weather conditions may affect people with arthritis.
  - INDICES_COLDFLU
```
public static final EndpointType INDICES_COLDFLU
```
    Returns index on how current and forecast weather conditions may relate to catching a cold or flu.
  - INDICES_MIGRAINE
```
public static final EndpointType INDICES_MIGRAINE
```
    Returns index on how current and forecast weather conditions may affect migraines.
  - INDICES_SINUS
```
public static final EndpointType INDICES_SINUS
```
    Returns index on how current and forecast weather conditions may affect sinus headaches.
  - INDICES_OUTDOORS
```
public static final EndpointType INDICES_OUTDOORS
```
    Returns index on how current and forecast weather conditions are conducive to general outdoor activities.
  - INDICES_GOLF
```
public static final EndpointType INDICES_GOLF
```
    Returns index on how current and forecast weather conditions are conducive to golfing.
  - INDICES_BIKING
```
public static final EndpointType INDICES_BIKING
```
    Returns index on how current and forecast weather conditions are conducive to biking.
  - INDICES_SWIMMING
```
public static final EndpointType INDICES_SWIMMING
```
    Returns index on how current and forecast weather conditions are conducive to swimming.
  - INDICES_CAMPFIRES
```
public static final EndpointType INDICES_CAMPFIRES
```
    Returns index on how current and forecast weather conditions are conducive to campfires and/or grilling.
  - INDICES_BEES
```
public static final EndpointType INDICES_BEES
```
    Returns index on how current and forecast weather conditions as related to bees being active.
  - LIGHTNING
```
public static final EndpointType LIGHTNING
```
    Lightning strike data. Please make sure you have API permission for the endpoint as this does not come in default API access permissions.
    Available Action: id, closest, route.
    For more information
  - LIGHTNING_SUMMARY
```
public static final EndpointType LIGHTNING_SUMMARY
```
    A summary of lightning strikes that took place across the globe. Search can be limited by intracloud, cloud to ground, or both.
    Available Action: id, closest, search, within.
    For more information
  - NORMALS
```
public static final EndpointType NORMALS
```
    The normals endpoints provides access to the climate normals for US locations.
    Available Action: id, closest, search, within.
    For more information
  - NORMALS_STATIONS
```
public static final EndpointType NORMALS_STATIONS
```
    The normals_stations dataset provides access to the complete Coop/Station information that normals are available for.
    Available Action: id, closest, search, within.
    For more information
  - OBSERVATIONS
```
public static final EndpointType OBSERVATIONS
```
    The observations data set provides access to current and archived weather observations from a variety of reporting stations.
    Available Action: id, closest, search, within, route.
    For more information
  - OBSERVATIONS_ARCHIVE
```
public static final EndpointType OBSERVATIONS_ARCHIVE
```
    The observations/archive endpoint provides access to a full day of observations from our archive based on your subscription level. A day of archived observations is based on UTC time from Midnight - 11:59:00pm.
    Available Action: id, closest, search, within.
    For more information
  - OBSERVATIONS_RECENT
```
@Deprecated
public static final EndpointType OBSERVATIONS_RECENT
```
    Deprecated.
    
    The observations/recent provides access to up to 24 hours of observations within a specific time frame.
    
    Available Action: id, closest, search, within.
    For more information
  - OBSERVATIONS_SUMMARY
```
public static final EndpointType OBSERVATIONS_SUMMARY
```
    The observations/summaryPeriod endpoint provides access to daily summaries based on received observations.
    
    Available Action: id, closest, search, within.
    For more information
  - PHRASES_OUTLOOK
```
@Deprecated
public static final EndpointType PHRASES_OUTLOOK
```
    Deprecated.
    
    Deprecasted. See Phrases/summary
  - PHRASES_SUMMARY
```
public static final EndpointType PHRASES_SUMMARY
```
    Returns text phrases for the period Available Action: id.
    For more information
  - PLACES
```
public static final EndpointType PLACES
```
    The places dataset provides the core data for geographical locations, including cities, reporting stations, airports, points of interest (poi), etc.
    Available Action: id, closest, within, search.
    For more information
  - PLACES_AIRPORTS
```
public static final EndpointType PLACES_AIRPORTS
```
    The places/airports endpoint provides place information on airports, heliports.
    Available Action: id,within, search, and closest.
  - PLACES_POSTALCODES
```
public static final EndpointType PLACES_POSTALCODES
```
    The places/postalcodes endpoint provides information on US zip codes and Canadian Postal Codes.
    US 5 digit zip codes and Canadian 6 character postal codes are supported.
    Available Action: id,within, search, and closest.
  - RECORDS
```
@Deprecated
public static final EndpointType RECORDS
```
    Deprecated.
    
    Deprecated The records data set provides access to daily US records (RER) as transmitted by the National Weather Service (NWS).
    Available Action: id,within, search, and closest.
  - RIVERS
```
public static final EndpointType RIVERS
```
    The rivers endpoint provides access to the latest river and lakes gauge observations. The primary source of this gauge observations is the NOAA Advanced Hydrologic Prediction Service (AHPS). The gauge observations include information on the current water level or flow, flood stages, and low water thresholds.
  - RIVERS_GAUGES
```
public static final EndpointType RIVERS_GAUGES
```
    The rivers/gauges endpoint provides access to enhanced information for the river and lake gauges utilized within the rivers endpoint. The primary source the gauge information is the NOAA Advanced Hydrologic Prediction Service (AHPS). Gauge information will include location information and when available recent crests, historical crests and flood impacts.
  - STORMCELLS
```
public static final EndpointType STORMCELLS
```
    The storm cells dataset provides observed and forecast data for all storm cells across the United States. This is a NEXRAD derived product that attempts to identify and track storm cell movement along with reporting cell intensity and certain severe weather signatures within the cell, like rotation and hail. The forecast track can be used to determine when and where a cell will affect a particular location or area.
    Available Action: id,within, search, affects and closest.
  - STORMCELLS_SUMMARY
```
public static final EndpointType STORMCELLS_SUMMARY
```
    Returns summary data for storm cells
  - STORMREPORTS
```
public static final EndpointType STORMREPORTS
```
    The storm reports data set provides access to all local storm reports (LSR) as transmitted by the National Weather Service (NWS). These reports are received from storm spotters, such as amateur radio operators, storm chasers, law enforcement, emergency management, or citizens about severe weather conditions in their area.
    Available Action: id,within, search, and closest.
  - STORMREPORTS_SUMMARY
```
public static final EndpointType STORMREPORTS_SUMMARY
```
    Returns summary data for storm reports
  - SUNMOON
```
public static final EndpointType SUNMOON
```
    The sunmoon endpoint provides sunrise/set, twilight, moon rise/set and moon phase information for requested locations and time frames.
    Available Action: id
  - SUNMOON_MOONPHASES
```
public static final EndpointType SUNMOON_MOONPHASES
```
    The Moonphases endpoint is an extension of the sunmoon endpoint and provides easy access to the moon phase calendar information. Such as the next full, new and quarter moon phases.
    Available Action: id and search
  - THREATS
```
public static final EndpointType THREATS
```
    Returns summary data for threats
  - TIDES
```
public static final EndpointType TIDES
```
    The Tides endpoints provides access to the predicted tidal information for US locations.
    Available Action: id,within, search, and closest.
  - TIDES_STATIONS
```
public static final EndpointType TIDES_STATIONS
```
    The tides_stations dataset provides access to the complete station information that tides are available for.
    Available Action: id,within, search, and closest.
  - TROPICAL_CYCLONES
```
public static final EndpointType TROPICAL_CYCLONES
```
    The tropicalcyclones endpoint provides access to information on the active tropical cyclones, such as tropical storms, hurricanes, and typhoons, across the globe. Includes information on an individual storms name, position, historical track and forecasts. The tropical API information is based on data from the National Hurricane Center (NHC), Central Pacific Hurricane Center (CPHC), and the Joint Typhoon Warning Center (JTWC).
  - TROPICAL_CYCLONES_ARCHIVES
```
public static final EndpointType TROPICAL_CYCLONES_ARCHIVES
```
  - VERSION
```
public static final EndpointType VERSION
```
    Provides the version of the Aeris API
  - WINTER_SNOWDEPTH
```
public static final EndpointType WINTER_SNOWDEPTH
```
    Estimated snow depth across North America.
  - OAUTH2
```
public static final EndpointType OAUTH2
```
  - PERMISSIONS
```
public static final EndpointType PERMISSIONS
```
- Method Detail
  - values
```
public static EndpointType[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (EndpointType c : EndpointType.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static EndpointType valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getCode
```
public String getCode()
```
  - isActionSupported
```
public boolean isActionSupported(Action action)
```
    TODO: Implement for all endpoint types.
    
    Parameters:
    
    action - Action to take on the endpoint
    
    Returns:
    
    boolean

Enum EndpointType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

CUSTOM

AIRQUALITY

AIR_QUALITY

AIRQUALITY_FORECASTS

AIR_QUALITY_FORECASTS

ADVISORIES

ALERTS

ALERTS_SUMMARY

CONDITIONS

CONDITIONS_SUMMARY

CONVECTIVE_OUTLOOK

COUNTRIES

DROUGHTS_MONITOR

EARTHQUAKES

FIRES

FIRES_OUTLOOK

FORECASTS

INDICES_ARTHRITIS

INDICES_COLDFLU

INDICES_MIGRAINE

INDICES_SINUS

INDICES_OUTDOORS

INDICES_GOLF

INDICES_BIKING

INDICES_SWIMMING

INDICES_CAMPFIRES

INDICES_BEES

LIGHTNING

LIGHTNING_SUMMARY

NORMALS

NORMALS_STATIONS

OBSERVATIONS

OBSERVATIONS_ARCHIVE

OBSERVATIONS_RECENT

OBSERVATIONS_SUMMARY

PHRASES_OUTLOOK

PHRASES_SUMMARY

PLACES

PLACES_AIRPORTS

PLACES_POSTALCODES

RECORDS

RIVERS

RIVERS_GAUGES

STORMCELLS

STORMCELLS_SUMMARY

STORMREPORTS

STORMREPORTS_SUMMARY

SUNMOON

SUNMOON_MOONPHASES

THREATS

TIDES

TIDES_STATIONS

TROPICAL_CYCLONES

TROPICAL_CYCLONES_ARCHIVES

VERSION

WINTER_SNOWDEPTH

OAUTH2

PERMISSIONS

Method Detail

values

valueOf

getCode

isActionSupported