Package google.research.floodforecasting.v1

Índice

FloodsApi

Es un servicio de API externo para el pronóstico de inundaciones.

BatchGetGaugeModels

rpc BatchGetGaugeModels(BatchGetGaugeModelsRequest) returns (BatchGetGaugeModelsResponse)

Obtiene los metadatos actuales del modelo hidrológico para varios medidores.
BatchGetGauges

rpc BatchGetGauges(BatchGetGaugesRequest) returns (BatchGetGaugesResponse)

Obtiene metadatos sobre varios indicadores.
GetGauge

rpc GetGauge(GetGaugeRequest) returns (Gauge)

Obtiene metadatos sobre un medidor.
GetGaugeModel

rpc GetGaugeModel(GetGaugeModelRequest) returns (GaugeModel)

Obtiene los metadatos actuales del modelo hidrológico para un indicador determinado.
GetSerializedPolygon

rpc GetSerializedPolygon(GetSerializedPolygonRequest) returns (SerializedPolygon)

Obtén un polígono serializado. Los IDs de estos elementos aparecerán en otras respuestas de la API, y podrás usarlos aquí. Por ejemplo, consulta InundationMap en FloodStatus.
QueryGaugeForecasts

rpc QueryGaugeForecasts(QueryGaugeForecastsRequest) returns (QueryGaugeForecastsResponse)

Previsión de indicadores de consultas
QueryLatestFloodStatusByGaugeIds

rpc QueryLatestFloodStatusByGaugeIds(QueryLatestFloodStatusByGaugeIdsRequest) returns (QueryLatestFloodStatusByGaugeIdsResponse)

Consulta el estado de inundación más reciente por IDs de medidores.
SearchGaugesByArea

rpc SearchGaugesByArea(SearchGaugesByAreaRequest) returns (SearchGaugesByAreaResponse)

Buscar indicadores por área geográfica

Nota: Los indicadores se agregan o quitan ocasionalmente, por lo que el resultado de esta API no se debe almacenar en caché ni guardar durante períodos prolongados. Considera que un día es relativamente seguro.
SearchLatestFloodStatusByArea

rpc SearchLatestFloodStatusByArea(SearchLatestFloodStatusByAreaRequest) returns (SearchLatestFloodStatusByAreaResponse)

Buscar el estado más reciente de las inundaciones por área geográfica Nota: Devuelve los estados de inundación cuyo indicador se encuentra dentro del área determinada, a diferencia de, p.ej., el área afectada que se cruza con el área determinada. Esto está sujeto a cambios en el futuro.

BatchGetGaugeModelsRequest

Es la solicitud de BatchGetGaugeModels.

Campos
names[]

string

Es obligatorio. Son los nombres de los modelos de calibre que se recuperarán. El formato del nombre es gaugeModels/{gauge_id}. El tamaño de lista admitido está limitado a 20,000. Si se proporciona una lista de más de 20,000 elementos, se produce un error INVALID_REQUEST.

BatchGetGaugeModelsResponse

Es la respuesta de BatchGetGaugeModels.

Campos
gauge_models[]

GaugeModel

Son los modelos de calibre solicitados.

BatchGetGaugesRequest

Es la solicitud de BatchGetGauges.

Campos
names[]

string

Es obligatorio. Nombres de los indicadores que se recuperarán. El formato del nombre es gauges/{gauge_id}. El tamaño de la lista admitido está limitado a 100,000. Si se proporciona una lista de más de 100,000 elementos, se produce un error INVALID_REQUEST.

BatchGetGaugesResponse

Es la respuesta de BatchGetGauges.

Campos
gauges[]

Gauge

Son los indicadores solicitados.

FloodStatus

Es el estado de inundación que emite el sistema. Representa el estado de inundación previsto por el sistema para un área, con atributos como la gravedad, el cambio en el pronóstico, los mapas de inundación y otros. Consulte la siguiente información para obtener más detalles.

Campos
gauge_id

string

Es el ID del medidor para el que se emitió este estado.
quality_verified

bool

