Method: gaugeModels.batchGet
Stay organized with collections
Save and categorize content based on your preferences.
Get the current hydrological model metadata for multiple gauges.
HTTP request
GET https://floodforecasting.googleapis.com/v1/gaugeModels:batchGet
The URL uses gRPC Transcoding syntax.
Query parameters
| Parameters |
names[] |
string
Required. The gauge model names to retrieve. Name format: gaugeModels/{gaugeId}. The supported list size is limited to 20,000. If a list larger than 20,000 is provided it fails with an INVALID_REQUEST error.
|
Request body
The request body must be empty.
Response body
The response of gaugeModels.batchGet.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"gaugeModels": [
{
object (GaugeModel)
}
]
} |
| Fields |
gaugeModels[] |
object (GaugeModel)
The requested gauge models.
|
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-09-01 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-09-01 UTC."],[[["\u003cp\u003eThis endpoint retrieves metadata for multiple hydrological gauge models.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request uses a \u003ccode\u003eGET\u003c/code\u003e method to the URL \u003ccode\u003ehttps://floodforecasting.googleapis.com/v1/gaugeModels:batchGet\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe required query parameter \u003ccode\u003enames[]\u003c/code\u003e specifies the gauge model names to retrieve, in the format: gaugeModels/{gaugeId}.\u003c/p\u003e\n"],["\u003cp\u003eThe request body for this endpoint must be empty.\u003c/p\u003e\n"],["\u003cp\u003eThe response body returns an array of gauge models in the JSON format.\u003c/p\u003e\n"]]],[],null,["- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.BatchGetGaugeModelsResponse.SCHEMA_REPRESENTATION)\n\nGet the current hydrological model metadata for multiple gauges.\n\nHTTP request\n\n`GET https://floodforecasting.googleapis.com/v1/gaugeModels:batchGet`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nQuery parameters\n\n| Parameters ||\n|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `names[]` | `string` Required. The gauge model names to retrieve. Name format: gaugeModels/{gaugeId}. The supported list size is limited to 20,000. If a list larger than 20,000 is provided it fails with an INVALID_REQUEST error. |\n\nRequest body\n\nThe request body must be empty.\n\nResponse body The response of gaugeModels.batchGet.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------|\n| ``` { \"gaugeModels\": [ { object (/flood-forecasting/rest/v1/gaugeModels#GaugeModel) } ] } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------|\n| `gaugeModels[]` | `object (`[GaugeModel](/flood-forecasting/rest/v1/gaugeModels#GaugeModel)`)` The requested gauge models. |"]]