SummarizeHostInsightResourceForecastTrendAggregation

class oci.opsi.models.SummarizeHostInsightResourceForecastTrendAggregation(**kwargs)

Bases: object

Forecast results from the selected time period.

Attributes:

PATTERN_LINEAR

A constant which can be used with the pattern property of a SummarizeHostInsightResourceForecastTrendAggregation.

PATTERN_MONTHLY_AND_YEARLY_SEASONS

A constant which can be used with the pattern property of a SummarizeHostInsightResourceForecastTrendAggregation.

PATTERN_MONTHLY_SEASONS

A constant which can be used with the pattern property of a SummarizeHostInsightResourceForecastTrendAggregation.

PATTERN_WEEKLY_AND_MONTHLY_SEASONS

A constant which can be used with the pattern property of a SummarizeHostInsightResourceForecastTrendAggregation.

PATTERN_WEEKLY_AND_YEARLY_SEASONS

A constant which can be used with the pattern property of a SummarizeHostInsightResourceForecastTrendAggregation.

PATTERN_WEEKLY_MONTHLY_AND_YEARLY_SEASONS

A constant which can be used with the pattern property of a SummarizeHostInsightResourceForecastTrendAggregation.

PATTERN_WEEKLY_SEASONS

A constant which can be used with the pattern property of a SummarizeHostInsightResourceForecastTrendAggregation.

PATTERN_YEARLY_SEASONS

A constant which can be used with the pattern property of a SummarizeHostInsightResourceForecastTrendAggregation.

RESOURCE_METRIC_CPU

A constant which can be used with the resource_metric property of a SummarizeHostInsightResourceForecastTrendAggregation.

RESOURCE_METRIC_GPU_MEMORY_USAGE

A constant which can be used with the resource_metric property of a SummarizeHostInsightResourceForecastTrendAggregation.

RESOURCE_METRIC_GPU_UTILIZATION

A constant which can be used with the resource_metric property of a SummarizeHostInsightResourceForecastTrendAggregation.

RESOURCE_METRIC_IO

A constant which can be used with the resource_metric property of a SummarizeHostInsightResourceForecastTrendAggregation.

RESOURCE_METRIC_LOGICAL_MEMORY

A constant which can be used with the resource_metric property of a SummarizeHostInsightResourceForecastTrendAggregation.

RESOURCE_METRIC_MEMORY

A constant which can be used with the resource_metric property of a SummarizeHostInsightResourceForecastTrendAggregation.

RESOURCE_METRIC_NETWORK

A constant which can be used with the resource_metric property of a SummarizeHostInsightResourceForecastTrendAggregation.

RESOURCE_METRIC_STORAGE

A constant which can be used with the resource_metric property of a SummarizeHostInsightResourceForecastTrendAggregation.

USAGE_UNIT_CORES

A constant which can be used with the usage_unit property of a SummarizeHostInsightResourceForecastTrendAggregation.

USAGE_UNIT_GB

A constant which can be used with the usage_unit property of a SummarizeHostInsightResourceForecastTrendAggregation.

USAGE_UNIT_IOPS

A constant which can be used with the usage_unit property of a SummarizeHostInsightResourceForecastTrendAggregation.

USAGE_UNIT_MBPS

A constant which can be used with the usage_unit property of a SummarizeHostInsightResourceForecastTrendAggregation.

USAGE_UNIT_PERCENT

A constant which can be used with the usage_unit property of a SummarizeHostInsightResourceForecastTrendAggregation.

high_utilization_threshold

[Required] Gets the high_utilization_threshold of this SummarizeHostInsightResourceForecastTrendAggregation.

historical_data

[Required] Gets the historical_data of this SummarizeHostInsightResourceForecastTrendAggregation.

low_utilization_threshold

[Required] Gets the low_utilization_threshold of this SummarizeHostInsightResourceForecastTrendAggregation.

pattern

