REST Resource: floodStatus

Resource: FloodStatus

A Flood Status issued by the system. Represents the flooding status forecasted by the system for an area, with attributes such as severity, the forecast change, inundation maps and others. See below for more details.

JSON representation 
{
  "gaugeId": string,
  "qualityVerified": boolean,
  "gaugeLocation": {
    object (LatLng)
  },
  "issuedTime": string,
  "forecastTimeRange": {
    object (TimeRange)
  },
  "forecastChange": {
    object (ForecastChange)
  },
  "forecastTrend": enum (ForecastTrend),
  "mapInferenceType": enum (MapInferenceType),
  "severity": enum (Severity),
  "inundationMapSet": {
    object (InundationMapSet)
  },
  "source": string,
  "serializedNotificationPolygonId": string
}
Fields
gaugeId

string

The id of the gauge this status was issued for.
qualityVerified

boolean

True if the gauge this flood status was issued for does not have a model, or if it has a model and the model is quality-verified. Please use with caution when this value is set to false.
gaugeLocation

object (LatLng)

The location of the gauge this status was issued for.
issuedTime

string

The time this status was issued as string (ISO 8601), e.g., "2023-06-17T10:34:00Z".
forecastTimeRange

object (TimeRange)

The time range for which the forecast is predicting.
forecastChange

object (ForecastChange)

The forecast value change from the last known state to the forecast. Currently only available for Water Level models.
forecastTrend

enum (ForecastTrend)

The trend of the forecast.
mapInferenceType

enum (MapInferenceType)

The type of inference this map was created by.
severity

enum (Severity)

The severity of the status.
inundationMapSet

object (InundationMapSet)

The inferred inundation map set.
source

string

The organization responsible for the data of this gauge, e.g., GRDC, CWC, etc.
serializedNotificationPolygonId

string

An ID of the serialized notification polygon, which represents the geographic area Google uses to determine when to alert its users. Use serializedPolygons.get to get the serialized polygon itself.

TimeRange

A time range.

JSON representation 
{
  "start": string,
  "end": string
}
Fields
start

string

The start of the time range. Represented as ISO 8601, e.g., "2023-06-17T10:34:00Z".
end

string

The end of the time range. Represented as ISO 8601, e.g., "2023-06-17T10:34:00Z".

ForecastChange

The forecasted value change from the last known state to the forecast. Currently only available for Water Level models.

JSON representation 
{
  "valueChange": {
    object (ValueChange)
  },
  "referenceTimeRange": {
    object (TimeRange)
  }
}
Fields
valueChange

object (ValueChange)

The forecasted change in values.
referenceTimeRange

object (TimeRange)

Time range of the last known state, from which we predict the value change from. For example, we may have a reference time range set to yesterday, and a value change of 25-30cm. This means the water level rise of 25-30cm is compared to its value yesterday, not from its value now.

ValueChange

The forecasted change in values - an upper and lower bound.

JSON representation 
{
  "lowerBound": number,
  "upperBound": number
}
Fields
lowerBound

number

The lower bound of the forecast change in meters. If the change is between 20 and 30, this value would be 20. If the change is between -30 and -20, this value would be -30.
upperBound

number

The upper bound of the forecast change in meters. If the change is between 20 and 30, this value would be 30. If the change is between -30 and -20, this value would be -20.

ForecastTrend

An enum which represents the trend of the forecast.

Enums
FORECAST_TREND_UNSPECIFIED Default value. This value is unused.
RISE This indicates a rise in the forecasted value.
FALL This indicates a fall in the forecasted value.
NO_CHANGE This indicates no change in the forecasted value.

MapInferenceType

An enum which represents types of map inferences.

Enums
MAP_INFERENCE_TYPE_UNSPECIFIED Default value. This value is unused.
MODEL This indicates that this inference was created using a model.
IMAGE_CLASSIFICATION This indicates that this inference was created using an image classification.

Severity

An enum which represents the severity of the status.

Enums
SEVERITY_UNSPECIFIED Default value. This value is unused.
EXTREME This indicates a forecasted extreme status.
SEVERE This indicates a forecasted severe status.
ABOVE_NORMAL This indicates a forecasted above normal status.
NO_FLOODING This indicates a forecast of no flooding.
UNKNOWN This indicates that we don't have enough information to determine the severity.

InundationMapSet

A set of inundation maps.

JSON representation 
{
  "inundationMaps": [
    {
      object (InundationMap)
    }
  ],
  "inundationMapsTimeRange": {
    object (TimeRange)
  },
  "inundationMapType": enum (InundationMapType)
}
Fields
inundationMaps[]

object (InundationMap)

The inundation maps, one for each inundation level.
inundationMapsTimeRange

object (TimeRange)

The time range of the state to which the inundation maps refer.
inundationMapType

enum (InundationMapType)

The type of the inundation map.

InundationMap

One inundation map.

JSON representation 
{
  "level": enum (InundationLevel),
  "serializedPolygonId": string
}
Fields
level

enum (InundationLevel)

The level of the inundation map - See documentation based on the InundationMapType.
serializedPolygonId

string

An ID of the serialized polygon representing this inundation risk map. Use serializedPolygons.get to get the serialized polygon itself.

InundationLevel

An enum which represents inundation levels.

Enums
INUNDATION_LEVEL_UNSPECIFIED Default value. This value is unused.
HIGH See documentation based on the InundationMapType.
MEDIUM See documentation based on the InundationMapType.
LOW See documentation based on the InundationMapType.

InundationMapType

An enum which represents the type of the inundation map.

Enums
INUNDATION_MAP_TYPE_UNSPECIFIED Default value. This value is unused.
PROBABILITY A map of type probability. The InundationLevel represents the map probability - high/medium/low probability of flooding. The high probability polygon is contained within the medium probability polygon and the medium probability polygon is contained within the low probability polygon.
DEPTH A map of type depth. The InundationLevel represents the map depth - high/medium/low depth per location. The high depth polygon is contained within the medium depth polygon and the medium depth polygon is contained within the low depth polygon.

Methods

queryLatestFloodStatusByGaugeIds

 Query latest flood status by gauge ids.

searchLatestFloodStatusByArea

 Search latest flood status by geographical area.