Package google.research.floodforecasting.v1

Index

FloodsApi

Service d'API externe pour les prévisions d'inondations.

BatchGetGaugeModels

rpc BatchGetGaugeModels(BatchGetGaugeModelsRequest) returns (BatchGetGaugeModelsResponse)

Obtenez les métadonnées actuelles du modèle hydrologique pour plusieurs jauges.
BatchGetGauges

rpc BatchGetGauges(BatchGetGaugesRequest) returns (BatchGetGaugesResponse)

Obtenir les métadonnées de plusieurs jauges.
GetGauge

rpc GetGauge(GetGaugeRequest) returns (Gauge)

Obtenir les métadonnées d'un graphique.
GetGaugeModel

rpc GetGaugeModel(GetGaugeModelRequest) returns (GaugeModel)

Obtenez les métadonnées actuelles du modèle hydrologique pour une jauge donnée.
GetSerializedPolygon

rpc GetSerializedPolygon(GetSerializedPolygonRequest) returns (SerializedPolygon)

Obtenez un polygone sérialisé. Les ID correspondants s'afficheront dans d'autres réponses d'API, et vous pourrez les utiliser ici. Par exemple, consultez InundationMap dans FloodStatus.
QueryGaugeForecasts

rpc QueryGaugeForecasts(QueryGaugeForecastsRequest) returns (QueryGaugeForecastsResponse)

Interroger les prévisions des jauges.
QueryLatestFloodStatusByGaugeIds

rpc QueryLatestFloodStatusByGaugeIds(QueryLatestFloodStatusByGaugeIdsRequest) returns (QueryLatestFloodStatusByGaugeIdsResponse)

Interrogez le dernier état des inondations par ID de jauge.
SearchGaugesByArea

rpc SearchGaugesByArea(SearchGaugesByAreaRequest) returns (SearchGaugesByAreaResponse)

Recherchez des jauges par zone géographique.

Remarque : Des jauges sont parfois ajoutées ou supprimées. Par conséquent, le résultat de cette API ne doit pas être mis en cache ni stocké pendant de longues périodes. Une durée d'un jour maximum est considérée comme relativement sûre.
SearchLatestFloodStatusByArea

rpc SearchLatestFloodStatusByArea(SearchLatestFloodStatusByAreaRequest) returns (SearchLatestFloodStatusByAreaResponse)

Recherchez l'état des inondations les plus récentes par zone géographique. Remarque : Renvoie les états d'inondation dont la jauge se trouve dans la zone donnée, par opposition à la zone touchée qui croise la zone donnée, par exemple. Cette offre est susceptible d'évoluer à l'avenir.

BatchGetGaugeModelsRequest

Requête BatchGetGaugeModels.

Champs
names[]

string

Obligatoire. Noms des modèles de jauge à récupérer. Format du nom : gaugeModels/{gauge_id}. La taille de la liste est limitée à 20 000. Si une liste de plus de 20 000 éléments est fournie,une erreur INVALID_REQUEST est générée.

BatchGetGaugeModelsResponse

Réponse de BatchGetGaugeModels.

Champs
gauge_models[]

GaugeModel

Modèles de jauge demandés.

BatchGetGaugesRequest

Requête BatchGetGauges.

Champs
names[]

string

Obligatoire. Noms des jauges à récupérer. Format du nom : gauges/{gauge_id}. La taille de la liste acceptée est limitée à 100 000. Si une liste de plus de 100 000 éléments est fournie,une erreur INVALID_REQUEST est générée.

BatchGetGaugesResponse

Réponse de BatchGetGauges.

Champs
gauges[]

Gauge

Les jauges demandées.

FloodStatus

État d'inondation émis par le système. Représente l'état des inondations prévu par le système pour une zone, avec des attributs tels que la gravité, l'évolution des prévisions, les cartes d'inondation, etc. Pour en savoir plus, reportez-vous aux informations ci-dessous.

Champs
gauge_id

string

