Method: gauges.queryGaugeForecasts

Previsión de indicadores de consultas

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de consulta

Parámetros
gaugeIds[]

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.
issuedTimeStart

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.
issuedTimeEnd

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.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Es la respuesta de gauges.queryGaugeForecasts.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "forecasts": {
    string: {
      object (ForecastSet)
    },
    ...
  }
}
Campos
forecasts

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

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

Es un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

ForecastSet

Es un conjunto de previsiones para un indicador.

Representación JSON 
{
  "forecasts": [
    {
      object (Forecast)
    }
  ]
}
Campos
forecasts[]

object (Forecast)

Son las previsiones.

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.]

Representación JSON 
{
  "forecastRanges": [
    {
      object (ForecastTimedValue)
    }
  ],
  "gaugeId": string,
  "issuedTime": string
}
Campos
forecastRanges[]

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

string

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

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.

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.

Representación JSON 
{
  "value": number,
  "forecastStartTime": string,
  "forecastEndTime": string
}
Campos
value

number

Es el valor del pronóstico.
forecastStartTime

string

Es el inicio del intervalo.
forecastEndTime

string

Es el final del intervalo.