Method: gauges.get
Stay organized with collections
Save and categorize content based on your preferences.
Get metadata about a gauge.
HTTP request
GET https://floodforecasting.googleapis.com/v1/{name=gauges/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. The name of the gauge to retrieve. Name format: gauges/{gaugeId}.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of 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 2024-10-31 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 2024-10-31 UTC."],[[["\u003cp\u003eThe webpage provides details on retrieving metadata for a specific gauge using the Flood Forecasting API.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request method for retrieving gauge data is a \u003ccode\u003eGET\u003c/code\u003e request to a specific URL endpoint.\u003c/p\u003e\n"],["\u003cp\u003eA \u003ccode\u003ename\u003c/code\u003e path parameter, in the format \u003ccode\u003egauges/{gaugeId}\u003c/code\u003e, is required to specify which gauge to retrieve.\u003c/p\u003e\n"],["\u003cp\u003eThe request body for this operation must be left empty.\u003c/p\u003e\n"],["\u003cp\u003eA successful response will include an instance of the \u003ccode\u003eGauge\u003c/code\u003e object containing the requested metadata.\u003c/p\u003e\n"]]],[],null,["# Method: gauges.get\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n\nGet metadata about a gauge.\n\n### HTTP request\n\n`GET https://floodforecasting.googleapis.com/v1/{name=gauges/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|--------------------------------------------------------------------------------------|\n| `name` | `string` Required. The name of the gauge to retrieve. Name format: gauges/{gaugeId}. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [Gauge](/flood-forecasting/rest/v1/gauges#Gauge)."]]