Method: gaugeModels.batchGet

  • You can retrieve current hydrological model metadata for multiple gauges using a GET request to https://floodforecasting.googleapis.com/v1/gaugeModels:batchGet.

  • The only required query parameter is names[], which is a list of gauge model names formatted as gaugeModels/{gaugeId}, with a limit of 20,000 names.

  • The request body for this operation must be empty.

  • A successful response will contain a JSON object with a single field, gaugeModels, which is an array of GaugeModel objects.

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.