ID du compteur pour lequel cet état a été émis.
quality_verified

bool

"True" si le modèle de la jauge pour laquelle cet état d'inondation a été émis n'existe pas ou s'il existe et que sa qualité a été vérifiée. Veuillez l'utiliser avec précaution lorsque cette valeur est définie sur "false".
gauge_location

LatLng

Emplacement du compteur pour lequel cet état a été émis.
issued_time

string

Heure à laquelle cet état a été émis sous forme de chaîne (ISO 8601), par exemple : "2023-06-17T10:34:00Z".
forecast_time_range

TimeRange

Plage de dates pour laquelle la prévision est effectuée.
forecast_change

ForecastChange

Variation de la valeur de prévision par rapport au dernier état connu. Actuellement disponible uniquement pour les modèles de niveau d'eau.
forecast_trend

ForecastTrend

Tendance des prévisions.
map_inference_type

MapInferenceType

Type d'inférence par lequel cette carte a été créée.
severity

Severity

Gravité de l'état.
inundation_map_set

InundationMapSet

Ensemble de cartes d'inondation inférées.
source

string

Organisation responsable des données de ce graphique, par exemple GRDC, CWC, etc.
serialized_notification_polygon_id

string

ID du polygone de notification sérialisé, qui représente la zone géographique utilisée par Google pour déterminer quand alerter ses utilisateurs. Utilisez GetSerializedPolygon pour obtenir le polygone sérialisé lui-même.

ForecastChange

Variation de la valeur prévue par rapport au dernier état connu. Actuellement disponible uniquement pour les modèles de niveau d'eau.

Champs
value_change

ValueChange

Variation prévue des valeurs.
reference_time_range

TimeRange

Plage de temps du dernier état connu, à partir duquel nous prédisons la variation de la valeur. Par exemple, nous pouvons avoir une période de référence définie sur "hier" et une variation de valeur de 25 à 30 cm. Cela signifie que l'augmentation du niveau d'eau de 25 à 30 cm est comparée à sa valeur d'hier, et non à sa valeur actuelle.

ValueChange

Variation prévue des valeurs (limites supérieure et inférieure).

Champs
lower_bound

double

Limite inférieure de la variation de prévision en mètres. Si la variation est comprise entre 20 et 30, cette valeur sera de 20. Si la variation est comprise entre -30 et -20, cette valeur sera de -30.
upper_bound

double

Limite supérieure de la variation de prévision en mètres. Si la variation est comprise entre 20 et 30, cette valeur sera de 30. Si la variation est comprise entre -30 et -20, cette valeur sera de -20.

ForecastTrend

Énumération représentant la tendance de la prévision.

Enums
FORECAST_TREND_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
RISE Cela indique une augmentation de la valeur prévue.
FALL Cela indique une baisse de la valeur prévue.
NO_CHANGE Cela indique qu'il n'y a pas de changement dans la valeur prévue.

InundationMap

Une carte des inondations.

Champs
level

InundationLevel

Niveau de la carte des inondations : consultez la documentation en fonction de InundationMapType.
serialized_polygon_id

string

ID du polygone sérialisé représentant cette carte des risques d'inondation. Utilisez GetSerializedPolygon pour obtenir le polygone sérialisé lui-même.

InundationLevel

Énumération représentant les niveaux d'inondation.

Enums
INUNDATION_LEVEL_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
HIGH Consultez la documentation en fonction de InundationMapType.
MEDIUM Consultez la documentation en fonction de InundationMapType.
LOW Consultez la documentation en fonction de InundationMapType.

InundationMapSet

Ensemble de cartes des inondations.

Champs
inundation_maps[]

InundationMap

Cartes d'inondation, une pour chaque niveau d'inondation.
inundation_maps_time_range

TimeRange

Période de l'état auquel se réfèrent les cartes d'inondation.
inundation_map_type

InundationMapType

Type de carte d'inondation.

InundationMapType

Énumération représentant le type de carte d'inondation.