Es verdadero si el indicador para el que se emitió este estado de inundación no tiene un modelo o si tiene un modelo y este se verificó en cuanto a su calidad. Ten cuidado cuando este valor se establezca como falso.
gauge_location

LatLng

Ubicación del indicador para el que se emitió este estado.
issued_time

string

Fecha y hora en que se emitió este estado, como una cadena (ISO 8601), p.ej., "2023-06-17T10:34:00Z".
forecast_time_range

TimeRange

Es el período para el que se realiza la previsión.
forecast_change

ForecastChange

Es el cambio en el valor de la previsión desde el último estado conocido hasta la previsión. Actualmente, solo está disponible para los modelos de nivel del agua.
forecast_trend

ForecastTrend

Es la tendencia del pronóstico.
map_inference_type

MapInferenceType

Es el tipo de inferencia con el que se creó este mapa.
severity

Severity

Es la gravedad del estado.
inundation_map_set

InundationMapSet

Es el conjunto de mapas de inundaciones inferidos.
source

string

Organización responsable de los datos de este indicador, p.ej., GRDC, CWC, etcétera
serialized_notification_polygon_id

string

Es un ID del polígono de notificación serializado, que representa el área geográfica que Google usa para determinar cuándo alertar a sus usuarios. Usa GetSerializedPolygon para obtener el polígono serializado.

ForecastChange

Es el cambio de valor previsto desde el último estado conocido hasta el pronóstico. Actualmente, solo está disponible para los modelos de nivel del agua.

Campos
value_change

ValueChange

Es el cambio previsto en los valores.
reference_time_range

TimeRange

Es el período del último estado conocido, a partir del cual predecimos el cambio de valor. Por ejemplo, es posible que tengamos un período de referencia establecido para ayer y un cambio de valor de 25 a 30 cm. Esto significa que el aumento del nivel del agua de 25 a 30 cm se compara con su valor de ayer, no con su valor actual.

ValueChange

Es el cambio previsto en los valores, con un límite superior y uno inferior.

Campos
lower_bound

double

Es el límite inferior del cambio de la previsión en metros. Si el cambio está entre 20 y 30, este valor sería 20. Si el cambio está entre -30 y -20, este valor sería -30.
upper_bound

double

Es el límite superior del cambio de previsión en metros. Si el cambio está entre 20 y 30, este valor sería 30. Si el cambio está entre -30 y -20, este valor sería -20.

ForecastTrend

Es una enumeración que representa la tendencia del pronóstico.

Enumeraciones
FORECAST_TREND_UNSPECIFIED Valor predeterminado Este valor no se usa.
RISE Esto indica un aumento en el valor previsto.
FALL Esto indica una caída en el valor previsto.
NO_CHANGE Esto indica que no hay cambios en el valor previsto.

InundationMap

Un mapa de inundaciones.

Campos
level

InundationLevel

Nivel del mapa de inundaciones: Consulta la documentación según InundationMapType.
serialized_polygon_id

string

Es el ID del polígono serializado que representa este mapa de riesgo de inundación. Usa GetSerializedPolygon para obtener el polígono serializado.

InundationLevel

Es una enumeración que representa los niveles de inundación.

Enumeraciones
INUNDATION_LEVEL_UNSPECIFIED Valor predeterminado Este valor no se usa.
HIGH Consulta la documentación según el InundationMapType.
MEDIUM Consulta la documentación según el InundationMapType.
LOW Consulta la documentación según el InundationMapType.

InundationMapSet

Es un conjunto de mapas de inundaciones.

Campos
inundation_maps[]

InundationMap

Mapas de inundaciones, uno para cada nivel de inundación.
inundation_maps_time_range

TimeRange

Es el intervalo de tiempo del estado al que se refieren los mapas de inundación.
inundation_map_type

InundationMapType

Es el tipo de mapa de inundaciones.

InundationMapType

Es una enumeración que representa el tipo de mapa de inundación.

