SummarizeHostInsightResourceUsageAggregation¶

class oci.opsi.models.SummarizeHostInsightResourceUsageAggregation(**kwargs)¶

Bases: object

Resource usage summation for the current time period.

Attributes

`RESOURCE_METRIC_CPU`	A constant which can be used with the resource_metric property of a SummarizeHostInsightResourceUsageAggregation.
`RESOURCE_METRIC_GPU_MEMORY_USAGE`	A constant which can be used with the resource_metric property of a SummarizeHostInsightResourceUsageAggregation.
`RESOURCE_METRIC_GPU_UTILIZATION`	A constant which can be used with the resource_metric property of a SummarizeHostInsightResourceUsageAggregation.
`RESOURCE_METRIC_IO`	A constant which can be used with the resource_metric property of a SummarizeHostInsightResourceUsageAggregation.
`RESOURCE_METRIC_LOGICAL_MEMORY`	A constant which can be used with the resource_metric property of a SummarizeHostInsightResourceUsageAggregation.
`RESOURCE_METRIC_MEMORY`	A constant which can be used with the resource_metric property of a SummarizeHostInsightResourceUsageAggregation.
`RESOURCE_METRIC_NETWORK`	A constant which can be used with the resource_metric property of a SummarizeHostInsightResourceUsageAggregation.
`RESOURCE_METRIC_STORAGE`	A constant which can be used with the resource_metric property of a SummarizeHostInsightResourceUsageAggregation.
`USAGE_UNIT_CORES`	A constant which can be used with the usage_unit property of a SummarizeHostInsightResourceUsageAggregation.
`USAGE_UNIT_GB`	A constant which can be used with the usage_unit property of a SummarizeHostInsightResourceUsageAggregation.
`USAGE_UNIT_IOPS`	A constant which can be used with the usage_unit property of a SummarizeHostInsightResourceUsageAggregation.
`USAGE_UNIT_MBPS`	A constant which can be used with the usage_unit property of a SummarizeHostInsightResourceUsageAggregation.
`USAGE_UNIT_PERCENT`	A constant which can be used with the usage_unit property of a SummarizeHostInsightResourceUsageAggregation.
`capacity`	[Required] Gets the capacity of this SummarizeHostInsightResourceUsageAggregation.
`resource_metric`	[Required] Gets the resource_metric of this SummarizeHostInsightResourceUsageAggregation.
`time_interval_end`	[Required] Gets the time_interval_end of this SummarizeHostInsightResourceUsageAggregation.
`time_interval_start`	[Required] Gets the time_interval_start of this SummarizeHostInsightResourceUsageAggregation.
`usage`	[Required] Gets the usage of this SummarizeHostInsightResourceUsageAggregation.
`usage_change_percent`	[Required] Gets the usage_change_percent of this SummarizeHostInsightResourceUsageAggregation.
`usage_unit`	[Required] Gets the usage_unit of this SummarizeHostInsightResourceUsageAggregation.

Methods

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

RESOURCE_METRIC_CPU = 'CPU'¶: A constant which can be used with the resource_metric property of a SummarizeHostInsightResourceUsageAggregation. 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 SummarizeHostInsightResourceUsageAggregation. 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 SummarizeHostInsightResourceUsageAggregation. 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 SummarizeHostInsightResourceUsageAggregation. 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 SummarizeHostInsightResourceUsageAggregation. 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 SummarizeHostInsightResourceUsageAggregation. This constant has a value of “MEMORY”

RESOURCE_METRIC_NETWORK = 'NETWORK'¶: A constant which can be used with the resource_metric property of a SummarizeHostInsightResourceUsageAggregation. This constant has a value of “NETWORK”

RESOURCE_METRIC_STORAGE = 'STORAGE'¶: A constant which can be used with the resource_metric property of a SummarizeHostInsightResourceUsageAggregation. This constant has a value of “STORAGE”

USAGE_UNIT_CORES = 'CORES'¶: A constant which can be used with the usage_unit property of a SummarizeHostInsightResourceUsageAggregation. This constant has a value of “CORES”

USAGE_UNIT_GB = 'GB'¶: A constant which can be used with the usage_unit property of a SummarizeHostInsightResourceUsageAggregation. This constant has a value of “GB”

USAGE_UNIT_IOPS = 'IOPS'¶: A constant which can be used with the usage_unit property of a SummarizeHostInsightResourceUsageAggregation. This constant has a value of “IOPS”

USAGE_UNIT_MBPS = 'MBPS'¶: A constant which can be used with the usage_unit property of a SummarizeHostInsightResourceUsageAggregation. This constant has a value of “MBPS”

USAGE_UNIT_PERCENT = 'PERCENT'¶: A constant which can be used with the usage_unit property of a SummarizeHostInsightResourceUsageAggregation. This constant has a value of “PERCENT”

__init__(**kwargs)¶

Initializes a new SummarizeHostInsightResourceUsageAggregation 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 SummarizeHostInsightResourceUsageAggregation.
time_interval_end (datetime) – The value to assign to the time_interval_end property of this SummarizeHostInsightResourceUsageAggregation.
resource_metric (str) – The value to assign to the resource_metric property of this SummarizeHostInsightResourceUsageAggregation. 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 SummarizeHostInsightResourceUsageAggregation. 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’.
usage (float) – The value to assign to the usage property of this SummarizeHostInsightResourceUsageAggregation.
capacity (float) – The value to assign to the capacity property of this SummarizeHostInsightResourceUsageAggregation.
usage_change_percent (float) – The value to assign to the usage_change_percent property of this SummarizeHostInsightResourceUsageAggregation.

capacity¶

[Required] Gets the capacity of this SummarizeHostInsightResourceUsageAggregation. The maximum allocated amount of the resource metric type (CPU, STORAGE) for a set of databases.

Returns:	The capacity of this SummarizeHostInsightResourceUsageAggregation.
Return type:	float

resource_metric¶

[Required] Gets the resource_metric of this SummarizeHostInsightResourceUsageAggregation. 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 SummarizeHostInsightResourceUsageAggregation.
Return type:	str

time_interval_end¶

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

Returns:	The time_interval_end of this SummarizeHostInsightResourceUsageAggregation.
Return type:	datetime

time_interval_start¶

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

Returns:	The time_interval_start of this SummarizeHostInsightResourceUsageAggregation.
Return type:	datetime

usage¶

[Required] Gets the usage of this SummarizeHostInsightResourceUsageAggregation. Total amount used of the resource metric type (CPU, STORAGE).

Returns:	The usage of this SummarizeHostInsightResourceUsageAggregation.
Return type:	float

usage_change_percent¶

[Required] Gets the usage_change_percent of this SummarizeHostInsightResourceUsageAggregation. Percentage change in resource usage during the current period calculated using linear regression functions

Returns:	The usage_change_percent of this SummarizeHostInsightResourceUsageAggregation.
Return type:	float

usage_unit¶

[Required] Gets the usage_unit of this SummarizeHostInsightResourceUsageAggregation. 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 SummarizeHostInsightResourceUsageAggregation.
Return type:	str