Method: floodStatus.searchLatestFloodStatusByArea

חיפוש הסטטוס העדכני של שיטפונות לפי אזור גיאוגרפי. הערה: הפונקציה מחזירה את סטטוסי השיטפונות שבהם המדד נמצא באזור שצוין, ולא למשל את האזור שנפגע שחופף לאזור שצוין. הדבר עשוי להשתנות בעתיד.

בקשת HTTP

POST https://floodforecasting.googleapis.com/v1/floodStatus:searchLatestFloodStatusByArea

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

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "pageToken": string,
  "pageSize": integer,

  // Union field area_type can be only one of the following:
  "regionCode": string,
  "loop": {
    object (Loop)
  }
  // End of list of possible types for union field area_type.
  "includeNonQualityVerified": boolean
}
שדות
pageToken

string

אופציונלי. טוקן של דף שהתקבל מקריאה קודמת של floodStatus.searchLatestFloodStatusByArea. צריך להזין את הטוקן כדי לאחזר את הדף הבא. כשמבצעים חלוקה לעמודים, כל הפרמטרים האחרים שסופקו ל-floodStatus.searchLatestFloodStatusByArea חייבים להיות זהים לקריאה שסיפקה את הטוקן של הדף.
pageSize

integer

אופציונלי. מספר הסטטוסים המקסימלי של הצפות שיחזרו. יכול להיות שהשירות יחזיר פחות מהערך הזה. אם לא מציינים ערך, המערכת תחזיר לכל היותר 20,000 סטטוסים של הצפות. הערך המקסימלי הוא 20,000. ערכים גבוהים יותר יומרו ל-20,000.

שדה איחוד area_type.

הערך area_type יכול להיות רק אחד מהערכים הבאים:
regionCode

string

האזור שרוצים לשאול לגביו על מצב השיטפון. שימוש ב-CLDR, לדוגמה: ‫'US'.
loop

object (Loop)

הלולאה שבאמצעותה מתבצעת שאילתה לגבי סטטוסים של שיטפונות.
includeNonQualityVerified

boolean

אופציונלי. הכללה בתוצאה של מדדים שלא עברו אימות איכות. חשוב להשתמש בזהירות. ברירת המחדל היא False.

גוף התשובה

התשובה של floodStatus.searchLatestFloodStatusByArea.

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

ייצוג ב-JSON 
{
  "floodStatuses": [
    {
      object (FloodStatus)
    }
  ],
  "nextPageToken": string
}
שדות
floodStatuses[]

object (FloodStatus)

הסטטוסים האחרונים של השיטפונות באזור המבוקש. בשלב הזה, המיקום של המדדים קובע את הסדר, אבל זה עשוי להשתנות בעתיד.
nextPageToken

string

אופציונלי. טוקן שאפשר לשלוח כ-pageToken כדי לאחזר את הדף הבא. אם משמיטים את השדה הזה, לא יופיעו דפים נוספים.