Package google.research.floodforecasting.v1

Índice

FloodsApi

Um serviço de API externa para previsão de inundações.

BatchGetGaugeModels

rpc BatchGetGaugeModels(BatchGetGaugeModelsRequest) returns (BatchGetGaugeModelsResponse)

Recebe os metadados atuais do modelo hidrológico para várias réguas de medição.
BatchGetGauges

rpc BatchGetGauges(BatchGetGaugesRequest) returns (BatchGetGaugesResponse)

Recebe metadados sobre vários indicadores.
GetGauge

rpc GetGauge(GetGaugeRequest) returns (Gauge)

Recebe metadados sobre um medidor.
GetGaugeModel

rpc GetGaugeModel(GetGaugeModelRequest) returns (GaugeModel)

Recebe os metadados atuais do modelo hidrológico para um determinado medidor.
GetSerializedPolygon

rpc GetSerializedPolygon(GetSerializedPolygonRequest) returns (SerializedPolygon)

Recebe um polígono serializado. Os IDs deles vão aparecer em outras respostas da API, e você poderá usá-los aqui. Por exemplo, consulte InundationMap em FloodStatus.
QueryGaugeForecasts

rpc QueryGaugeForecasts(QueryGaugeForecastsRequest) returns (QueryGaugeForecastsResponse)

Consulta previsões de medidor.
QueryLatestFloodStatusByGaugeIds

rpc QueryLatestFloodStatusByGaugeIds(QueryLatestFloodStatusByGaugeIdsRequest) returns (QueryLatestFloodStatusByGaugeIdsResponse)

Consulta o status mais recente de inundações por IDs de medidor.
SearchGaugesByArea

rpc SearchGaugesByArea(SearchGaugesByAreaRequest) returns (SearchGaugesByAreaResponse)

Pesquise indicadores por área geográfica.

Observação: os indicadores são adicionados ou removidos ocasionalmente. Por isso, o resultado dessa API não deve ser armazenado em cache ou por longos períodos. Considere que um dia é relativamente seguro.
SearchLatestFloodStatusByArea

rpc SearchLatestFloodStatusByArea(SearchLatestFloodStatusByAreaRequest) returns (SearchLatestFloodStatusByAreaResponse)

Pesquise o status mais recente de inundações por área geográfica. Observação: retorna status de inundação cujo gauge está dentro da área especificada, e não, por exemplo, a área afetada que se cruza com a área especificada. Isso está sujeito a mudanças no futuro.

BatchGetGaugeModelsRequest

A solicitação de "BatchGetGaugeModels".

Campos
names[]

string

Obrigatório. Os nomes dos modelos de métricas a serem recuperados. Formato do nome: gaugeModels/{gauge_id}. O tamanho da lista aceita é limitado a 20.000. Se uma lista maior que 20.000 for fornecida,ela vai falhar com um erro INVALID_REQUEST.

BatchGetGaugeModelsResponse

A resposta de "BatchGetGaugeModels".

Campos
gauge_models[]

GaugeModel

Os modelos de medidor solicitados.

BatchGetGaugesRequest

A solicitação de "BatchGetGauges".

Campos
names[]

string

Obrigatório. Os nomes dos indicadores a serem recuperados. Formato do nome: gauges/{gauge_id}. O tamanho da lista aceita é limitado a 100.000. Se uma lista maior que 100.000 for fornecida,ela vai falhar com um erro INVALID_REQUEST.

BatchGetGaugesResponse

A resposta de "BatchGetGauges".

Campos
gauges[]

Gauge

Os indicadores solicitados.

FloodStatus

Um status de inundação emitido pelo sistema. Representa o status de inundação previsto pelo sistema para uma área, com atributos como gravidade, mudança na previsão, mapas de inundação e outros. Veja mais detalhes abaixo.

Campos
gauge_id

string

O ID do medidor para o qual este status foi emitido.
quality_verified

bool

Verdadeiro se o medidor para o qual esse status de enchente foi emitido não tiver um modelo ou se tiver um modelo e ele for verificado quanto à qualidade. Use com cautela quando esse valor for definido como "false".
gauge_location

LatLng

O local do medidor para o qual este status foi emitido.
issued_time

string

O horário em que esse status foi emitido como string (ISO 8601), por exemplo, "2023-06-17T10:34:00Z".
forecast_time_range

TimeRange

O período para o qual a previsão está sendo feita.
forecast_change

ForecastChange

A mudança no valor da previsão do último estado conhecido para a previsão. No momento, disponível apenas para modelos de nível da água.
forecast_trend

ForecastTrend

A tendência da previsão.
map_inference_type

MapInferenceType

O tipo de inferência que criou este mapa.
severity

