Stackdriver Monitoring V3 Client - Class ForecastOptions (1.9.0)

Reference documentation and code samples for the Stackdriver Monitoring V3 Client class ForecastOptions.

Options used when forecasting the time series and testing the predicted value against the threshold.

Generated from protobuf message google.monitoring.v3.AlertPolicy.Condition.MetricThreshold.ForecastOptions

Namespace

Google \ Cloud \ Monitoring \ V3 \ AlertPolicy \ Condition \ MetricThreshold

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ forecast_horizon Google\Protobuf\Duration

Required. The length of time into the future to forecast whether a time series will violate the threshold. If the predicted value is found to violate the threshold, and the violation is observed in all forecasts made for the configured duration, then the time series is considered to be failing. The forecast horizon can range from 1 hour to 60 hours.

getForecastHorizon

Required. The length of time into the future to forecast whether a time series will violate the threshold. If the predicted value is found to violate the threshold, and the violation is observed in all forecasts made for the configured duration, then the time series is considered to be failing.

The forecast horizon can range from 1 hour to 60 hours.

Returns
TypeDescription
Google\Protobuf\Duration|null

hasForecastHorizon

clearForecastHorizon

setForecastHorizon

Required. The length of time into the future to forecast whether a time series will violate the threshold. If the predicted value is found to violate the threshold, and the violation is observed in all forecasts made for the configured duration, then the time series is considered to be failing.

The forecast horizon can range from 1 hour to 60 hours.

Parameter
NameDescription
var Google\Protobuf\Duration
Returns
TypeDescription
$this