Forecast¶

class oci.usage_api.models.Forecast(**kwargs)¶

Bases: object

Forecast configuration of usage/cost.

Attributes

`FORECAST_TYPE_BASIC`	A constant which can be used with the forecast_type property of a Forecast.
`forecast_type`	Gets the forecast_type of this Forecast.
`time_forecast_ended`	[Required] Gets the time_forecast_ended of this Forecast.
`time_forecast_started`	Gets the time_forecast_started of this Forecast.

Methods

__init__(**kwargs) Initializes a new Forecast object with values from keyword arguments.

FORECAST_TYPE_BASIC = 'BASIC'¶: A constant which can be used with the forecast_type property of a Forecast. This constant has a value of “BASIC”

__init__(**kwargs)¶

Initializes a new Forecast object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

forecast_type (str) – The value to assign to the forecast_type property of this Forecast. Allowed values for this property are: “BASIC”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_forecast_started (datetime) – The value to assign to the time_forecast_started property of this Forecast.
time_forecast_ended (datetime) – The value to assign to the time_forecast_ended property of this Forecast.

forecast_type¶

Gets the forecast_type of this Forecast. BASIC uses the exponential smoothing (ETS) model to project future usage/costs based on history data. The basis for projections is a periodic set of equivalent historical days for which the projection is being made.

Allowed values for this property are: “BASIC”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The forecast_type of this Forecast.
Return type:	str

time_forecast_ended¶

[Required] Gets the time_forecast_ended of this Forecast. The forecast end time.

Returns:	The time_forecast_ended of this Forecast.
Return type:	datetime

time_forecast_started¶

Gets the time_forecast_started of this Forecast. The forecast start time. Defaults to UTC-1 if not specified.

Returns:	The time_forecast_started of this Forecast.
Return type:	datetime