Severity

A gravidade do status.
inundation_map_set

InundationMapSet

O conjunto de mapas de inundação inferidos.
source

string

A organização responsável pelos dados deste medidor, por exemplo, GRDC, CWC etc.
serialized_notification_polygon_id

string

Um ID do polígono de notificação serializado, que representa a área geográfica usada pelo Google para determinar quando alertar os usuários. Use GetSerializedPolygon para receber o próprio polígono serializado.

ForecastChange

A mudança no valor previsto do último estado conhecido para a previsão. No momento, disponível apenas para modelos de nível da água.

Campos
value_change

ValueChange

A mudança prevista nos valores.
reference_time_range

TimeRange

Intervalo de tempo do último estado conhecido, de onde prevemos a mudança de valor. Por exemplo, podemos ter um período de referência definido como "ontem" e uma mudança de valor de 25 a 30 cm. Isso significa que o aumento de 25 a 30 cm no nível da água é comparado ao valor de ontem, não ao valor atual.

ValueChange

A mudança prevista nos valores: um limite superior e um inferior.

Campos
lower_bound

double

O limite inferior da mudança prevista em metros. Se a mudança for entre 20 e 30, esse valor será 20. Se a mudança for entre -30 e -20, esse valor será -30.
upper_bound

double

O limite superior da mudança prevista em metros. Se a mudança estiver entre 20 e 30, esse valor será 30. Se a mudança for entre -30 e -20, esse valor será -20.

ForecastTrend

Um enum que representa a tendência da previsão.

Tipos enumerados
FORECAST_TREND_UNSPECIFIED Valor padrão. Esse valor não é usado.
RISE Isso indica um aumento no valor previsto.
FALL Isso indica uma queda no valor previsto.
NO_CHANGE Isso indica que não há mudança no valor previsto.

InundationMap

Um mapa de inundação.

Campos
level

InundationLevel

O nível do mapa de inundação. Consulte a documentação com base em InundationMapType.
serialized_polygon_id

string

Um ID do polígono serializado que representa esse mapa de risco de inundação. Use GetSerializedPolygon para receber o próprio polígono serializado.

InundationLevel

Um enum que representa os níveis de inundação.

Tipos enumerados
INUNDATION_LEVEL_UNSPECIFIED Valor padrão. Esse valor não é usado.
HIGH Consulte a documentação com base no InundationMapType.
MEDIUM Consulte a documentação com base no InundationMapType.
LOW Consulte a documentação com base no InundationMapType.

InundationMapSet

Um conjunto de mapas de inundação.

Campos
inundation_maps[]

InundationMap

Os mapas de inundação, um para cada nível de inundação.
inundation_maps_time_range

TimeRange

O período do estado a que os mapas de inundação se referem.
inundation_map_type

InundationMapType

O tipo do mapa de inundação.

InundationMapType

Uma enumeração que representa o tipo do mapa de inundação.

Tipos enumerados
INUNDATION_MAP_TYPE_UNSPECIFIED Valor padrão. Esse valor não é usado.
PROBABILITY Um mapa de probabilidade de tipo. O InundationLevel representa a probabilidade do mapa: alta/média/baixa probabilidade de inundação. O polígono de alta probabilidade está contido no polígono de probabilidade média, que está contido no polígono de baixa probabilidade.
DEPTH Um mapa de profundidade de tipo. O InundationLevel representa a profundidade do mapa: alta, média ou baixa por local. O polígono de alta profundidade está contido no polígono de profundidade média, que está contido no polígono de baixa profundidade.

MapInferenceType

Uma enumeração que representa tipos de inferências de mapa.

Tipos enumerados
MAP_INFERENCE_TYPE_UNSPECIFIED Valor padrão. Esse valor não é usado.
MODEL Isso indica que a inferência foi criada usando um modelo.
IMAGE_CLASSIFICATION Isso indica que essa inferência foi criada usando uma classificação de imagem.

Gravidade

Um enum que representa a gravidade do status.

Tipos enumerados
SEVERITY_UNSPECIFIED Valor padrão. Esse valor não é usado.
EXTREME Isso indica um status extremo previsto.
SEVERE Isso indica um status grave previsto.
ABOVE_NORMAL Isso indica um status previsto acima do normal.
NO_FLOODING Isso indica uma previsão de que não haverá inundações.
UNKNOWN Isso indica que não temos informações suficientes para determinar a gravidade.

Previsão

A previsão de um único indicador para vários prazos de antecedência. Por exemplo, uma previsão pode ter o horário de emissão às 17h e incluir previsões para 18h, 19h, 20h etc.

