Method: gauges.queryGaugeForecasts

תחזיות של מדדי שאילתות.

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של שאילתה

פרמטרים
gaugeIds[]

string

חובה. רשימה של מזהי מדדים. גודל הרשימה הנתמך מוגבל ל-500. אם הרשימה גדולה מ-500, הפעולה תיכשל ותוצג השגיאה INVALID_REQUEST.
issuedTimeStart

string

אופציונלי. השעה המוקדמת ביותר שבה התחזית פורסמה כמחרוזת (ISO 8601), לדוגמה: ‎"2023-06-17T10:34:00Z"‎ או מחרוזת תאריך, לדוגמה: ‎"2023-10-13"‎. שעת ההתחלה לא יכולה להיות לפני 2023-10-01. ברירת המחדל היא לפני שבוע.
issuedTimeEnd

string

אופציונלי. השעה האחרונה שבה פורסמה התחזית כמחרוזת (ISO 8601), למשל '2023-06-17T10:34:00Z' או מחרוזת תאריך, למשל '2023-10-13'. ברירת המחדל היא 'עכשיו'.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

התשובה של gauges.queryGaugeForecasts.

אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "forecasts": {
    string: {
      object (ForecastSet)
    },
    ...
  }
}
שדות
forecasts

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

מפה ממזהה מדד לקבוצת תחזיות.

אובייקט שמכיל רשימה של "key": value זוגות. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

ForecastSet

קבוצה של תחזיות למדד.

ייצוג ב-JSON 
{
  "forecasts": [
    {
      object (Forecast)
    }
  ]
}
שדות
forecasts[]

object (Forecast)

התחזיות.

תחזית

תחזית של מדד יחיד לכמה זמני אספקה. לדוגמה, יכול להיות שזמן הבעיה בתחזית הוא 17:00, והיא כוללת תחזיות לשעות 18:00, 19:00, 20:00 וכו'.

הערה: יכול להיות שחלק מטווח התחזית יהיה מוקדם יותר מהשעה שבה התחזית פורסמה. לדוגמה, יכול להיות שהנתונים שמוזנים למודל לא מעודכנים. בדוגמה שלמעלה, יכול להיות ששעת הבעיה היא 17:00, וטווח התחזית הוא 16:00, 17:00, 18:00 וכו'.

הערה: אורך הטווחים והמרחק ביניהם משתנים. דוגמאות לטווחים אפשריים:

  1. ‫[5pm - 5pm], [6pm - 6pm], [7pm - 7pm]

  2. ‫[Mar 1 12am - Mar 2 12am], [Mar 2 12am - Mar 3 12am], [Mar 3 12am - Mar 4 12am]

ייצוג ב-JSON 
{
  "forecastRanges": [
    {
      object (ForecastTimedValue)
    }
  ],
  "gaugeId": string,
  "issuedTime": string
}
שדות
forecastRanges[]

object (ForecastTimedValue)

תחזית מורכבת מכמה 'טווחים של תחזיות', שהם ערכי תחזית שונים שמתייחסים לטווחים שונים של זמן. אם ההתחלה והסיום של טווח שווים, המשמעות היא שמדובר בנקודת זמן.
gaugeId

string

המזהה של מדד ההתקדמות שאליו מתייחסת התחזית הזו.
issuedTime

string

השעה שבה התחזית הונפקה (בפורמט ISO 8601), לדוגמה: ‎"2023-06-17T10:34:00Z". הזמן שבו התחזית הונפקה.

ForecastTimedValue

ערך תחזית שמתייחס לטווח זמן. היחידות שלו מוגדרות על ידי GaugeModel שאליו הוא משויך. אם תאריך ההתחלה ותאריך הסיום זהים, המשמעות היא שמדובר בנקודת זמן.

ייצוג ב-JSON 
{
  "value": number,
  "forecastStartTime": string,
  "forecastEndTime": string
}
שדות
value

number

ערך התחזית.
forecastStartTime

string

תחילת המרווח.
forecastEndTime

string

סוף המרווח.