Package google.research.floodforecasting.v1

Indice

FloodsApi

Un servizio API esterno per la previsione delle inondazioni.

BatchGetGaugeModels

rpc BatchGetGaugeModels(BatchGetGaugeModelsRequest) returns (BatchGetGaugeModelsResponse)

Recupera i metadati del modello idrologico attuale per più indicatori.
BatchGetGauges

rpc BatchGetGauges(BatchGetGaugesRequest) returns (BatchGetGaugesResponse)

Recupera i metadati relativi a più indicatori.
GetGauge

rpc GetGauge(GetGaugeRequest) returns (Gauge)

Recupera i metadati di un indicatore.
GetGaugeModel

rpc GetGaugeModel(GetGaugeModelRequest) returns (GaugeModel)

Recupera i metadati del modello idrologico corrente per un determinato indicatore.
GetSerializedPolygon

rpc GetSerializedPolygon(GetSerializedPolygonRequest) returns (SerializedPolygon)

Ottieni un poligono serializzato. I relativi ID verranno visualizzati in altre risposte API e potrai utilizzarli qui. Ad esempio, vedi InundationMap in FloodStatus.
QueryGaugeForecasts

rpc QueryGaugeForecasts(QueryGaugeForecastsRequest) returns (QueryGaugeForecastsResponse)

Previsioni del misuratore di query.
QueryLatestFloodStatusByGaugeIds

rpc QueryLatestFloodStatusByGaugeIds(QueryLatestFloodStatusByGaugeIdsRequest) returns (QueryLatestFloodStatusByGaugeIdsResponse)

Esegui query sullo stato più recente dell'inondazione in base agli ID dei misuratori.
SearchGaugesByArea

rpc SearchGaugesByArea(SearchGaugesByAreaRequest) returns (SearchGaugesByAreaResponse)

Cerca indicatori per area geografica.

Nota: gli indicatori vengono aggiunti o rimossi di tanto in tanto, pertanto il risultato di questa API non deve essere memorizzato nella cache o archiviato per lunghi periodi di tempo. Considera un periodo non superiore a un giorno come relativamente sicuro.
SearchLatestFloodStatusByArea

rpc SearchLatestFloodStatusByArea(SearchLatestFloodStatusByAreaRequest) returns (SearchLatestFloodStatusByAreaResponse)

Cerca lo stato più recente delle inondazioni per area geografica. Nota: restituisce gli stati di inondazione il cui livello si trova all'interno dell'area specificata, anziché, ad esempio, l'area interessata che interseca l'area specificata. Ciò può cambiare in futuro.

BatchGetGaugeModelsRequest

La richiesta di BatchGetGaugeModels.

Campi
names[]

string

Obbligatorio. I nomi dei modelli di indicatori da recuperare. Formato del nome: gaugeModels/{gauge_id}. La dimensione dell'elenco supportato è limitata a 20.000. Se viene fornito un elenco più grande di 20.000 elementi,la richiesta non va a buon fine e viene restituito un errore INVALID_REQUEST.

BatchGetGaugeModelsResponse

La risposta di BatchGetGaugeModels.

Campi
gauge_models[]

GaugeModel

I modelli di indicatori richiesti.

BatchGetGaugesRequest

La richiesta di BatchGetGauges.

Campi
names[]

string

Obbligatorio. I nomi dei contatori da recuperare. Formato del nome: gauges/{gauge_id}. La dimensione dell'elenco supportato è limitata a 100.000. Se viene fornito un elenco più grande di 100.000 elementi,la richiesta non va a buon fine e viene generato un errore INVALID_REQUEST.

BatchGetGaugesResponse

La risposta di BatchGetGauges.

Campi
gauges[]

Gauge

Gli indicatori richiesti.

FloodStatus

Uno stato di inondazione emesso dal sistema. Rappresenta lo stato di inondazione previsto dal sistema per un'area, con attributi quali gravità, variazione della previsione, mappe di inondazione e altri. Per ulteriori dettagli, continua a leggere.

Campi
gauge_id

string

L'ID del misuratore per cui è stato emesso questo stato.
quality_verified

bool

