Method: gauges.queryGaugeForecasts

Zapytania o prognozy pomiarów.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
gaugeIds[]

string

Wymagany. Lista identyfikatorów mierników. Obsługiwany rozmiar listy jest ograniczony do 500. Jeśli podana lista jest większa niż 500, zwracany jest błąd INVALID_REQUEST.
issuedTimeStart

string

Opcjonalnie. Najwcześniejszy czas wydania prognozy w formacie ciągu znaków (ISO 8601), np. „2023-06-17T10:34:00Z” lub ciąg znaków daty, np. „2023-10-13”. Godzina rozpoczęcia nie może przypadać wcześniej niż „2023-10-01”. Domyślnie jest to tydzień temu.
issuedTimeEnd

string

Opcjonalnie. Najnowszy czas wydania prognozy w formie ciągu znaków (ISO 8601), np. „2023-06-17T10:34:00Z” lub ciągu znaków daty, np. „2023-10-13”. Wartość domyślna to teraz.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź funkcji gauges.queryGaugeForecasts.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "forecasts": {
    string: {
      object (ForecastSet)
    },
    ...
  }
}
Pola
forecasts

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

Mapa identyfikatorów wskaźników do zestawu prognoz.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

ForecastSet

Zestaw prognoz dla miernika.

Zapis JSON 
{
  "forecasts": [
    {
      object (Forecast)
    }
  ]
}
Pola
forecasts[]

object (Forecast)

prognozy,

Prognoza

Prognoza dla jednego wskaźnika dla kilku czasów oczekiwania. Na przykład prognoza może być wydana o 17:00 i zawierać prognozy na 18:00, 19:00, 20:00 itd.

Uwaga: niektóre zakresy prognoz mogą być wcześniejsze niż czas wydania. Może to być spowodowane np. opóźnieniami w dostarczaniu danych wejściowych do modelu. W powyższym przykładzie czas problemu może wynosić 17:00, a przedziały prognozy to 16:00, 17:00, 18:00 itd.

Uwaga: zakresy różnią się długością i odległością między nimi. Przykłady możliwych zakresów:

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

  2. [1 marca, godz. 0:00 – 2 marca, godz. 0:00], [2 marca, godz. 0:00 – 3 marca, godz. 0:00], [3 marca, godz. 0:00 – 4 marca, godz. 0:00]

Zapis JSON 
{
  "forecastRanges": [
    {
      object (ForecastTimedValue)
    }
  ],
  "gaugeId": string,
  "issuedTime": string
}
Pola
forecastRanges[]

object (ForecastTimedValue)

Prognoza składa się z kilku „zakresów prognozy”, czyli różnych wartości prognozy dotyczących różnych zakresów czasu. Gdy początek i koniec zakresu są równe, oznacza to, że jest to moment w czasie.
gaugeId

string

Identyfikator urządzenia pomiarowego, którego dotyczy ta prognoza.
issuedTime

string

Czas wydania prognozy (ISO 8601), np. „2023-06-17T10:34:00Z”. Czas wydania to czas wygenerowania prognozy.

ForecastTimedValue

Wartość prognozy dotycząca zakresu czasu. Jednostki są zdefiniowane przez powiązany z nią GaugeModel. Jeśli czas rozpoczęcia i zakończenia są równe, oznacza to, że jest to moment w czasie.

Zapis JSON 
{
  "value": number,
  "forecastStartTime": string,
  "forecastEndTime": string
}
Pola
value

number

Wartość prognozy.
forecastStartTime

string

Początek przedziału.
forecastEndTime

string

Koniec przedziału.