Enums
INUNDATION_MAP_TYPE_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
PROBABILITY Carte de probabilité de type. InundationLevel représente la probabilité d'inondation (élevée, moyenne ou faible) sur la carte. Le polygone de forte probabilité est inclus dans le polygone de probabilité moyenne, qui est lui-même inclus dans le polygone de faible probabilité.
DEPTH Carte de profondeur de type. InundationLevel représente la profondeur de la carte (profondeur élevée/moyenne/faible par emplacement). Le polygone de profondeur élevée est contenu dans le polygone de profondeur moyenne, qui est lui-même contenu dans le polygone de profondeur faible.

MapInferenceType

Énumération représentant les types d'inférences de carte.

Enums
MAP_INFERENCE_TYPE_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
MODEL Cela indique que cette inférence a été créée à l'aide d'un modèle.
IMAGE_CLASSIFICATION Cela indique que cette inférence a été créée à l'aide d'une classification d'images.

Gravité

Énumération représentant la gravité de l'état.

Enums
SEVERITY_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
EXTREME Cela indique un état extrême prévu.
SEVERE Cela indique un état grave prévu.
ABOVE_NORMAL Cela indique un état prévu au-dessus de la normale.
NO_FLOODING Cela indique une prévision d'absence d'inondation.
UNKNOWN Cela signifie que nous ne disposons pas de suffisamment d'informations pour déterminer la gravité.

Prévision

Prévisions d'une seule jauge pour plusieurs délais. Par exemple, une prévision peut avoir une heure d'émission de 17h et inclure des prévisions pour 18h, 19h, 20h, etc.

Remarque : Certaines plages de prévisions peuvent être antérieures à l'heure d'émission. Cela peut se produire, par exemple, en raison de décalages dans les données d'entrée du modèle. Dans l'exemple ci-dessus, il se peut que l'heure du problème soit 17h et que les plages de prévision soient 16h, 17h, 18h, etc.

Remarque : Les plages varient en longueur et en distance entre elles. Voici quelques exemples de plages possibles :

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

  2. [1er mars à minuit – 2 mars à minuit], [2 mars à minuit – 3 mars à minuit], [3 mars à minuit – 4 mars à minuit]

Champs
forecast_ranges[]

ForecastTimedValue

Une prévision se compose de plusieurs "plages de prévision", qui sont différentes valeurs de prévision se rapportant à différentes périodes. Lorsque le début et la fin d'une plage sont égaux, cela signifie qu'il s'agit d'un instant précis.
gauge_id

string

ID de la jauge à laquelle s'applique cette prévision.
issued_time

string

Heure d'émission des prévisions (ISO 8601), par exemple "2023-06-17T10:34:00Z". La date d'émission correspond à la date à laquelle la prévision a été générée.

ForecastSet

Ensemble de prévisions pour une jauge.

Champs
forecasts[]

Forecast

Les prévisions.

ForecastTimedValue

Valeur de prévision associée à une période. Ses unités sont définies par le GaugeModel auquel il est associé. Si le début et la fin sont égaux, cela signifie qu'il s'agit d'un instant précis.

Champs
value

double

Valeur de la prévision.
forecast_start_time

string

Début de l'intervalle.
forecast_end_time

string

Fin de l'intervalle.

Jauge

Métadonnées d'une jauge.

Champs
location

LatLng

Emplacement physique du compteur.
site_name

string

Nom du site sur lequel se trouve cette jauge, en anglais. Il ne s'agit pas d'un identifiant unique. Il peut exister plusieurs jauges à proximité portant le même nom de site. Pas toujours présent.
source

string

Organisation responsable des données de cette jauge (par exemple, GRDC, CWC, etc.).
river

string

Nom de la rivière de la jauge en anglais. Pas toujours présent.
country_code

string

Code pays de la jauge (ISO 3166 Alpha-2).
gauge_id

string

ID du compteur.
quality_verified

bool

