Method: gauges.queryGaugeForecasts

Consulta previsões de medidor.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de consulta

Parâmetros
gaugeIds[]

string

Obrigatório. Uma lista de IDs de medidores. O tamanho da lista aceita é limitado a 500. Se uma lista maior que 500 for fornecida, ela vai falhar com um erro INVALID_REQUEST.
issuedTimeStart

string

Opcional. A primeira hora de emissão da previsão como string (ISO 8601), por exemplo, "2023-06-17T10:34:00Z" ou uma string de data, por exemplo, "2023-10-13". O horário de início não pode ser anterior a "2023-10-01". O padrão é uma semana atrás.
issuedTimeEnd

string

Opcional. A última hora de emissão da previsão como string (ISO 8601), por exemplo, "2023-06-17T10:34:00Z" ou uma string de data, por exemplo, "2023-10-13". O padrão é "agora".

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

A resposta de "gauges.queryGaugeForecasts".

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "forecasts": {
    string: {
      object (ForecastSet)
    },
    ...
  }
}
Campos
forecasts

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

Um mapa do ID do medidor para o conjunto de previsão.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

ForecastSet

Um conjunto de previsões para um medidor.

Representação JSON 
{
  "forecasts": [
    {
      object (Forecast)
    }
  ]
}
Campos
forecasts[]

object (Forecast)

As previsões.

Previsão

A previsão de um único indicador para vários prazos de antecedência. Por exemplo, uma previsão pode ter o horário de emissão às 17h e incluir previsões para 18h, 19h, 20h etc.

Observação: alguns intervalos de previsão podem ser anteriores ao horário de emissão. Isso pode acontecer devido a atrasos nos dados de entrada do modelo, por exemplo. No exemplo acima, o horário do problema pode ser 17h, e os intervalos de previsão são para 16h, 17h, 18h etc.

Observação: os intervalos variam em duração e distância entre eles. Alguns exemplos de intervalos possíveis:

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

  2. [1º de março, 0h - 2 de março, 0h], [2 de março, 0h - 3 de março, 0h], [3 de março, 0h - 4 de março, 0h]

Representação JSON 
{
  "forecastRanges": [
    {
      object (ForecastTimedValue)
    }
  ],
  "gaugeId": string,
  "issuedTime": string
}
Campos
forecastRanges[]

object (ForecastTimedValue)

Uma previsão consiste em vários "intervalos de previsão", que são diferentes valores de previsão relacionados a diferentes períodos. Quando o início e o fim de um intervalo são iguais, significa que é um instante.
gaugeId

string

O ID do medidor a que essa previsão se refere.
issuedTime

string

O horário de emissão da previsão (ISO 8601), por exemplo, "2023-06-17T10:34:00Z". O horário de emissão é o horário em que a previsão foi gerada.

ForecastTimedValue

Um valor de previsão referente a um período. As unidades são definidas pelo GaugeModel associado. Se o início e o fim forem iguais, significa que é um instante.

Representação JSON 
{
  "value": number,
  "forecastStartTime": string,
  "forecastEndTime": string
}
Campos
value

number

O valor da previsão.
forecastStartTime

string

O início do intervalo.
forecastEndTime

string

O fim do intervalo.