True se il misuratore per cui è stato emesso questo stato di inondazione non ha un modello o se ha un modello e questo è stato verificato per la qualità. Utilizza questa impostazione con cautela quando il valore è impostato su false.
gauge_location

LatLng

La posizione del misuratore per cui è stato emesso questo stato.
issued_time

string

L'ora in cui è stato emesso questo stato come stringa (ISO 8601), ad esempio: "2023-06-17T10:34:00Z".
forecast_time_range

TimeRange

L'intervallo di tempo per cui viene effettuata la previsione.
forecast_change

ForecastChange

La variazione del valore della previsione dall'ultimo stato noto alla previsione. Attualmente disponibile solo per i modelli di livello dell'acqua.
forecast_trend

ForecastTrend

La tendenza della previsione.
map_inference_type

MapInferenceType

Il tipo di inferenza con cui è stata creata questa mappa.
severity

Severity

La gravità dello stato.
inundation_map_set

InundationMapSet

Il set di mappe di inondazione dedotte.
source

string

L'organizzazione responsabile dei dati di questo indicatore, ad esempio GRDC, CWC, ecc.
serialized_notification_polygon_id

string

Un ID del poligono di notifica serializzato, che rappresenta l'area geografica utilizzata da Google per determinare quando avvisare i suoi utenti. Utilizza GetSerializedPolygon per ottenere il poligono serializzato.

ForecastChange

La variazione del valore previsto dall'ultimo stato noto alla previsione. Attualmente disponibile solo per i modelli di livello dell'acqua.

Campi
value_change

ValueChange

La variazione prevista dei valori.
reference_time_range

TimeRange

Intervallo di tempo dell'ultimo stato noto, da cui prevediamo la variazione del valore. Ad esempio, potremmo avere un intervallo di tempo di riferimento impostato su ieri e una variazione di valore di 25-30 cm. Ciò significa che l'innalzamento del livello dell'acqua di 25-30 cm viene confrontato con il valore di ieri, non con il valore attuale.

ValueChange

La variazione prevista dei valori, con un limite superiore e uno inferiore.

Campi
lower_bound

double

Il limite inferiore della variazione della previsione in metri. Se la variazione è compresa tra 20 e 30, questo valore sarà 20. Se la variazione è compresa tra -30 e -20, questo valore sarà -30.
upper_bound

double

Il limite superiore della variazione della previsione in metri. Se la variazione è compresa tra 20 e 30, questo valore sarà 30. Se la variazione è compresa tra -30 e -20, questo valore sarà -20.

ForecastTrend

Un'enumerazione che rappresenta la tendenza della previsione.

Enum
FORECAST_TREND_UNSPECIFIED Valore predefinito. Questo valore non viene utilizzato.
RISE Ciò indica un aumento del valore previsto.
FALL Indica un calo del valore previsto.
NO_CHANGE Ciò indica che non è stata apportata alcuna modifica al valore previsto.

InundationMap

Una mappa delle inondazioni.

Campi
level

InundationLevel

Il livello della mappa di inondazione: consulta la documentazione in base a InundationMapType.
serialized_polygon_id

string

Un ID del poligono serializzato che rappresenta questa mappa del rischio di inondazione. Utilizza GetSerializedPolygon per ottenere il poligono serializzato.

InundationLevel

Un'enumerazione che rappresenta i livelli di inondazione.

Enum
INUNDATION_LEVEL_UNSPECIFIED Valore predefinito. Questo valore non viene utilizzato.
HIGH Consulta la documentazione in base a InundationMapType.
MEDIUM Consulta la documentazione in base a InundationMapType.
LOW Consulta la documentazione in base a InundationMapType.

InundationMapSet

Un insieme di mappe delle inondazioni.

Campi
inundation_maps[]

InundationMap

Le mappe delle inondazioni, una per ogni livello di inondazione.
inundation_maps_time_range

TimeRange

L'intervallo di tempo dello stato a cui fanno riferimento le mappe di inondazione.
inundation_map_type

InundationMapType

Il tipo di mappa delle inondazioni.

InundationMapType

Un'enumerazione che rappresenta il tipo di mappa di inondazione.

