Package google.research.floodforecasting.v1

Индекс

FloodsApi

Внешний API-сервис для прогнозирования наводнений.

BatchGetGaugeModels

rpc BatchGetGaugeModels( BatchGetGaugeModelsRequest ) returns ( BatchGetGaugeModelsResponse )

Получите текущие метаданные гидрологической модели для нескольких датчиков.

BatchGetGauges

rpc BatchGetGauges( BatchGetGaugesRequest ) returns ( BatchGetGaugesResponse )

Получите метаданные о нескольких датчиках.

GetGauge

rpc GetGauge( GetGaugeRequest ) returns ( Gauge )

Получите метаданные о датчике.

GetGaugeModel

rpc GetGaugeModel( GetGaugeModelRequest ) returns ( GaugeModel )

Получите текущие метаданные гидрологической модели для заданного датчика.

GetSerializedPolygon

rpc GetSerializedPolygon( GetSerializedPolygonRequest ) returns ( SerializedPolygon )

Получите сериализованный полигон. Идентификаторы этих объектов будут отображаться в других ответах API, и вы сможете использовать их здесь. Например, см. InundationMap в FloodStatus .

QueryGaugeForecasts

rpc QueryGaugeForecasts( QueryGaugeForecastsRequest ) returns ( QueryGaugeForecastsResponse )

Прогнозы датчиков запросов.

QueryLatestFloodStatusByGaugeIds

rpc QueryLatestFloodStatusByGaugeIds( QueryLatestFloodStatusByGaugeIdsRequest ) returns ( QueryLatestFloodStatusByGaugeIdsResponse )

Запросить последний статус наводнения по идентификаторам датчиков.

Поиск датчиков по площади

rpc SearchGaugesByArea( SearchGaugesByAreaRequest ) returns ( SearchGaugesByAreaResponse )

Поиск датчиков по географическому региону.

Примечание: датчики время от времени добавляются и удаляются, поэтому результаты этого API не следует кэшировать или хранить в течение длительного времени. Для относительной безопасности рекомендуется хранить данные не более суток.

ПоискПоследнегоСтатусаЗатопленияПоРайону

rpc SearchLatestFloodStatusByArea( SearchLatestFloodStatusByAreaRequest ) returns ( SearchLatestFloodStatusByAreaResponse )

Поиск последних данных о наводнениях по географическому региону. Примечание: Возвращает данные о наводнениях, уровень которых находится в пределах заданного региона, а не, например, в зоне, находящейся под воздействием и пересекающейся с заданным регионом. Это может измениться в будущем.

Пакетный запрос на получение калибровочных моделей

Запрос BatchGetGaugeModels.

Поля
names[]

string

Обязательно. Имена моделей датчиков, которые необходимо получить. Формат имени: gaugeModels/{gauge_id}. Поддерживаемый размер списка ограничен 20 000. Если предоставлен список больше 20 000, возникает ошибка INVALID_REQUEST.

BatchGetGaugeModelsResponse

Ответ BatchGetGaugeModels.

Поля
gauge_models[]

GaugeModel

Запрашиваемые модели датчиков.

BatchGetGaugesRequest

Запрос BatchGetGauges.

Поля
names[]

string

Обязательно. Имена датчиков, которые необходимо получить. Формат имени: gauges/{gauge_id}. Поддерживаемый размер списка ограничен 100 000. Если предоставлен список больше 100 000, возникает ошибка INVALID_REQUEST.

BatchGetGaugesResponse

Ответ BatchGetGauges.

Поля
gauges[]

Gauge

Запрошенные датчики.

FloodStatus

Статус наводнения, выдаваемый системой. Отображает прогнозируемую системой степень наводнения для данной территории, включая такие атрибуты, как интенсивность, изменение прогноза, карты затопления и другие. Подробнее см. ниже.

Поля
gauge_id

string

Идентификатор датчика, для которого был присвоен этот статус.

quality_verified

bool

Значение true, если у прибора, для которого был присвоен этот статус наводнения, нет модели, или если у него есть модель, и её качество проверено. Используйте с осторожностью, если это значение равно false.

gauge_location

LatLng

Местоположение датчика, для которого был присвоен этот статус.

issued_time

string

Время присвоения статуса в виде строки (ISO 8601), например, «2023-06-17T10:34:00Z».

forecast_time_range

TimeRange

Временной диапазон, на который дается прогноз.

forecast_change

ForecastChange

Изменение прогнозируемого значения от последнего известного значения до прогнозируемого. В настоящее время доступно только для моделей уровня воды.

forecast_trend

ForecastTrend

Тенденция прогноза.

map_inference_type

MapInferenceType

Тип вывода, с помощью которого была создана эта карта.

severity

Severity

Тяжесть состояния.

inundation_map_set

InundationMapSet

