Method: gauges.queryGaugeForecasts

Interroger les prévisions des jauges.

Requête HTTP

GET https://floodforecasting.googleapis.com/v1/gauges:queryGaugeForecasts

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
gaugeIds[]

string

Obligatoire. Liste des ID de jauges. La taille de la liste acceptée est limitée à 500. Si une liste de plus de 500 éléments est fournie, une erreur INVALID_REQUEST est générée.
issuedTimeStart

string

Facultatif. Heure d'émission de la prévision la plus ancienne sous forme de chaîne (ISO 8601), par exemple "2023-06-17T10:34:00Z" ou une chaîne de date, par exemple "2023-10-13". L'heure de début ne peut pas être antérieure au "2023-10-01". La valeur par défaut est "Il y a une semaine".
issuedTimeEnd

string

Facultatif. Heure d'émission des dernières prévisions sous forme de chaîne (ISO 8601), par exemple "2023-06-17T10:34:00Z" ou une chaîne de date, par exemple "2023-10-13". La valeur par défaut est "now".

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Réponse de gauges.queryGaugeForecasts.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "forecasts": {
    string: {
      object (ForecastSet)
    },
    ...
  }
}
Champs
forecasts

map (key: string, value: object (ForecastSet))

Mappage de l'ID du compteur à l'ensemble de prévisions.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

ForecastSet

Ensemble de prévisions pour une jauge.

Représentation JSON 
{
  "forecasts": [
    {
      object (Forecast)
    }
  ]
}
Champs
forecasts[]

object (Forecast)

Les prévisions.

Prévision

Prévisions d'une seule jauge pour plusieurs délais. Par exemple, une prévision peut avoir une heure d'émission de 17h et inclure des prévisions pour 18h, 19h, 20h, etc.

Remarque : Certaines plages de prévisions peuvent être antérieures à l'heure d'émission. Cela peut se produire, par exemple, en raison de décalages dans les données d'entrée du modèle. Dans l'exemple ci-dessus, il se peut que l'heure du problème soit 17h et que les plages de prévision soient 16h, 17h, 18h, etc.

Remarque : Les plages varient en longueur et en distance entre elles. Voici quelques exemples de plages possibles :

  1. [17h-17h], [18h-18h], [19h-19h]

  2. [1er mars à minuit – 2 mars à minuit], [2 mars à minuit – 3 mars à minuit], [3 mars à minuit – 4 mars à minuit]

Représentation JSON 
{
  "forecastRanges": [
    {
      object (ForecastTimedValue)
    }
  ],
  "gaugeId": string,
  "issuedTime": string
}
Champs
forecastRanges[]

object (ForecastTimedValue)

Une prévision se compose de plusieurs "plages de prévision", qui sont différentes valeurs de prévision se rapportant à différentes périodes. Lorsque le début et la fin d'une plage sont égaux, cela signifie qu'il s'agit d'un instant précis.
gaugeId

string

ID de la jauge à laquelle s'applique cette prévision.
issuedTime

string

Heure d'émission des prévisions (ISO 8601), par exemple "2023-06-17T10:34:00Z". La date d'émission correspond à la date à laquelle la prévision a été générée.

ForecastTimedValue

Valeur de prévision associée à une période. Ses unités sont définies par le GaugeModel auquel il est associé. Si le début et la fin sont égaux, cela signifie qu'il s'agit d'un instant précis.

Représentation JSON 
{
  "value": number,
  "forecastStartTime": string,
  "forecastEndTime": string
}
Champs
value

number

Valeur de la prévision.
forecastStartTime

string

Début de l'intervalle.
forecastEndTime

string

Fin de l'intervalle.