Enum
INUNDATION_MAP_TYPE_UNSPECIFIED Valore predefinito. Questo valore non viene utilizzato.
PROBABILITY Una mappa della probabilità del tipo. InundationLevel rappresenta la probabilità della mappa: probabilità alta/media/bassa di inondazione. Il poligono di probabilità alta è contenuto all'interno del poligono di probabilità media e il poligono di probabilità media è contenuto all'interno del poligono di probabilità bassa.
DEPTH Una mappa della profondità del tipo. InundationLevel rappresenta la profondità della mappa: profondità alta/media/bassa per località. Il poligono ad alta profondità è contenuto all'interno del poligono a media profondità, che a sua volta è contenuto all'interno del poligono a bassa profondità.

MapInferenceType

Un'enumerazione che rappresenta i tipi di inferenze della mappa.

Enum
MAP_INFERENCE_TYPE_UNSPECIFIED Valore predefinito. Questo valore non viene utilizzato.
MODEL Ciò indica che questa inferenza è stata creata utilizzando un modello.
IMAGE_CLASSIFICATION Ciò indica che questa inferenza è stata creata utilizzando una classificazione delle immagini.

Gravità

Un'enumerazione che rappresenta la gravità dello stato.

Enum
SEVERITY_UNSPECIFIED Valore predefinito. Questo valore non viene utilizzato.
EXTREME Indica uno stato estremo previsto.
SEVERE Indica uno stato grave previsto.
ABOVE_NORMAL Indica uno stato previsto superiore al normale.
NO_FLOODING Ciò indica una previsione di assenza di inondazioni.
UNKNOWN Ciò indica che non disponiamo di informazioni sufficienti per determinare la gravità.

Previsione

La previsione di un singolo indicatore per diversi lead time. Ad esempio, una previsione potrebbe avere un orario di emissione delle 17:00 e includere previsioni per le 18:00, le 19:00, le 20:00 e così via.

Nota: alcuni intervalli di previsione potrebbero essere precedenti all'ora di emissione. Ciò può accadere, ad esempio, a causa di ritardi nei dati di input per il modello. Nell'esempio precedente, l'ora del problema potrebbe essere le 17:00 e gli intervalli di previsione sono per le 16:00, le 17:00, le 18:00 e così via.

Nota: gli intervalli variano in lunghezza e in distanza tra loro. Ecco alcuni esempi di intervalli possibili:

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

  2. [1 mar 00:00 - 2 mar 00:00], [2 mar 00:00 - 3 mar 00:00], [3 mar 00:00 - 4 mar 00:00]

Campi
forecast_ranges[]

ForecastTimedValue

Una previsione è costituita da diversi "intervalli di previsione", ovvero valori di previsione diversi relativi a intervalli di tempo diversi. Quando l'inizio e la fine di un intervallo sono uguali, significa che si tratta di un istante temporale.
gauge_id

string

L'ID del misuratore a cui si riferisce questa previsione.
issued_time

string

L'ora di emissione della previsione (ISO 8601), ad esempio "2023-06-17T10:34:00Z". L'ora di emissione è l'ora in cui è stata generata la previsione.

ForecastSet

Un insieme di previsioni per un indicatore.

Campi
forecasts[]

Forecast

Le previsioni.

ForecastTimedValue

Un valore di previsione relativo a un intervallo di tempo. Le sue unità sono definite da GaugeModel a cui è associato. Se l'inizio e la fine sono uguali, significa che si tratta di un istante temporale.

Campi
value

double

Il valore della previsione.
forecast_start_time

string

L'inizio dell'intervallo.
forecast_end_time

string

La fine dell'intervallo.

Misuratore

Metadati di un indicatore.

Campi
location

LatLng

La posizione fisica del manometro.
site_name

string

Il nome del sito in cui si trova questo indicatore, in inglese. Non si tratta di un identificatore univoco; potrebbero esserci diversi indicatori in località vicine con lo stesso nome del sito. Non sempre presente.
source

string

L'organizzazione responsabile dei dati di questo indicatore, ad es. GRDC, CWC e così via.
river

string

Il nome del fiume del misuratore in inglese. Non sempre presente.
country_code

string

Il codice paese del paese del misuratore (ISO 3166 Alpha-2).
gauge_id