Предполагаемый набор карт затоплений.

source

string

Организация, ответственная за данные этого датчика, например, GRDC, CWC и т. д.

serialized_notification_polygon_id

string

Идентификатор сериализованного полигона уведомлений, представляющий географическую область, которую Google использует для определения времени оповещения пользователей. Для получения самого сериализованного полигона используйте GetSerializedPolygon .

ПрогнозИзменения

Прогнозируемое изменение значения от последнего известного значения до прогнозируемого. В настоящее время доступно только для моделей уровня воды.

Поля
value_change

ValueChange

Прогнозируемое изменение значений.

reference_time_range

TimeRange

Временной диапазон последнего известного состояния, на основе которого мы прогнозируем изменение значения. Например, у нас может быть задан базовый временной диапазон на вчерашний день и изменение значения на 25–30 см. Это означает, что повышение уровня воды на 25–30 см сравнивается со вчерашним значением, а не с текущим.

ИзменениеЗначения

Прогнозируемое изменение значений — верхняя и нижняя граница.

Поля
lower_bound

double

Нижняя граница прогнозируемого изменения температуры в метрах. Если изменение находится в диапазоне от 20 до 30, это значение будет равно 20. Если изменение находится в диапазоне от -30 до -20, это значение будет равно -30.

upper_bound

double

Верхняя граница прогнозируемого изменения температуры в метрах. Если изменение находится в диапазоне от 20 до 30, это значение будет равно 30. Если изменение находится в диапазоне от -30 до -20, это значение будет равно -20.

ПрогнозТренд

Перечисление, представляющее тенденцию прогноза.

Перечисления
FORECAST_TREND_UNSPECIFIED Значение по умолчанию. Это значение не используется.
RISE Это указывает на рост прогнозируемого значения.
FALL Это указывает на падение прогнозируемого значения.
NO_CHANGE Это указывает на отсутствие изменений в прогнозируемом значении.

Карта затоплений

Одна карта затоплений.

Поля
level

InundationLevel

Уровень карты затопления — см. документацию на основе InundationMapType.

serialized_polygon_id

string

Идентификатор сериализованного полигона, представляющего эту карту риска затопления. Для получения самого сериализованного полигона используйте GetSerializedPolygon .

Уровень затопления

Перечисление, представляющее уровни затопления.

Перечисления
INUNDATION_LEVEL_UNSPECIFIED Значение по умолчанию. Это значение не используется.
HIGH См. документацию по InundationMapType.
MEDIUM См. документацию по InundationMapType.
LOW См. документацию по InundationMapType.

InundationMapSet

Комплект карт затоплений.

Поля
inundation_maps[]

InundationMap

Карты затоплений, по одной для каждого уровня затопления.

inundation_maps_time_range

TimeRange

Временной диапазон штата, к которому относятся карты затоплений.

inundation_map_type

InundationMapType

Тип карты затоплений.

InundationMapType

Перечисление, представляющее тип карты затоплений.

Перечисления
INUNDATION_MAP_TYPE_UNSPECIFIED Значение по умолчанию. Это значение не используется.
PROBABILITY Карта вероятности. Уровень затопления (InundationLevel) отображает вероятность затопления на карте: высокую/среднюю/низкую. Полигон высокой вероятности находится внутри полигона средней вероятности, а полигон средней вероятности — внутри полигона низкой вероятности.
DEPTH Карта глубины. Уровень затопления отображает глубину карты — высокую/среднюю/низкую глубину для каждой локации. Полигон высокой глубины находится внутри полигона средней глубины, а полигон средней глубины — внутри полигона низкой глубины.

MapInferenceType

Перечисление, представляющее типы выводов карты.

Перечисления
MAP_INFERENCE_TYPE_UNSPECIFIED Значение по умолчанию. Это значение не используется.
MODEL Это указывает на то, что данный вывод был создан с использованием модели.
IMAGE_CLASSIFICATION Это указывает на то, что данный вывод был сделан с использованием классификации изображений.

Серьезность

Перечисление, представляющее серьезность статуса.

Перечисления
SEVERITY_UNSPECIFIED Значение по умолчанию. Это значение не используется.
EXTREME Это указывает на прогнозируемую экстремальную ситуацию.
SEVERE Это указывает на прогнозируемое тяжелое состояние.
ABOVE_NORMAL Это указывает на прогнозируемое превышение нормы.
NO_FLOODING Это указывает на отсутствие прогноза наводнений.
UNKNOWN Это говорит о том, что у нас недостаточно информации для определения степени серьезности.

Прогноз

Прогноз одного датчика на несколько сроков. Например, прогноз может быть выпущен в 17:00 и включать прогнозы на 18:00, 19:00, 20:00 и т. д.