Observação: alguns intervalos de previsão podem ser anteriores ao horário de emissão. Isso pode acontecer devido a atrasos nos dados de entrada do modelo, por exemplo. No exemplo acima, o horário do problema pode ser 17h, e os intervalos de previsão são para 16h, 17h, 18h etc.

Observação: os intervalos variam em duração e distância entre eles. Alguns exemplos de intervalos possíveis:

  1. [17h - 17h], [18h - 18h], [19h - 19h]

  2. [1º de março, 0h - 2 de março, 0h], [2 de março, 0h - 3 de março, 0h], [3 de março, 0h - 4 de março, 0h]

Campos
forecast_ranges[]

ForecastTimedValue

Uma previsão consiste em vários "intervalos de previsão", que são diferentes valores de previsão relacionados a diferentes períodos. Quando o início e o fim de um intervalo são iguais, significa que é um instante.
gauge_id

string

O ID do medidor a que essa previsão se refere.
issued_time

string

O horário de emissão da previsão (ISO 8601), por exemplo, "2023-06-17T10:34:00Z". O horário de emissão é o horário em que a previsão foi gerada.

ForecastSet

Um conjunto de previsões para um medidor.

Campos
forecasts[]

Forecast

As previsões.

ForecastTimedValue

Um valor de previsão referente a um período. As unidades são definidas pelo GaugeModel associado. Se o início e o fim forem iguais, significa que é um instante.

Campos
value

double

O valor da previsão.
forecast_start_time

string

O início do intervalo.
forecast_end_time

string

O fim do intervalo.

Medidor

Metadados de um medidor.

Campos
location

LatLng

A localização física do medidor.
site_name

string

O nome do site em que esse medidor está localizado, em inglês. Esse não é um identificador exclusivo. Pode haver vários medidores em locais próximos com o mesmo nome de site. Nem sempre presente.
source

string

A organização responsável pelos dados deste medidor, por exemplo, GRDC, CWC etc.
river

string

O nome do rio do medidor em inglês. Nem sempre presente.
country_code

string

O código do país do indicador (ISO 3166 Alpha-2).
gauge_id

string

O ID do medidor.
quality_verified

bool

Esse campo será verdadeiro se o medidor não tiver um modelo ou se tiver um modelo e ele for verificado quanto à qualidade. Use com cautela quando esse valor for definido como "false".
has_model

bool

Esse campo será verdadeiro se o medidor tiver um modelo. Se o medidor tiver um modelo, será possível receber o GaugeModel dele usando GetGaugeModel ou BatchGetGaugeModels. e também receber as previsões usando QueryGaugeForecasts.

GaugeModel

Metadados do modelo de um medidor.

Campos
gauge_id

string

O ID do medidor.
gauge_model_id

string

O ID do modelo do medidor. De tempos em tempos, o modelo de um medidor pode mudar. Nesse caso, vamos atribuir um novo ID e novos limites ao novo modelo. Tenha cuidado ao comparar previsões antigas e novas se elas foram produzidas por modelos diferentes.
thresholds

Thresholds

Os limites do medidor.
gauge_value_unit

GaugeValueUnit

A unidade de valor do modelo do medidor.
quality_verified

bool

Indica se o modelo foi verificado quanto à qualidade. Use com cautela quando esse valor for definido como "false".

GaugeValueUnit

Possíveis unidades de valor do medidor.

Tipos enumerados
GAUGE_VALUE_UNIT_UNSPECIFIED Valor padrão. Esse valor não é usado.
METERS Metros.
CUBIC_METERS_PER_SECOND Metros cúbicos por segundo.

GetGaugeModelRequest

A solicitação de "GetGaugeModel".

Campos
name

string

Obrigatório. O nome do modelo de medidor a ser recuperado. Formato do nome: gaugeModels/{gauge_id}.

GetGaugeRequest

A solicitação de GetGauge.

Campos
name

string

Obrigatório. O nome do medidor a ser recuperado. Formato do nome: gauges/{gauge_id}.

GetSerializedPolygonRequest

A solicitação de GetSerializedPolygon.

Campos
name

string

Obrigatório. O nome do polígono serializado a ser recuperado. Formato do nome: serializedPolygons/{polygon_id}

Repetição

Um loop no mapa. Representa um polígono esférico simples. Ele consiste em uma única cadeia de vértices em que o primeiro está implicitamente conectado ao último.

Campos
vertices[]

LatLng

Obrigatório. Os vértices do loop.

QueryGaugeForecastsRequest

A solicitação de "QueryGaugeForecasts".

Campos
gauge_ids[]

string

Obrigatório. Uma lista de IDs de medidores. O tamanho da lista aceita é limitado a 500. Se uma lista maior que 500 for fornecida, ela vai falhar com um erro INVALID_REQUEST.
issued_time_start