string

L'ID del misuratore.
quality_verified

bool

Questo campo è true se il misuratore non ha un modello oppure se ha un modello e questo è stato verificato per la qualità. Utilizza questa impostazione con cautela quando il valore è impostato su false.
has_model

bool

Questo campo è true se il misuratore ha un modello. Se il manometro ha un modello, è possibile ottenere il GaugeModel di questo manometro utilizzando GetGaugeModel o BatchGetGaugeModels. e ottenere le previsioni utilizzando QueryGaugeForecasts.

GaugeModel

Metadati del modello di un indicatore.

Campi
gauge_id

string

L'ID del misuratore.
gauge_model_id

string

L'ID del modello del misuratore. Di tanto in tanto, il modello di un indicatore potrebbe cambiare. In questo caso, assegneremo un nuovo ID e nuove soglie al nuovo modello. Presta attenzione quando confronti le vecchie previsioni con quelle nuove se sono state prodotte da modelli diversi.
thresholds

Thresholds

Le soglie del misuratore.
gauge_value_unit

GaugeValueUnit

L'unità di valore del modello del misuratore.
quality_verified

bool

Indica se questo modello è stato verificato per la qualità. Utilizza questa impostazione con cautela quando il valore è impostato su false.

GaugeValueUnit

Unità di misura possibili per il valore del misuratore.

Enum
GAUGE_VALUE_UNIT_UNSPECIFIED Valore predefinito. Questo valore non viene utilizzato.
METERS Metri.
CUBIC_METERS_PER_SECOND Metri cubi al secondo.

GetGaugeModelRequest

La richiesta di GetGaugeModel.

Campi
name

string

Obbligatorio. Il nome del modello di indicatore da recuperare. Formato del nome: gaugeModels/{gauge_id}.

GetGaugeRequest

La richiesta di GetGauge.

Campi
name

string

Obbligatorio. Il nome del misuratore da recuperare. Formato del nome: gauges/{gauge_id}.

GetSerializedPolygonRequest

La richiesta di GetSerializedPolygon.

Campi
name

string

Obbligatorio. Il nome del poligono serializzato da recuperare. Formato del nome: serializedPolygons/{polygon_id}

Loop

Un anello sulla mappa. Rappresenta un semplice poligono sferico. È costituita da una singola catena di vertici in cui il primo vertice è collegato implicitamente all'ultimo.

Campi
vertices[]

LatLng

Obbligatorio. I vertici del ciclo.

QueryGaugeForecastsRequest

La richiesta di QueryGaugeForecasts.

Campi
gauge_ids[]

string

Obbligatorio. Un elenco di ID contatore. Le dimensioni dell'elenco supportato sono limitate a 500. Se viene fornito un elenco più grande di 500 elementi, la richiesta non va a buon fine e viene restituito un errore INVALID_REQUEST.
issued_time_start

string

(Facoltativo) L'ora di emissione della prima previsione come stringa (ISO 8601), ad es. "2023-06-17T10:34:00Z" o una stringa di data, ad es. "2023-10-13". L'ora di inizio non può essere precedente al giorno 1/10/2023. Il valore predefinito è una settimana fa.
issued_time_end

string

(Facoltativo) L'ora di emissione della previsione più recente come stringa (ISO 8601), ad es. "2023-06-17T10:34:00Z" o una stringa di data, ad es. "2023-10-13". Il valore predefinito è ora.

QueryGaugeForecastsResponse

La risposta di QueryGaugeForecasts.

Campi
forecasts

map<string, ForecastSet>

Una mappa dall'ID indicatore al set di previsioni.

QueryLatestFloodStatusByGaugeIdsRequest

La richiesta di QueryLatestFloodStatusByGaugeIds.

Campi
gauge_ids[]

string

Obbligatorio. Un elenco di ID contatore. La dimensione dell'elenco supportato è limitata a 20.000. Se viene fornito un elenco più grande di 20.000 elementi,la richiesta non va a buon fine e viene restituito un errore INVALID_REQUEST.

QueryLatestFloodStatusByGaugeIdsResponse

La risposta di QueryLatestFloodStatusByGaugeIds.

Campi
flood_statuses[]