Enumeraciones
INUNDATION_MAP_TYPE_UNSPECIFIED Valor predeterminado Este valor no se usa.
PROBABILITY Es un mapa de probabilidad de tipo. InundationLevel representa la probabilidad del mapa: probabilidad alta, media o baja de inundación. El polígono de probabilidad alta se encuentra dentro del polígono de probabilidad media, y este se encuentra dentro del polígono de probabilidad baja.
DEPTH Es un mapa de la profundidad del tipo. InundationLevel representa la profundidad del mapa: profundidad alta, media o baja por ubicación. El polígono de profundidad alta está contenido dentro del polígono de profundidad media, y este último está contenido dentro del polígono de profundidad baja.

MapInferenceType

Es una enumeración que representa los tipos de inferencias del mapa.

Enumeraciones
MAP_INFERENCE_TYPE_UNSPECIFIED Valor predeterminado Este valor no se usa.
MODEL Esto indica que esta inferencia se creó con un modelo.
IMAGE_CLASSIFICATION Esto indica que esta inferencia se creó con una clasificación de imágenes.

Gravedad

Es una enumeración que representa la gravedad del estado.

Enumeraciones
SEVERITY_UNSPECIFIED Valor predeterminado Este valor no se usa.
EXTREME Indica un estado extremo previsto.
SEVERE Esto indica un estado grave previsto.
ABOVE_NORMAL Esto indica un estado previsto por encima de lo normal.
NO_FLOODING Esto indica que no se prevén inundaciones.
UNKNOWN Esto indica que no tenemos suficiente información para determinar la gravedad.

Previsión

Es la previsión de un solo indicador para varios períodos de adelanto. Por ejemplo, un pronóstico podría tener una hora de emisión a las 5 p.m. y, luego, incluir pronósticos para las 6 p.m., las 7 p.m., las 8 p.m., etcétera.

Nota: Algunos de los rangos de previsión pueden ser anteriores a la hora de emisión. Esto puede ocurrir, por ejemplo, debido a retrasos en los datos de entrada del modelo. En el ejemplo anterior, podría ser que la hora de emisión sea las 5 p.m., y los rangos de previsión sean para las 4 p.m., las 5 p.m., las 6 p.m., etcétera.

Nota: Los rangos varían en longitud y en distancia entre ellos. Estos son algunos ejemplos de rangos posibles:

  1. [5 p.m. - 5 p.m.], [6 p.m. - 6 p.m.], [7 p.m. - 7 p.m.]

  2. [1 de mar, 0:00 a.m. - 2 de mar, 0:00 a.m.], [2 de mar, 0:00 a.m. - 3 de mar, 0:00 a.m.], [3 de mar, 0:00 a.m. - 4 de mar, 0:00 a.m.]

Campos
forecast_ranges[]

ForecastTimedValue

Una previsión consta de varios "rangos de previsión", que son diferentes valores de previsión correspondientes a diferentes rangos de tiempo. Cuando el inicio y el final de un rango son iguales, significa que es un instante.
gauge_id

string

Es el ID del indicador para el que se genera este pronóstico.
issued_time

string

Es la fecha y hora de emisión del pronóstico (ISO 8601), p.ej., "2023-06-17T10:34:00Z". La hora de emisión es la hora en la que se generó el pronóstico.

ForecastSet

Es un conjunto de previsiones para un indicador.

Campos
forecasts[]

Forecast

Son las previsiones.

ForecastTimedValue

Es un valor de previsión que pertenece a un período. Sus unidades se definen según el GaugeModel con el que está asociado. Si el inicio y el final son iguales, significa que es un instante.

Campos
value

double

Es el valor del pronóstico.
forecast_start_time

string

Es el inicio del intervalo.
forecast_end_time

string

Es el final del intervalo.

Indicador

Son los metadatos de un indicador.

Campos
location

LatLng

Ubicación física del medidor.
site_name

string

Nombre del sitio en el que se encuentra este indicador, en inglés. Este no es un identificador único; puede haber varios medidores en ubicaciones cercanas con el mismo nombre de sitio. No siempre está presente.
source

string

Organización responsable de los datos de este indicador, p.ej., GRDC, CWC, etcétera.
river

string

Nombre del río del indicador en inglés. No siempre está presente.
country_code

string