Примечание: Некоторые диапазоны прогноза могут быть более ранними, чем время выпуска. Это может произойти, например, из-за задержек во входных данных модели. В приведенном выше примере время выпуска может быть 17:00, а диапазоны прогноза — 16:00, 17:00, 18:00 и т. д.

Примечание: Хребты различаются по длине и расстоянию между ними. Вот несколько примеров возможных хребтов:

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

  2. [1 марта 00:00 - 2 марта 00:00], [2 марта 00:00 - 3 марта 00:00], [3 марта 00:00 - 4 марта 00:00]

Поля
forecast_ranges[]

ForecastTimedValue

Прогноз состоит из нескольких «диапазонов прогноза» — различных значений прогноза, относящихся к разным временным диапазонам. Когда начало и конец диапазона совпадают, это означает, что это один момент времени.

gauge_id

string

Идентификатор датчика, для которого предназначен этот прогноз.

issued_time

string

Время выпуска прогноза (ISO 8601), например, «2023-06-17T10:34:00Z». Время выпуска — это время создания прогноза.

ForecastSet

Набор прогнозов для датчика.

Поля
forecasts[]

Forecast

Прогнозы.

ForecastTimedValue

Прогнозируемое значение, относящееся к определённому временному диапазону. Единицы измерения определяются связанной с ним моделью GaugeModel. Если начальное и конечное значения совпадают, это означает, что это момент времени.

Поля
value

double

Ценность прогноза.

forecast_start_time

string

Начало интервала.

forecast_end_time

string

Конец интервала.

Измерять

Метаданные датчика.

Поля
location

LatLng

Физическое расположение датчика.

site_name

string

Название места, где расположен данный датчик, на английском языке. Это не уникальный идентификатор; поблизости может быть несколько датчиков с таким же названием. Не всегда присутствует.

source

string

Организация, ответственная за данные этого датчика, например GRDC, CWC и т. д.

river

string

Название реки на спидометре на английском языке. Отображается не всегда.

country_code

string

Код страны, в которой находится датчик (ISO 3166 Alpha-2).

gauge_id

string

Идентификатор датчика.

quality_verified

bool

Это поле имеет значение true, если у датчика нет модели или есть модель, и её качество проверено. Используйте с осторожностью, если это значение равно false.

has_model

bool

Это поле имеет значение true, если у датчика есть модель. Если у датчика есть модель, можно получить GaugeModel этого датчика с помощью GetGaugeModel или BatchGetGaugeModels . Также можно получить его прогнозы с помощью QueryGaugeForecasts .

GaugeModel

Метаданные модели датчика.

Поля
gauge_id

string

Идентификатор датчика.

gauge_model_id

string

Идентификатор модели датчика. Время от времени модель датчика может меняться, и в этом случае мы присваиваем новой модели новый идентификатор и новые пороговые значения. Пожалуйста, будьте осторожны при сравнении старых прогнозов с новыми, если они были получены с помощью разных моделей.

thresholds

Thresholds

Пороги датчика.

gauge_value_unit

GaugeValueUnit

Единица измерения модели датчика.

quality_verified

bool

Проверена ли эта модель на качество? Используйте с осторожностью, если это значение равно false.

GaugeValueUnit

Возможные единицы измерения.

Перечисления
GAUGE_VALUE_UNIT_UNSPECIFIED Значение по умолчанию. Это значение не используется.
METERS Метры.
CUBIC_METERS_PER_SECOND Кубические метры в секунду.

GetGaugeModelRequest

Запрос GetGaugeModel.

Поля
name

string

Обязательно. Имя модели датчика, которое необходимо получить. Формат имени: gaugeModels/{gauge_id}.

GetGaugeRequest

Запрос GetGauge.

Поля
name

string

Обязательно. Имя извлекаемого датчика. Формат имени: gauges/{gauge_id}.

GetSerializedPolygonRequest

Запрос GetSerializedPolygon.

Поля
name

string

Обязательно. Имя сериализованного полигона, который нужно получить. Формат имени: serializedPolygons/{polygon_id}

Петля

Петля на карте. Представляет собой простой сферический многоугольник. Она состоит из одной цепочки вершин, где первая вершина неявно связана с последней.

Поля
vertices[]

LatLng

Обязательно. Вершины цикла.

ЗапросGaugeForecastsRequest

Запрос QueryGaugeForecasts.

Поля
gauge_ids[]

string

Обязательно. Список идентификаторов датчиков. Поддерживаемый размер списка ограничен 500. Если список больше 500, возникает ошибка INVALID_REQUEST.

issued_time_start

string

Необязательно. Самое раннее время выпуска прогноза в виде строки (ISO 8601), например, «2023-06-17T10:34:00Z», или строки даты, например, «2023-10-13». Время начала не может быть раньше «2023-10-01». Значение по умолчанию — неделя назад.

issued_time_end

