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 を超える値は 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 として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。