Ce champ est défini sur "true" si la jauge n'a pas de modèle ou si elle en a un et qu'il a été validé. Veuillez l'utiliser avec précaution lorsque cette valeur est définie sur "false".
has_model

bool

Ce champ est défini sur "true" si le compteur possède un modèle. Si le cadran possède un modèle, il est possible d'obtenir le GaugeModel de ce cadran à l'aide de GetGaugeModel ou BatchGetGaugeModels. et obtenir ses prévisions à l'aide de QueryGaugeForecasts.

GaugeModel

Métadonnées du modèle d'un indicateur.

Champs
gauge_id

string

ID du compteur.
gauge_model_id

string

ID du modèle du compteur. De temps en temps, le modèle d'un indicateur peut changer. Dans ce cas, nous attribuerons un nouvel ID et de nouveaux seuils au nouveau modèle. Soyez prudent lorsque vous comparez d'anciennes prévisions à de nouvelles si elles ont été produites par des modèles différents.
thresholds

Thresholds

Seuils de la jauge.
gauge_value_unit

GaugeValueUnit

Unité de valeur du modèle du graphique.
quality_verified

bool

Indique si ce modèle a été vérifié en termes de qualité. Veuillez l'utiliser avec précaution lorsque cette valeur est définie sur "false".

GaugeValueUnit

Unités de valeur de jauge possibles.

Enums
GAUGE_VALUE_UNIT_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
METERS Mètres.
CUBIC_METERS_PER_SECOND Mètres cubes par seconde.

GetGaugeModelRequest

Requête GetGaugeModel.

Champs
name

string

Obligatoire. Nom du modèle de jauge à récupérer. Format du nom : gaugeModels/{gauge_id}.

GetGaugeRequest

Requête GetGauge.

Champs
name

string

Obligatoire. Nom du compteur à récupérer. Format du nom : gauges/{gauge_id}.

GetSerializedPolygonRequest

Requête GetSerializedPolygon.

Champs
name

string

Obligatoire. Nom du polygone sérialisé à récupérer. Format du nom : serializedPolygons/{polygon_id}

Boucle

Une boucle sur la carte. Représente un polygone sphérique simple. Il se compose d'une seule chaîne de sommets où le premier sommet est implicitement connecté au dernier.

Champs
vertices[]

LatLng

Obligatoire. Sommets de la boucle.

QueryGaugeForecastsRequest

Requête QueryGaugeForecasts.

Champs
gauge_ids[]

string

Obligatoire. Liste des ID de jauges. La taille de la liste acceptée est limitée à 500. Si une liste de plus de 500 éléments est fournie, une erreur INVALID_REQUEST est générée.
issued_time_start

string

Facultatif. Heure d'émission de la prévision la plus ancienne sous forme de chaîne (ISO 8601), par exemple "2023-06-17T10:34:00Z" ou une chaîne de date, par exemple "2023-10-13". L'heure de début ne peut pas être antérieure au "2023-10-01". La valeur par défaut est "Il y a une semaine".
issued_time_end

string

Facultatif. Heure d'émission des dernières prévisions sous forme de chaîne (ISO 8601), par exemple "2023-06-17T10:34:00Z" ou une chaîne de date, par exemple "2023-10-13". La valeur par défaut est "now".

QueryGaugeForecastsResponse

Réponse de QueryGaugeForecasts.

Champs
forecasts

map<string, ForecastSet>

Mappage de l'ID du compteur à l'ensemble de prévisions.

QueryLatestFloodStatusByGaugeIdsRequest

Requête QueryLatestFloodStatusByGaugeIds.

Champs
gauge_ids[]

string

Obligatoire. Liste des ID de jauges. La taille de la liste est limitée à 20 000. Si une liste de plus de 20 000 éléments est fournie,une erreur INVALID_REQUEST est générée.

QueryLatestFloodStatusByGaugeIdsResponse

Réponse de QueryLatestFloodStatusByGaugeIds.

