SummarizeHostInsightResourceStatisticsAggregationCollection

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

Bases: object

Returns list of hosts with resource statistics like usage, capacity, utilization, usage change percent and load.

Attributes:

RESOURCE_METRIC_CPU

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

RESOURCE_METRIC_GPU_MEMORY_USAGE

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

RESOURCE_METRIC_GPU_UTILIZATION

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

RESOURCE_METRIC_IO

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

RESOURCE_METRIC_LOGICAL_MEMORY

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

RESOURCE_METRIC_MEMORY

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

RESOURCE_METRIC_NETWORK

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

RESOURCE_METRIC_STORAGE

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

USAGE_UNIT_CORES

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

USAGE_UNIT_GB

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

USAGE_UNIT_IOPS

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

USAGE_UNIT_MBPS

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

USAGE_UNIT_PERCENT

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

high_utilization_threshold

[Required] Gets the high_utilization_threshold of this SummarizeHostInsightResourceStatisticsAggregationCollection.

items

[Required] Gets the items of this SummarizeHostInsightResourceStatisticsAggregationCollection.

low_utilization_threshold

[Required] Gets the low_utilization_threshold of this SummarizeHostInsightResourceStatisticsAggregationCollection.

resource_metric

[Required] Gets the resource_metric of this SummarizeHostInsightResourceStatisticsAggregationCollection.

time_interval_end

[Required] Gets the time_interval_end of this SummarizeHostInsightResourceStatisticsAggregationCollection.

time_interval_start

[Required] Gets the time_interval_start of this SummarizeHostInsightResourceStatisticsAggregationCollection.

usage_unit

[Required] Gets the usage_unit of this SummarizeHostInsightResourceStatisticsAggregationCollection.

Methods:

__init__(**kwargs)

Initializes a new SummarizeHostInsightResourceStatisticsAggregationCollection object with values from keyword arguments.

RESOURCE_METRIC_CPU = 'CPU'

A constant which can be used with the resource_metric property of a SummarizeHostInsightResourceStatisticsAggregationCollection. 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 SummarizeHostInsightResourceStatisticsAggregationCollection. 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 SummarizeHostInsightResourceStatisticsAggregationCollection. 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 SummarizeHostInsightResourceStatisticsAggregationCollection. 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 SummarizeHostInsightResourceStatisticsAggregationCollection. 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 SummarizeHostInsightResourceStatisticsAggregationCollection. This constant has a value of “MEMORY”

RESOURCE_METRIC_NETWORK = 'NETWORK'

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

RESOURCE_METRIC_STORAGE = 'STORAGE'

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

USAGE_UNIT_CORES = 'CORES'

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

USAGE_UNIT_GB = 'GB'

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

USAGE_UNIT_IOPS = 'IOPS'

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

USAGE_UNIT_MBPS = 'MBPS'

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

USAGE_UNIT_PERCENT = 'PERCENT'

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

__init__(**kwargs)

Initializes a new SummarizeHostInsightResourceStatisticsAggregationCollection 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 SummarizeHostInsightResourceStatisticsAggregationCollection.

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

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

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

  • resource_metric (str) – The value to assign to the resource_metric property of this SummarizeHostInsightResourceStatisticsAggregationCollection. 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 SummarizeHostInsightResourceStatisticsAggregationCollection. 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’.

  • items (list[oci.opsi.models.HostInsightResourceStatisticsAggregation]) – The value to assign to the items property of this SummarizeHostInsightResourceStatisticsAggregationCollection.

property high_utilization_threshold

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

Returns

The high_utilization_threshold of this SummarizeHostInsightResourceStatisticsAggregationCollection.

Return type

int

property items

[Required] Gets the items of this SummarizeHostInsightResourceStatisticsAggregationCollection. Collection of Resource Statistics items

Returns

The items of this SummarizeHostInsightResourceStatisticsAggregationCollection.

Return type

list[oci.opsi.models.HostInsightResourceStatisticsAggregation]

property low_utilization_threshold

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

Returns

The low_utilization_threshold of this SummarizeHostInsightResourceStatisticsAggregationCollection.

Return type

int

property resource_metric

[Required] Gets the resource_metric of this SummarizeHostInsightResourceStatisticsAggregationCollection. 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 SummarizeHostInsightResourceStatisticsAggregationCollection.

Return type

str

property time_interval_end

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

Returns

The time_interval_end of this SummarizeHostInsightResourceStatisticsAggregationCollection.

Return type

datetime

property time_interval_start

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

Returns

The time_interval_start of this SummarizeHostInsightResourceStatisticsAggregationCollection.

Return type

datetime

property usage_unit

[Required] Gets the usage_unit of this SummarizeHostInsightResourceStatisticsAggregationCollection. 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 SummarizeHostInsightResourceStatisticsAggregationCollection.

Return type

str