REST Resource: gauges
Stay organized with collections
Save and categorize content based on your preferences.
Resource: Gauge
| JSON representation |
{
"location": {
object (LatLng)
},
"siteName": string,
"source": string,
"river": string,
"countryCode": string,
"gaugeId": string,
"qualityVerified": boolean,
"hasModel": boolean
} |
| Fields |
location |
object (LatLng)
The physical location of the gauge.
|
siteName |
string
The name of the site at which this gauge is located, in English. This is not a unique identifier; there may be several gauges in nearby locations with the same site name. Not always present.
|
source |
string
The organization responsible for the data of this gauge, e.g. GRDC, CWC, etc.
|
river |
string
The gauge's river name in English. Not always present.
|
countryCode |
string
The country code of the gauge's country (ISO 3166 Alpha-2).
|
gaugeId |
string
The ID of the gauge.
|
qualityVerified |
boolean
This field is true if the gauge 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.
|
hasModel |
boolean
This field is true if the gauge has a model. If the gauge has a model, it's possible to get this gauges's GaugeModel using gaugeModels.get or gaugeModels.batchGet. And also getting its forecasts using gauges.queryGaugeForecasts.
|
Methods |
|
|
Get metadata about multiple gauges. |
|
|
Get metadata about a gauge. |
|
|
Query gauge forecasts. |
|
|
Search for gauges by geographical area. |
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\u003eThe Gauge resource provides metadata about a specific gauge, including its location, site name, data source, river, country code, and unique ID.\u003c/p\u003e\n"],["\u003cp\u003eThe JSON representation of a Gauge includes fields such as \u003ccode\u003elocation\u003c/code\u003e, \u003ccode\u003esiteName\u003c/code\u003e, \u003ccode\u003esource\u003c/code\u003e, \u003ccode\u003eriver\u003c/code\u003e, \u003ccode\u003ecountryCode\u003c/code\u003e, \u003ccode\u003egaugeId\u003c/code\u003e, \u003ccode\u003equalityVerified\u003c/code\u003e, and \u003ccode\u003ehasModel\u003c/code\u003e, each with specific data types and meanings.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003equalityVerified\u003c/code\u003e field indicates if a gauge's model (if present) is quality-verified, and \u003ccode\u003ehasModel\u003c/code\u003e indicates the existence of a model for the gauge.\u003c/p\u003e\n"],["\u003cp\u003eThere are four methods available to interact with gauge data: \u003ccode\u003ebatchGet\u003c/code\u003e, \u003ccode\u003eget\u003c/code\u003e, \u003ccode\u003equeryGaugeForecasts\u003c/code\u003e, and \u003ccode\u003esearchGaugesByArea\u003c/code\u003e, allowing for retrieval of metadata, forecasts, and searching gauges within a specified area.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eGauge\u003c/code\u003e resource location is a LatLng object, and you can find more info on it by looking at the provided link.\u003c/p\u003e\n"]]],[],null,["# REST Resource: gauges\n\n- [Resource: Gauge](#Gauge)\n - [JSON representation](#Gauge.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Gauge\n---------------\n\nMetadata of a gauge.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"location\": { object (/flood-forecasting/rest/v1/LatLng) }, \"siteName\": string, \"source\": string, \"river\": string, \"countryCode\": string, \"gaugeId\": string, \"qualityVerified\": boolean, \"hasModel\": boolean } ``` |\n\n| Fields ||\n|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `location` | `object (`[LatLng](/flood-forecasting/rest/v1/LatLng)`)` The physical location of the gauge. |\n| `siteName` | `string` The name of the site at which this gauge is located, in English. This is not a unique identifier; there may be several gauges in nearby locations with the same site name. Not always present. |\n| `source` | `string` The organization responsible for the data of this gauge, e.g. GRDC, CWC, etc. |\n| `river` | `string` The gauge's river name in English. Not always present. |\n| `countryCode` | `string` The country code of the gauge's country (ISO 3166 Alpha-2). |\n| `gaugeId` | `string` The ID of the gauge. |\n| `qualityVerified` | `boolean` This field is true if the gauge 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. |\n| `hasModel` | `boolean` This field is true if the gauge has a model. If the gauge has a model, it's possible to get this gauges's [GaugeModel](/flood-forecasting/rest/v1/gaugeModels#GaugeModel) using [gaugeModels.get](/flood-forecasting/rest/v1/gaugeModels/get#google.research.floodforecasting.v1.FloodsApi.GetGaugeModel) or [gaugeModels.batchGet](/flood-forecasting/rest/v1/gaugeModels/batchGet#google.research.floodforecasting.v1.FloodsApi.BatchGetGaugeModels). And also getting its forecasts using [gauges.queryGaugeForecasts](/flood-forecasting/rest/v1/gauges/queryGaugeForecasts#google.research.floodforecasting.v1.FloodsApi.QueryGaugeForecasts). |\n\n| Methods ------- ||\n|----------------------------------------------------------------------------------|-----------------------------------------|\n| ### [batchGet](/flood-forecasting/rest/v1/gauges/batchGet) | Get metadata about multiple gauges. |\n| ### [get](/flood-forecasting/rest/v1/gauges/get) | Get metadata about a gauge. |\n| ### [queryGaugeForecasts](/flood-forecasting/rest/v1/gauges/queryGaugeForecasts) | Query gauge forecasts. |\n| ### [searchGaugesByArea](/flood-forecasting/rest/v1/gauges/searchGaugesByArea) | Search for gauges by geographical area. |"]]