string

Необязательно. Время выпуска последнего прогноза в виде строки (ISO 8601), например, «2023-06-17T10:34:00Z», или строка даты, например, «2023-10-13». Значение по умолчанию — «сейчас».

QueryGaugeForecastsResponse

Ответ QueryGaugeForecasts.

Поля
forecasts

map<string, ForecastSet >

Карта от идентификатора датчика до набора прогнозов.

ЗапросLatestFloodStatusByGaugeIdsRequest

Запрос QueryLatestFloodStatusByGaugeIds.

Поля
gauge_ids[]

string

Обязательно. Список идентификаторов датчиков. Поддерживаемый размер списка ограничен 20 000. Если список больше 20 000, возникает ошибка INVALID_REQUEST.

ЗапросLatestFloodStatusByGaugeIdsResponse

Ответ QueryLatestFloodStatusByGaugeIds.

Поля
flood_statuses[]

FloodStatus

Последние данные о наводнениях по запрошенным датчикам.

SearchGaugesByAreaRequest

Запрос SearchGaugesByArea.

Поля
page_size

int32

Необязательно. Максимальное количество возвращаемых датчиков. Сервис может вернуть меньше этого значения. Если не указано, будет возвращено не более 50 000 датчиков. Максимальное значение — 50 000; значения выше 50 000 будут преобразованы в 50 000.

page_token

string

Необязательный. Токен страницы, полученный из предыдущего вызова SearchGauges . Укажите его для получения следующей страницы. При разбиении на страницы все остальные параметры, переданные SearchGauges , должны соответствовать вызову, который предоставил токен страницы.

Поле объединения search_by .

search_by может быть только одним из следующих:

region_code

string

Поиск всех датчиков в регионе по коду региона. Используйте https://cldr.unicode.org/ (список https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) .

loop

Loop

Поиск всех датчиков внутри петли (простого сферического многоугольника, см. Loop ).

include_non_quality_verified

bool

Необязательно. Включайте в результат измерения, качество которых не проверено. Используйте с осторожностью. Значение по умолчанию — false.

include_gauges_without_hydro_model

bool

Необязательно. Включить в результат датчики, для которых нет собственной гидромодели Google. Значение по умолчанию — false.

SearchGaugesByAreaResponse

Ответ SearchGaugesByArea.

Поля
gauges[]

Gauge

Датчики найдены в запрашиваемой области.

next_page_token

string

Необязательно. Токен, который можно отправить как page_token для получения следующей страницы. Если это поле пропущено, последующие страницы отсутствуют.

SearchLatestFloodStatusByAreaRequest

Запрос SearchLatestFloodStatusByArea.

Поля
page_token

string

Необязательный. Токен страницы, полученный из предыдущего вызова SearchLatestFloodStatusByArea . Укажите его для получения следующей страницы. При разбиении на страницы все остальные параметры, переданные SearchLatestFloodStatusByArea , должны соответствовать вызову, который предоставил токен страницы.

page_size

int32

Необязательно. Максимальное количество возвращаемых статусов флуда. Сервис может возвращать меньше этого значения. Если не указано, будет возвращено не более 20 000 статусов флуда. Максимальное значение — 20 000; значения выше 20 000 будут преобразованы в 20 000.

Объединенное поле area_type .

area_type может быть только одним из следующих:

region_code

string

Регион, по которому запрашиваются данные о состоянии наводнений. Используя CLDR, например, «US».

loop

Loop

Цикл, с помощью которого можно запрашивать статусы наводнений.

include_non_quality_verified

bool

Необязательно. Включайте в результат измерения, качество которых не проверено. Используйте с осторожностью. Значение по умолчанию — false.

SearchLatestFloodStatusByAreaResponse

Ответ SearchLatestFloodStatusByArea.

Поля
flood_statuses[]

FloodStatus

Текущая информация о наводнениях в запрашиваемом районе. В настоящее время она определяется местоположением датчиков и может измениться в будущем.

next_page_token

string

Необязательно. Токен, который можно отправить как page_token для получения следующей страницы. Если это поле пропущено, последующие страницы отсутствуют.

SerializedPolygon

Сериализованный многоугольник.

Поля
polygon_id

string

Идентификатор полигона.

kml

string

Строковое представление многоугольника в формате KML.

Пороги

Пороговые значения модели датчика.

Поля
warning_level

double

Уровень предупреждения.

danger_level

double

Уровень опасности.

extreme_danger_level

double

Уровень чрезвычайной опасности. Присутствует не всегда.

TimeRange

Временной диапазон.

Поля
start

string

Начало временного диапазона. Представлено в формате ISO 8601, например, «2023-06-17T10:34:00Z».

end

string

Конец временного диапазона. Представлен в формате ISO 8601, например, «2023-06-17T10:34:00Z».