[Required] Gets the pattern of this SummarizeHostInsightResourceForecastTrendAggregation.

projected_data

[Required] Gets the projected_data of this SummarizeHostInsightResourceForecastTrendAggregation.

resource_metric

[Required] Gets the resource_metric of this SummarizeHostInsightResourceForecastTrendAggregation.

selected_forecast_algorithm

Gets the selected_forecast_algorithm of this SummarizeHostInsightResourceForecastTrendAggregation.

time_interval_end

[Required] Gets the time_interval_end of this SummarizeHostInsightResourceForecastTrendAggregation.

time_interval_start

[Required] Gets the time_interval_start of this SummarizeHostInsightResourceForecastTrendAggregation.

usage_unit

[Required] Gets the usage_unit of this SummarizeHostInsightResourceForecastTrendAggregation.

Methods:

__init__(**kwargs)

Initializes a new SummarizeHostInsightResourceForecastTrendAggregation object with values from keyword arguments.

PATTERN_LINEAR = 'LINEAR'

A constant which can be used with the pattern property of a SummarizeHostInsightResourceForecastTrendAggregation. This constant has a value of “LINEAR”

PATTERN_MONTHLY_AND_YEARLY_SEASONS = 'MONTHLY_AND_YEARLY_SEASONS'

A constant which can be used with the pattern property of a SummarizeHostInsightResourceForecastTrendAggregation. This constant has a value of “MONTHLY_AND_YEARLY_SEASONS”

PATTERN_MONTHLY_SEASONS = 'MONTHLY_SEASONS'

A constant which can be used with the pattern property of a SummarizeHostInsightResourceForecastTrendAggregation. This constant has a value of “MONTHLY_SEASONS”

PATTERN_WEEKLY_AND_MONTHLY_SEASONS = 'WEEKLY_AND_MONTHLY_SEASONS'

A constant which can be used with the pattern property of a SummarizeHostInsightResourceForecastTrendAggregation. This constant has a value of “WEEKLY_AND_MONTHLY_SEASONS”

PATTERN_WEEKLY_AND_YEARLY_SEASONS = 'WEEKLY_AND_YEARLY_SEASONS'

A constant which can be used with the pattern property of a SummarizeHostInsightResourceForecastTrendAggregation. This constant has a value of “WEEKLY_AND_YEARLY_SEASONS”

PATTERN_WEEKLY_MONTHLY_AND_YEARLY_SEASONS = 'WEEKLY_MONTHLY_AND_YEARLY_SEASONS'

A constant which can be used with the pattern property of a SummarizeHostInsightResourceForecastTrendAggregation. This constant has a value of “WEEKLY_MONTHLY_AND_YEARLY_SEASONS”

PATTERN_WEEKLY_SEASONS = 'WEEKLY_SEASONS'

A constant which can be used with the pattern property of a SummarizeHostInsightResourceForecastTrendAggregation. This constant has a value of “WEEKLY_SEASONS”

PATTERN_YEARLY_SEASONS = 'YEARLY_SEASONS'

A constant which can be used with the pattern property of a SummarizeHostInsightResourceForecastTrendAggregation. This constant has a value of “YEARLY_SEASONS”

RESOURCE_METRIC_CPU = 'CPU'

A constant which can be used with the resource_metric property of a SummarizeHostInsightResourceForecastTrendAggregation. This constant has a value of “CPU”

RESOURCE_METRIC_GPU_MEMORY_USAGE = 'GPU_MEMORY_USAGE'

A constant which can be used with the resource_metric property of a SummarizeHostInsightResourceForecastTrendAggregation. This constant has a value of “GPU_MEMORY_USAGE”

RESOURCE_METRIC_GPU_UTILIZATION = 'GPU_UTILIZATION'

A constant which can be used with the resource_metric property of a SummarizeHostInsightResourceForecastTrendAggregation. This constant has a value of “GPU_UTILIZATION”

RESOURCE_METRIC_IO = 'IO'