FloodStatus

Gli ultimi stati di inondazione per i misuratori richiesti.

SearchGaugesByAreaRequest

La richiesta di SearchGaugesByArea.

Campi
page_size

int32

(Facoltativo) Il numero massimo di indicatori da restituire. Il servizio potrebbe restituire un numero inferiore a questo valore. Se non specificato, verranno restituiti al massimo 50.000 indicatori. Il valore massimo è 50.000; i valori superiori a 50.000 verranno forzati a 50.000.
page_token

string

(Facoltativo) Un token di pagina ricevuto da una precedente chiamata SearchGauges. Forniscilo per recuperare la pagina successiva. Durante la paginazione, tutti gli altri parametri forniti a SearchGauges devono corrispondere alla chiamata che ha fornito il token di pagina.

Campo unione search_by.

search_by può essere solo uno dei seguenti:
region_code

string

Cerca tutti gli indicatori all'interno di una regione in base al codice regione. Utilizza https://cldr.unicode.org/ (elenco https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).
loop

Loop

Cerca tutti gli indicatori all'interno di un loop (un semplice poligono sferico, vedi Loop).
include_non_quality_verified

bool

(Facoltativo) Includi nei grafici dei risultati quelli non verificati in termini di qualità. Utilizzalo con cautela. Il valore predefinito è false.
include_gauges_without_hydro_model

bool

(Facoltativo) Includi nei misuratori dei risultati quelli che non hanno un modello idrico interno di Google. Il valore predefinito è false.

SearchGaugesByAreaResponse

La risposta di SearchGaugesByArea.

Campi
gauges[]

Gauge

Indicatori trovati nell'area richiesta.
next_page_token

string

(Facoltativo) Un token che può essere inviato come page_token per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

SearchLatestFloodStatusByAreaRequest

La richiesta di SearchLatestFloodStatusByArea.

Campi
page_token

string

(Facoltativo) Un token di pagina ricevuto da una precedente chiamata SearchLatestFloodStatusByArea. Forniscilo per recuperare la pagina successiva. Durante la paginazione, tutti gli altri parametri forniti a SearchLatestFloodStatusByArea devono corrispondere alla chiamata che ha fornito il token di pagina.
page_size

int32

(Facoltativo) Il numero massimo di stati di inondazione da restituire. Il servizio potrebbe restituire un numero inferiore a questo valore. Se non specificato, verranno restituiti al massimo 20.000 stati di inondazione. Il valore massimo è 20.000; i valori superiori a 20.000 verranno forzati a 20.000.

Campo unione area_type.

area_type può essere solo uno dei seguenti:
region_code

string

La regione in base alla quale eseguire query sugli stati di inondazione. Utilizzando CLDR, ad es. 'US'.
loop

Loop

Il ciclo in base al quale eseguire query sugli stati delle inondazioni.
include_non_quality_verified

bool

(Facoltativo) Includi nei grafici dei risultati quelli non verificati in termini di qualità. Utilizzalo con cautela. Il valore predefinito è false.

SearchLatestFloodStatusByAreaResponse

La risposta di SearchLatestFloodStatusByArea.

Campi
flood_statuses[]

FloodStatus

Gli ultimi stati di allerta alluvione nell'area richiesta. Al momento, questo valore è determinato dalla posizione degli indicatori, ma è soggetto a modifiche in futuro.
next_page_token

string

(Facoltativo) Un token che può essere inviato come page_token per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

SerializedPolygon

Un poligono serializzato.

Campi
polygon_id

string

L'ID del poligono.
kml

string

La rappresentazione della stringa KML del poligono.

Soglie

Soglie del modello di un misuratore.

Campi
warning_level

double

Livello di avviso.
danger_level

double

Livello di pericolo.
extreme_danger_level

double

Livello di pericolo estremo. Non sempre presente.

TimeRange

Un intervallo di tempo.

Campi
start

string

L'inizio dell'intervallo di tempo. Rappresentato come ISO 8601, ad esempio: "2023-06-17T10:34:00Z".
end

string

La fine dell'intervallo di tempo. Rappresentato come ISO 8601, ad esempio: "2023-06-17T10:34:00Z".