Es el código de país del país del indicador (ISO 3166 Alpha-2).
gauge_id

string

Es el ID del medidor.
quality_verified

bool

Este campo es verdadero si el indicador no tiene un modelo o si tiene un modelo y este está verificado en cuanto a su calidad. Ten cuidado cuando este valor se establezca como falso.
has_model

bool

Este campo es verdadero si el medidor tiene un modelo. Si el indicador tiene un modelo, es posible obtener su GaugeModel con GetGaugeModel o BatchGetGaugeModels. También obtendrás sus previsiones con QueryGaugeForecasts.

GaugeModel

Son los metadatos del modelo de un indicador.

Campos
gauge_id

string

Es el ID del medidor.
gauge_model_id

string

Es el ID del modelo del indicador. De vez en cuando, el modelo de un indicador puede cambiar. En ese caso, asignaremos un ID y umbrales nuevos al modelo nuevo. Ten cuidado al comparar las previsiones anteriores con las nuevas si se produjeron con modelos diferentes.
thresholds

Thresholds

Son los umbrales del indicador.
gauge_value_unit

GaugeValueUnit

Es la unidad de valor del modelo del medidor.
quality_verified

bool

Indica si este modelo se verificó para garantizar su calidad. Ten cuidado cuando este valor se establezca como falso.

GaugeValueUnit

Son las posibles unidades de valor del medidor.

Enumeraciones
GAUGE_VALUE_UNIT_UNSPECIFIED Valor predeterminado Este valor no se usa.
METERS Metros
CUBIC_METERS_PER_SECOND Metros cúbicos por segundo.

GetGaugeModelRequest

Es la solicitud de GetGaugeModel.

Campos
name

string

Es obligatorio. Es el nombre del modelo de calibre que se recuperará. El formato del nombre es gaugeModels/{gauge_id}.

GetGaugeRequest

Es la solicitud de GetGauge.

Campos
name

string

Es obligatorio. Es el nombre del indicador que se recuperará. El formato del nombre es gauges/{gauge_id}.

GetSerializedPolygonRequest

Es la solicitud de GetSerializedPolygon.

Campos
name

string

Es obligatorio. Nombre del polígono serializado que se recuperará. Formato del nombre: serializedPolygons/{polygon_id}

Bucle

Un bucle en el mapa. Representa un polígono esférico simple. Consiste en una sola cadena de vértices en la que el primer vértice está conectado de forma implícita con el último.

Campos
vertices[]

LatLng

Es obligatorio. Son los vértices del bucle.

QueryGaugeForecastsRequest

Es la solicitud de QueryGaugeForecasts.

Campos
gauge_ids[]

string

Es obligatorio. Es una lista de IDs de medidores. El tamaño de la lista admitida se limita a 500. Si se proporciona una lista de más de 500 elementos, se produce un error INVALID_REQUEST.
issued_time_start

string

Opcional. Es la fecha y hora más temprana de emisión del pronóstico como cadena (ISO 8601), p.ej., "2023-06-17T10:34:00Z" o una cadena de fecha, p.ej., "2023-10-13". La fecha de inicio no puede ser anterior al 1/10/2023. El valor predeterminado es hace una semana.
issued_time_end

string

Opcional. Es la fecha y hora de emisión del pronóstico más reciente como cadena (ISO 8601), p.ej., "2023-06-17T10:34:00Z" o una cadena de fecha, p.ej., "2023-10-13". El valor predeterminado es ahora.

QueryGaugeForecastsResponse

Es la respuesta de QueryGaugeForecasts.

Campos
forecasts

map<string, ForecastSet>

Es un mapa que relaciona el ID del indicador con el conjunto de previsiones.

QueryLatestFloodStatusByGaugeIdsRequest

Es la solicitud de QueryLatestFloodStatusByGaugeIds.

Campos
gauge_ids[]

string

Es obligatorio. Es una lista de IDs de medidores. El tamaño de lista admitido está limitado a 20,000. Si se proporciona una lista de más de 20,000 elementos, se produce un error INVALID_REQUEST.

