Method: floodStatus.searchLatestFloodStatusByArea

按地理区域搜索最新洪水状况。注意:返回 gauge 位于指定区域内的洪水状态,而不是例如与指定区域相交的受影响区域。但将来这项优惠可能会发生变化。

HTTP 请求

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

网址采用 gRPC 转码语法。

请求正文

请求正文中包含结构如下的数据:

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 的值会强制转换为 20,000。

联合字段 area_type

area_type 只能是下列其中一项:

regionCode

string

用于查询洪水状态的区域。使用 CLDR,例如 'US'。

loop

object (Loop)

用于查询 Flood 状态的循环。

includeNonQualityVerified

boolean

可选。在结果仪表中包含未经过质量验证的指标。请谨慎使用。默认值为 false。

响应正文

floodStatus.searchLatestFloodStatusByArea 的响应。

如果成功,响应正文将包含结构如下的数据:

JSON 表示法
{
  "floodStatuses": [
    {
      object (FloodStatus)
    }
  ],
  "nextPageToken": string
}
字段
floodStatuses[]

object (FloodStatus)

所请求区域的最新洪水状态。目前,此设置取决于仪表的位置,但将来可能会发生变化。

nextPageToken

string

可选。可作为 pageToken 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。