Method: gauges.queryGaugeForecasts

Prognosen für Messgeräte abfragen.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
gaugeIds[]

string

Erforderlich. Eine Liste von Mess-IDs. Die unterstützte Listengröße ist auf 500 Einträge begrenzt. Wenn eine Liste mit mehr als 500 Elementen angegeben wird, schlägt der Vorgang mit dem Fehler INVALID_REQUEST fehl.
issuedTimeStart

string

Optional. Die früheste Prognosezeit als String (ISO 8601), z.B. „2023-06-17T10:34:00Z“ oder ein Datumsstring, z.B. „2023-10-13“. Die Startzeit darf nicht vor dem 01.10.2023 liegen. Der Standardwert ist „vor einer Woche“.
issuedTimeEnd

string

Optional. Die Uhrzeit der letzten Prognose als String (ISO 8601), z.B. „2023-06-17T10:34:00Z“ oder ein Datumsstring, z.B. „2023-10-13“. Der Standardwert ist „Jetzt“.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Die Antwort von „gauges.queryGaugeForecasts“.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "forecasts": {
    string: {
      object (ForecastSet)
    },
    ...
  }
}
Felder
forecasts

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

Eine Zuordnung von Messgeräte-IDs zu Prognosesets.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

ForecastSet

Eine Reihe von Prognosen für ein Messgerät.

JSON-Darstellung 
{
  "forecasts": [
    {
      object (Forecast)
    }
  ]
}
Felder
forecasts[]

object (Forecast)

Die Prognosen.

Prognose

Die Prognose für einen einzelnen Messpunkt für mehrere Vorlaufzeiten. Eine Prognose kann beispielsweise um 17:00 Uhr erstellt werden und Prognosen für 18:00, 19:00, 20:00 Uhr usw. enthalten.

Hinweis: Einige der Prognosebereiche können potenziell früher als der Ausstellungszeitpunkt liegen. Das kann beispielsweise an Verzögerungen bei den Eingabedaten für das Modell liegen. Im obigen Beispiel könnte die Uhrzeit des Problems 17:00 Uhr sein und die Prognosebereiche für 16:00 Uhr, 17:00 Uhr, 18:00 Uhr usw.

Hinweis: Die Bereiche variieren in Länge und Abstand zueinander. Hier einige Beispiele für mögliche Bereiche:

  1. [17:00–17:00], [18:00–18:00], [19:00–19:00]

  2. [1. März, 00:00 Uhr – 2. März, 00:00 Uhr], [2. März, 00:00 Uhr – 3. März, 00:00 Uhr], [3. März, 00:00 Uhr – 4. März, 00:00 Uhr]

JSON-Darstellung 
{
  "forecastRanges": [
    {
      object (ForecastTimedValue)
    }
  ],
  "gaugeId": string,
  "issuedTime": string
}
Felder
forecastRanges[]

object (ForecastTimedValue)

Eine Prognose besteht aus mehreren „Prognosebereichen“, die unterschiedliche Prognosewerte für unterschiedliche Zeiträume enthalten. Wenn Start und Ende eines Bereichs gleich sind, handelt es sich um einen Zeitpunkt.
gaugeId

string

Die ID des Messgeräts, für das diese Prognose erstellt wurde.
issuedTime

string

Die Ausstellungszeit des Vorhersagezeitraums (ISO 8601), z.B. „2023-06-17T10:34:00Z“. Der Zeitpunkt, zu dem die Prognose erstellt wurde.

ForecastTimedValue

Ein Prognosewert für einen Zeitraum. Die Einheiten werden durch das zugehörige GaugeModel definiert. Wenn Start und Ende gleich sind, handelt es sich um einen Zeitpunkt.

JSON-Darstellung 
{
  "value": number,
  "forecastStartTime": string,
  "forecastEndTime": string
}
Felder
value

number

Der Wert der Prognose.
forecastStartTime

string

Der Beginn des Intervalls.
forecastEndTime

string

Das Ende des Intervalls.