Champs
flood_statuses[]

FloodStatus

Derniers états d'inondation pour les jauges demandées.

SearchGaugesByAreaRequest

Requête SearchGaugesByArea.

Champs
page_size

int32

Facultatif. Nombre maximal de jauges à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur. Si aucune valeur n'est spécifiée, 50 000 compteurs au maximum sont renvoyés. La valeur maximale est 50 000. Les valeurs supérieures sont réduites à 50 000.
page_token

string

Facultatif. Jeton de page reçu d'un appel SearchGauges précédent. Fournissez-le pour récupérer la page suivante. Lors de la pagination, tous les autres paramètres fournis à SearchGauges doivent correspondre à l'appel ayant fourni le jeton de page.

Champ d'union search_by.

search_by ne peut être qu'un des éléments suivants :
region_code

string

Recherchez tous les indicateurs d'une région par code régional. Utilisez https://cldr.unicode.org/ (liste https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).
loop

Loop

Recherchez tous les indicateurs dans une boucle (un simple polygone sphérique, voir Loop).
include_non_quality_verified

bool

Facultatif. Incluez dans les résultats les jauges dont la qualité n'a pas été vérifiée. Veuillez l'utiliser avec précaution. La valeur par défaut est "false".
include_gauges_without_hydro_model

bool

Facultatif. Incluez dans les jauges de résultats celles qui ne disposent pas d'un modèle hydro interne à Google. La valeur par défaut est "false".

SearchGaugesByAreaResponse

Réponse de SearchGaugesByArea.

Champs
gauges[]

Gauge

Jauges trouvées dans la zone demandée.
next_page_token

string

Facultatif. Jeton pouvant être envoyé en tant que page_token pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

SearchLatestFloodStatusByAreaRequest

Requête SearchLatestFloodStatusByArea.

Champs
page_token

string

Facultatif. Jeton de page reçu d'un appel SearchLatestFloodStatusByArea précédent. Fournissez-le pour récupérer la page suivante. Lors de la pagination, tous les autres paramètres fournis à SearchLatestFloodStatusByArea doivent correspondre à l'appel ayant fourni le jeton de page.
page_size

int32

Facultatif. Nombre maximal d'états d'inondation à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur. Si aucune valeur n'est spécifiée, 20 000 états d'inondation au maximum sont renvoyés. La valeur maximale est 20 000. Les valeurs supérieures sont réduites à 20 000.

Champ d'union area_type.

area_type ne peut être qu'un des éléments suivants :
region_code

string

Région pour laquelle interroger les états des inondations. Utilisez CLDR, par exemple : 'US'.
loop

Loop

Boucle par laquelle interroger les états d'inondation.
include_non_quality_verified

bool

Facultatif. Incluez dans les résultats les jauges dont la qualité n'a pas été vérifiée. Veuillez l'utiliser avec précaution. La valeur par défaut est "false".

SearchLatestFloodStatusByAreaResponse

Réponse de SearchLatestFloodStatusByArea.

Champs
flood_statuses[]

FloodStatus

Les derniers états des inondations dans la zone demandée. Actuellement, cela dépend de l'emplacement des jauges, mais cela peut changer à l'avenir.
next_page_token

string

Facultatif. Jeton pouvant être envoyé en tant que page_token pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

SerializedPolygon

Polygone sérialisé.

Champs
polygon_id

string

Identifiant du polygone.
kml

string

Représentation sous forme de chaîne KML du polygone.

Seuils

Seuils du modèle d'une jauge.

Champs
warning_level

double

Niveau "Avertissement".
danger_level

double

Niveau de danger.
extreme_danger_level

double

Niveau de danger extrême. Pas toujours présent.

TimeRange

Une période.

Champs
start

string

Début de la période. Représenté au format ISO 8601, par exemple : "2023-06-17T10:34:00Z".
end

string

Fin de la période. Représenté au format ISO 8601, par exemple : "2023-06-17T10:34:00Z".