QueryLatestFloodStatusByGaugeIdsResponse

Es la respuesta de QueryLatestFloodStatusByGaugeIds.

Campos
flood_statuses[]

FloodStatus

Son los estados de inundación más recientes para los indicadores solicitados.

SearchGaugesByAreaRequest

Es la solicitud de SearchGaugesByArea.

Campos
page_size

int32

Opcional. Es la cantidad máxima de indicadores que se devolverán. El servicio puede mostrar menos que este valor. Si no se especifica, se devolverán, como máximo, 50,000 indicadores. El valor máximo es 50,000,y los valores superiores se convertirán a 50,000.
page_token

string

Opcional. Un token de página, recibido desde una llamada SearchGauges anterior. Proporciona esto para recuperar la página siguiente. Cuando se realiza la paginación, todos los demás parámetros proporcionados a SearchGauges deben guardar correspondencia con la llamada que proporcionó el token de la página.

Campo de unión search_by.

search_by puede ser una de las siguientes opciones:
region_code

string

Busca todos los indicadores dentro de una región por código de región. Usa https://cldr.unicode.org/ (lista https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).
loop

Loop

Busca todos los medidores dentro de un bucle (un polígono esférico simple, consulta Loop).
include_non_quality_verified

bool

Opcional. Incluye en los indicadores de resultados los que no se verificaron en cuanto a la calidad. Úsala con precaución. El valor predeterminado es falso.
include_gauges_without_hydro_model

bool

Opcional. Se incluyen en los indicadores de resultados que no tienen un modelo hidrológico interno de Google. El valor predeterminado es falso.

SearchGaugesByAreaResponse

Es la respuesta de SearchGaugesByArea.

Campos
gauges[]

Gauge

Son los medidores que se encuentran en el área solicitada.
next_page_token

string

Opcional. Es un token que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

SearchLatestFloodStatusByAreaRequest

Es la solicitud de SearchLatestFloodStatusByArea.

Campos
page_token

string

Opcional. Un token de página, recibido desde una llamada SearchLatestFloodStatusByArea anterior. Proporciona esto para recuperar la página siguiente. Cuando se realiza la paginación, todos los demás parámetros proporcionados a SearchLatestFloodStatusByArea deben guardar correspondencia con la llamada que proporcionó el token de la página.
page_size

int32

Opcional. Es la cantidad máxima de estados de inundación que se devolverán. El servicio puede mostrar menos que este valor. Si no se especifica, se devolverán, como máximo, 20,000 estados de inundación. El valor máximo es 20,000,y los valores superiores se convertirán a 20,000.

Campo de unión area_type.

area_type puede ser una de las siguientes opciones:
region_code

string

Es la región por la que se consultan los estados de inundación. Usa CLDR, p.ej., 'US'.
loop

Loop

Es el bucle por el que se consultan los estados de inundación.
include_non_quality_verified

bool

Opcional. Incluye en los indicadores de resultados los que no se verificaron en cuanto a la calidad. Úsala con precaución. El valor predeterminado es falso.

SearchLatestFloodStatusByAreaResponse

Es la respuesta de SearchLatestFloodStatusByArea.

Campos
flood_statuses[]

FloodStatus

Son los estados de inundación más recientes en el área solicitada. Actualmente, esto se determina según la ubicación de los medidores, pero podría cambiar en el futuro.
next_page_token

string

Opcional. Es un token que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

SerializedPolygon

Es un polígono serializado.

Campos
polygon_id

string

Es el ID del polígono.
kml

string

Es la representación de cadena KML del polígono.

Límites

Son los umbrales del modelo de un indicador.

Campos
warning_level

double

Nivel de advertencia.
danger_level

double

Nivel de peligro.
extreme_danger_level

double

Nivel de peligro extremo. No siempre está presente.

TimeRange

Es un período.

Campos
start

string

Es el inicio del intervalo de tiempo. Se representa como ISO 8601, p.ej., "2023-06-17T10:34:00Z".
end

string

Es el final del intervalo de tiempo. Se representa como ISO 8601, p.ej., "2023-06-17T10:34:00Z".