A constant which can be used with the resource_metric property of a SummarizeHostInsightResourceForecastTrendAggregation. This constant has a value of “IO”

RESOURCE_METRIC_LOGICAL_MEMORY = 'LOGICAL_MEMORY'

A constant which can be used with the resource_metric property of a SummarizeHostInsightResourceForecastTrendAggregation. This constant has a value of “LOGICAL_MEMORY”

RESOURCE_METRIC_MEMORY = 'MEMORY'

A constant which can be used with the resource_metric property of a SummarizeHostInsightResourceForecastTrendAggregation. This constant has a value of “MEMORY”

RESOURCE_METRIC_NETWORK = 'NETWORK'

A constant which can be used with the resource_metric property of a SummarizeHostInsightResourceForecastTrendAggregation. This constant has a value of “NETWORK”

RESOURCE_METRIC_STORAGE = 'STORAGE'

A constant which can be used with the resource_metric property of a SummarizeHostInsightResourceForecastTrendAggregation. This constant has a value of “STORAGE”

USAGE_UNIT_CORES = 'CORES'

A constant which can be used with the usage_unit property of a SummarizeHostInsightResourceForecastTrendAggregation. This constant has a value of “CORES”

USAGE_UNIT_GB = 'GB'

A constant which can be used with the usage_unit property of a SummarizeHostInsightResourceForecastTrendAggregation. This constant has a value of “GB”

USAGE_UNIT_IOPS = 'IOPS'

A constant which can be used with the usage_unit property of a SummarizeHostInsightResourceForecastTrendAggregation. This constant has a value of “IOPS”

USAGE_UNIT_MBPS = 'MBPS'

A constant which can be used with the usage_unit property of a SummarizeHostInsightResourceForecastTrendAggregation. This constant has a value of “MBPS”

USAGE_UNIT_PERCENT = 'PERCENT'

A constant which can be used with the usage_unit property of a SummarizeHostInsightResourceForecastTrendAggregation. This constant has a value of “PERCENT”

__init__(**kwargs)

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

Parameters
  • time_interval_start (datetime) – The value to assign to the time_interval_start property of this SummarizeHostInsightResourceForecastTrendAggregation.

  • time_interval_end (datetime) – The value to assign to the time_interval_end property of this SummarizeHostInsightResourceForecastTrendAggregation.

  • high_utilization_threshold (int) – The value to assign to the high_utilization_threshold property of this SummarizeHostInsightResourceForecastTrendAggregation.

  • low_utilization_threshold (int) – The value to assign to the low_utilization_threshold property of this SummarizeHostInsightResourceForecastTrendAggregation.

  • resource_metric (str) – The value to assign to the resource_metric property of this SummarizeHostInsightResourceForecastTrendAggregation. Allowed values for this property are: “CPU”, “MEMORY”, “LOGICAL_MEMORY”, “STORAGE”, “NETWORK”, “GPU_UTILIZATION”, “GPU_MEMORY_USAGE”, “IO”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • usage_unit (str) – The value to assign to the usage_unit property of this SummarizeHostInsightResourceForecastTrendAggregation. Allowed values for this property are: “CORES”, “GB”, “MBPS”, “IOPS”, “PERCENT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • selected_forecast_algorithm (str) – The value to assign to the selected_forecast_algorithm property of this SummarizeHostInsightResourceForecastTrendAggregation.

  • pattern (str) – The value to assign to the pattern property of this SummarizeHostInsightResourceForecastTrendAggregation. Allowed values for this property are: “LINEAR”, “MONTHLY_SEASONS”, “MONTHLY_AND_YEARLY_SEASONS”, “WEEKLY_SEASONS”, “WEEKLY_AND_MONTHLY_SEASONS”, “WEEKLY_MONTHLY_AND_YEARLY_SEASONS”, “WEEKLY_AND_YEARLY_SEASONS”, “YEARLY_SEASONS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • historical_data (list[oci.opsi.models.HistoricalDataItem]) – The value to assign to the historical_data property of this SummarizeHostInsightResourceForecastTrendAggregation.

  • projected_data (list[oci.opsi.models.ProjectedDataItem]) – The value to assign to the projected_data property of this SummarizeHostInsightResourceForecastTrendAggregation.

