Method: gauges.queryGaugeForecasts

Previsioni del misuratore di query.

Richiesta HTTP

GET https://floodforecasting.googleapis.com/v1/gauges:queryGaugeForecasts

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di query

Parametri
gaugeIds[]

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.

issuedTimeStart

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.

issuedTimeEnd

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.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

La risposta di gauges.queryGaugeForecasts.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "forecasts": {
    string: {
      object (ForecastSet)
    },
    ...
  }
}
Campi
forecasts

map (key: string, value: object (ForecastSet))

Una mappa dall'ID indicatore al set di previsioni.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

ForecastSet

Un insieme di previsioni per un indicatore.

Rappresentazione JSON
{
  "forecasts": [
    {
      object (Forecast)
    }
  ]
}
Campi
forecasts[]

object (Forecast)

Le previsioni.

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]

Rappresentazione JSON
{
  "forecastRanges": [
    {
      object (ForecastTimedValue)
    }
  ],
  "gaugeId": string,
  "issuedTime": string
}
Campi
forecastRanges[]

object (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.

gaugeId

string

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

issuedTime

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.

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.

Rappresentazione JSON
{
  "value": number,
  "forecastStartTime": string,
  "forecastEndTime": string
}
Campi
value

number

Il valore della previsione.

forecastStartTime

string

L'inizio dell'intervallo.

forecastEndTime

string

La fine dell'intervallo.