Method: gauges.get

  • The endpoint allows retrieval of metadata about a specific gauge.

  • The HTTP request uses the GET method and requires a gauge name in the URL path.

  • The request body for this endpoint must be empty.

  • A successful response will contain an instance of the Gauge object in the response body.

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.