REST Resource: gaugeModels

  • The GaugeModel resource provides metadata for a gauge's model, including its ID, thresholds, value unit, and quality verification status.

  • The Thresholds object defines the warning, danger, and extreme danger levels for a gauge's model.

  • The GaugeValueUnit enum specifies the possible units for a gauge's model values, such as meters or cubic meters per second.

  • Two methods, batchGet and get, are available to retrieve hydrological model metadata for multiple or individual gauges, respectively.

Resource: GaugeModel

Metadata of a gauge's model.

JSON representation 
{
  "gaugeId": string,
  "gaugeModelId": string,
  "thresholds": {
    object (Thresholds)
  },
  "gaugeValueUnit": enum (GaugeValueUnit),
  "qualityVerified": boolean
}
Fields
gaugeId

string

The ID of the gauge.
gaugeModelId

string

The ID of the gauge's model. From time to time, the model for a gauge may change, and in that case we'll assign a new ID and new thresholds to the new model. Please use caution when comparing old forecasts to new ones if they were produced by different models.
thresholds

object (Thresholds)

The thresholds of the gauge.
gaugeValueUnit

enum (GaugeValueUnit)

The value unit of the gauge's model.
qualityVerified

boolean

Whether this model is quality verified. Please use with caution when this value is set to false.

Thresholds

Thresholds of a gauge's model.

JSON representation 
{
  "warningLevel": number,
  "dangerLevel": number,
  "extremeDangerLevel": number
}
Fields
warningLevel

number

Warning level.
dangerLevel

number

Danger level.
extremeDangerLevel

number

Extreme danger level. Not always present.

GaugeValueUnit

Possible gauge value units.

Enums
GAUGE_VALUE_UNIT_UNSPECIFIED Default value. This value is unused.
METERS Meters.
CUBIC_METERS_PER_SECOND Cubic meters per second.

Methods

batchGet

 Get the current hydrological model metadata for multiple gauges.

get

 Get the current hydrological model metadata for a given gauge.