property high_utilization_threshold

[Required] Gets the high_utilization_threshold of this SummarizeHostInsightResourceForecastTrendAggregation. Percent value in which a resource metric is considered highly utilized.

Returns

The high_utilization_threshold of this SummarizeHostInsightResourceForecastTrendAggregation.

Return type

int

property historical_data

[Required] Gets the historical_data of this SummarizeHostInsightResourceForecastTrendAggregation. Time series data used for the forecast analysis.

Returns

The historical_data of this SummarizeHostInsightResourceForecastTrendAggregation.

Return type

list[oci.opsi.models.HistoricalDataItem]

property low_utilization_threshold

[Required] Gets the low_utilization_threshold of this SummarizeHostInsightResourceForecastTrendAggregation. Percent value in which a resource metric is considered lowly utilized.

Returns

The low_utilization_threshold of this SummarizeHostInsightResourceForecastTrendAggregation.

Return type

int

property pattern

[Required] Gets the pattern of this SummarizeHostInsightResourceForecastTrendAggregation. Time series patterns used in the forecasting.

Allowed values for this property are: “LINEAR”, “MONTHLY_SEASONS”, “MONTHLY_AND_YEARLY_SEASONS”, “WEEKLY_SEASONS”, “WEEKLY_AND_MONTHLY_SEASONS”, “WEEKLY_MONTHLY_AND_YEARLY_SEASONS”, “WEEKLY_AND_YEARLY_SEASONS”, “YEARLY_SEASONS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The pattern of this SummarizeHostInsightResourceForecastTrendAggregation.

Return type

str

property projected_data

[Required] Gets the projected_data of this SummarizeHostInsightResourceForecastTrendAggregation. Time series data result of the forecasting analysis.

Returns

The projected_data of this SummarizeHostInsightResourceForecastTrendAggregation.

Return type

list[oci.opsi.models.ProjectedDataItem]

property resource_metric

[Required] Gets the resource_metric of this SummarizeHostInsightResourceForecastTrendAggregation. Defines the type of resource metric (CPU, Physical Memory, Logical Memory)

Allowed values for this property are: “CPU”, “MEMORY”, “LOGICAL_MEMORY”, “STORAGE”, “NETWORK”, “GPU_UTILIZATION”, “GPU_MEMORY_USAGE”, “IO”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The resource_metric of this SummarizeHostInsightResourceForecastTrendAggregation.

Return type

str

property selected_forecast_algorithm

Gets the selected_forecast_algorithm of this SummarizeHostInsightResourceForecastTrendAggregation. Auto-ML algorithm leveraged for the forecast. Only applicable for Auto-ML forecast.

Returns

The selected_forecast_algorithm of this SummarizeHostInsightResourceForecastTrendAggregation.

Return type

str

property time_interval_end

[Required] Gets the time_interval_end of this SummarizeHostInsightResourceForecastTrendAggregation. The end timestamp that was passed into the request.

Returns

The time_interval_end of this SummarizeHostInsightResourceForecastTrendAggregation.

Return type

datetime

property time_interval_start

[Required] Gets the time_interval_start of this SummarizeHostInsightResourceForecastTrendAggregation. The start timestamp that was passed into the request.

Returns

The time_interval_start of this SummarizeHostInsightResourceForecastTrendAggregation.

Return type

datetime

property usage_unit

[Required] Gets the usage_unit of this SummarizeHostInsightResourceForecastTrendAggregation. Displays usage unit ( CORES, GB , PERCENT, MBPS)

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

Returns

The usage_unit of this SummarizeHostInsightResourceForecastTrendAggregation.

Return type

str