REST Resource: gaugeModels
Stay organized with collections
Save and categorize content based on your preferences.
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 |
|
|
Get the current hydrological model metadata for multiple gauges. |
|
|
Get the current hydrological model metadata for a given gauge. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-05 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-05 UTC."],[[["\u003cp\u003eGauge models contain metadata, including a unique ID, thresholds, value unit, and a quality verification status.\u003c/p\u003e\n"],["\u003cp\u003eThresholds define the warning, danger, and extreme danger levels for a specific gauge.\u003c/p\u003e\n"],["\u003cp\u003eThe value unit of a gauge can be specified as meters, cubic meters per second, or unspecified.\u003c/p\u003e\n"],["\u003cp\u003eThere are methods available to fetch the metadata for one, or many gauge models at once.\u003c/p\u003e\n"]]],[],null,["# REST Resource: gaugeModels\n\n- [Resource: GaugeModel](#GaugeModel)\n - [JSON representation](#GaugeModel.SCHEMA_REPRESENTATION)\n- [Thresholds](#Thresholds)\n - [JSON representation](#Thresholds.SCHEMA_REPRESENTATION)\n- [GaugeValueUnit](#GaugeValueUnit)\n- [Methods](#METHODS_SUMMARY)\n\nResource: GaugeModel\n--------------------\n\nMetadata of a gauge's model.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"gaugeId\": string, \"gaugeModelId\": string, \"thresholds\": { object (/flood-forecasting/rest/v1/gaugeModels#Thresholds) }, \"gaugeValueUnit\": enum (/flood-forecasting/rest/v1/gaugeModels#GaugeValueUnit), \"qualityVerified\": boolean } ``` |\n\n| Fields ||\n|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `gaugeId` | `string` The ID of the gauge. |\n| `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. |\n| `thresholds` | `object (`[Thresholds](/flood-forecasting/rest/v1/gaugeModels#Thresholds)`)` The thresholds of the gauge. |\n| `gaugeValueUnit` | `enum (`[GaugeValueUnit](/flood-forecasting/rest/v1/gaugeModels#GaugeValueUnit)`)` The value unit of the gauge's model. |\n| `qualityVerified` | `boolean` Whether this model is quality verified. Please use with caution when this value is set to false. |\n\nThresholds\n----------\n\nThresholds of a gauge's model.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------|\n| ``` { \"warningLevel\": number, \"dangerLevel\": number, \"extremeDangerLevel\": number } ``` |\n\n| Fields ||\n|----------------------|----------------------------------------------------|\n| `warningLevel` | `number` Warning level. |\n| `dangerLevel` | `number` Danger level. |\n| `extremeDangerLevel` | `number` Extreme danger level. Not always present. |\n\nGaugeValueUnit\n--------------\n\nPossible gauge value units.\n\n| Enums ||\n|--------------------------------|--------------------------------------|\n| `GAUGE_VALUE_UNIT_UNSPECIFIED` | Default value. This value is unused. |\n| `METERS` | Meters. |\n| `CUBIC_METERS_PER_SECOND` | Cubic meters per second. |\n\n| Methods ------- ||\n|-----------------------------------------------------------------|------------------------------------------------------------------|\n| ### [batchGet](/flood-forecasting/rest/v1/gaugeModels/batchGet) | Get the current hydrological model metadata for multiple gauges. |\n| ### [get](/flood-forecasting/rest/v1/gaugeModels/get) | Get the current hydrological model metadata for a given gauge. |"]]