string

Opcional. A primeira hora de emissão da previsão como string (ISO 8601), por exemplo, "2023-06-17T10:34:00Z" ou uma string de data, por exemplo, "2023-10-13". O horário de início não pode ser anterior a "2023-10-01". O padrão é uma semana atrás.
issued_time_end

string

Opcional. A última hora de emissão da previsão como string (ISO 8601), por exemplo, "2023-06-17T10:34:00Z" ou uma string de data, por exemplo, "2023-10-13". O padrão é "agora".

QueryGaugeForecastsResponse

A resposta de "QueryGaugeForecasts".

Campos
forecasts

map<string, ForecastSet>

Um mapa do ID do medidor para o conjunto de previsão.

QueryLatestFloodStatusByGaugeIdsRequest

A solicitação de QueryLatestFloodStatusByGaugeIds.

Campos
gauge_ids[]

string

Obrigatório. Uma lista de IDs de medidores. O tamanho da lista aceita é limitado a 20.000. Se uma lista maior que 20.000 for fornecida,ela vai falhar com um erro INVALID_REQUEST.

QueryLatestFloodStatusByGaugeIdsResponse

A resposta de "QueryLatestFloodStatusByGaugeIds".

Campos
flood_statuses[]

FloodStatus

Os status mais recentes de inundação para os indicadores solicitados.

SearchGaugesByAreaRequest

A solicitação de "SearchGaugesByArea".

Campos
page_size

int32

Opcional. O número máximo de indicadores a serem retornados. O serviço pode retornar menos que esse valor. Se não for especificado, no máximo 50.000 indicadores serão retornados. O valor máximo é 50.000. Valores acima disso serão convertidos para 50.000.
page_token

string

Opcional. Um token de página recebido de uma chamada SearchGauges anterior. Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos para SearchGauges precisam corresponder à chamada que forneceu o token da página.

Campo de união search_by.

search_by pode ser apenas de um dos tipos a seguir:
region_code

string

Pesquise todos os indicadores em uma região usando o código dela. Use https://cldr.unicode.org/ (lista https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).
loop

Loop

Pesquise todos os indicadores em um loop (um polígono esférico simples, consulte Loop).
include_non_quality_verified

bool

Opcional. Inclua no resultado indicadores que não foram verificados quanto à qualidade. Use com cuidado. O padrão é false
include_gauges_without_hydro_model

bool

Opcional. Incluir nos indicadores de resultado que não têm um modelo hidrológico interno do Google. O padrão é false

SearchGaugesByAreaResponse

A resposta de "SearchGaugesByArea".

Campos
gauges[]

Gauge

Medidores encontrados na área solicitada.
next_page_token

string

Opcional. Um token que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

SearchLatestFloodStatusByAreaRequest

A solicitação de "SearchLatestFloodStatusByArea".

Campos
page_token

string

Opcional. Um token de página recebido de uma chamada SearchLatestFloodStatusByArea anterior. Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos para SearchLatestFloodStatusByArea precisam corresponder à chamada que forneceu o token da página.
page_size

int32

Opcional. O número máximo de status de inundação a serem retornados. O serviço pode retornar menos que esse valor. Se não for especificado, no máximo 20.000 status de enchente serão retornados. O valor máximo é 20.000. Valores acima disso serão convertidos para 20.000.

Campo de união area_type.

area_type pode ser apenas de um dos tipos a seguir:
region_code

string

A região para consultar os status de enchente. Usando CLDR, por exemplo, 'US'.
loop

Loop

O loop para consultar os status de inundação.
include_non_quality_verified

bool

Opcional. Inclua no resultado indicadores que não foram verificados quanto à qualidade. Use com cuidado. O padrão é false

SearchLatestFloodStatusByAreaResponse

A resposta de "SearchLatestFloodStatusByArea".

Campos
flood_statuses[]

FloodStatus

Os status mais recentes de inundações na área solicitada. No momento, isso é determinado pela localização dos indicadores, mas pode mudar no futuro.
next_page_token

string

Opcional. Um token que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

SerializedPolygon

Um polígono serializado.

Campos
polygon_id

string

O ID do polígono.
kml

string

A representação de string KML do polígono.

Limites

Limites de um modelo de medidor.

Campos
warning_level

double

Nível de alerta.
danger_level

double

Nível de perigo.
extreme_danger_level

double

Nível de perigo extremo. Nem sempre presente.

TimeRange

Um período.

Campos
start

string

O início do período. Representado como ISO 8601, por exemplo, "2023-06-17T10:34:00Z".
end

string

O fim do período. Representado como ISO 8601, por exemplo, "2023-06-17T10:34:00Z".