HistorySummary¶
- class oci.optimizer.models.HistorySummary(**kwargs)¶
Bases:
objectThe metadata associated with the recommendation history and its related resources.
Attributes:
A constant which can be used with the lifecycle_state property of a HistorySummary.
A constant which can be used with the lifecycle_state property of a HistorySummary.
A constant which can be used with the lifecycle_state property of a HistorySummary.
A constant which can be used with the lifecycle_state property of a HistorySummary.
A constant which can be used with the lifecycle_state property of a HistorySummary.
A constant which can be used with the lifecycle_state property of a HistorySummary.
A constant which can be used with the lifecycle_state property of a HistorySummary.
A constant which can be used with the lifecycle_state property of a HistorySummary.
A constant which can be used with the lifecycle_state property of a HistorySummary.
A constant which can be used with the status property of a HistorySummary.
A constant which can be used with the status property of a HistorySummary.
A constant which can be used with the status property of a HistorySummary.
A constant which can be used with the status property of a HistorySummary.
[Required] Gets the action of this HistorySummary.
[Required] Gets the category_id of this HistorySummary.
[Required] Gets the compartment_id of this HistorySummary.
[Required] Gets the compartment_name of this HistorySummary.
[Required] Gets the estimated_cost_saving of this HistorySummary.
Gets the extended_metadata of this HistorySummary.
[Required] Gets the id of this HistorySummary.
[Required] Gets the lifecycle_state of this HistorySummary.
Gets the metadata of this HistorySummary.
[Required] Gets the name of this HistorySummary.
[Required] Gets the recommendation_id of this HistorySummary.
[Required] Gets the recommendation_name of this HistorySummary.
[Required] Gets the resource_action_id of this HistorySummary.
[Required] Gets the resource_id of this HistorySummary.
[Required] Gets the resource_type of this HistorySummary.
[Required] Gets the status of this HistorySummary.
Gets the time_created of this HistorySummary.
Methods:
__init__(**kwargs)Initializes a new HistorySummary object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a HistorySummary. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_ATTACHING = 'ATTACHING'¶
A constant which can be used with the lifecycle_state property of a HistorySummary. This constant has a value of “ATTACHING”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a HistorySummary. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a HistorySummary. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a HistorySummary. This constant has a value of “DELETING”
- LIFECYCLE_STATE_DETACHING = 'DETACHING'¶
A constant which can be used with the lifecycle_state property of a HistorySummary. This constant has a value of “DETACHING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a HistorySummary. This constant has a value of “FAILED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a HistorySummary. This constant has a value of “INACTIVE”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a HistorySummary. This constant has a value of “UPDATING”
- STATUS_DISMISSED = 'DISMISSED'¶
A constant which can be used with the status property of a HistorySummary. This constant has a value of “DISMISSED”
- STATUS_IMPLEMENTED = 'IMPLEMENTED'¶
A constant which can be used with the status property of a HistorySummary. This constant has a value of “IMPLEMENTED”
- STATUS_PENDING = 'PENDING'¶
A constant which can be used with the status property of a HistorySummary. This constant has a value of “PENDING”
- STATUS_POSTPONED = 'POSTPONED'¶
A constant which can be used with the status property of a HistorySummary. This constant has a value of “POSTPONED”
- __init__(**kwargs)¶
Initializes a new HistorySummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
id (str) – The value to assign to the id property of this HistorySummary.
name (str) – The value to assign to the name property of this HistorySummary.
resource_type (str) – The value to assign to the resource_type property of this HistorySummary.
category_id (str) – The value to assign to the category_id property of this HistorySummary.
recommendation_id (str) – The value to assign to the recommendation_id property of this HistorySummary.
recommendation_name (str) – The value to assign to the recommendation_name property of this HistorySummary.
resource_id (str) – The value to assign to the resource_id property of this HistorySummary.
resource_action_id (str) – The value to assign to the resource_action_id property of this HistorySummary.
action (oci.optimizer.models.Action) – The value to assign to the action property of this HistorySummary.
compartment_id (str) – The value to assign to the compartment_id property of this HistorySummary.
compartment_name (str) – The value to assign to the compartment_name property of this HistorySummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this HistorySummary. Allowed values for this property are: “ACTIVE”, “FAILED”, “INACTIVE”, “ATTACHING”, “DETACHING”, “DELETING”, “DELETED”, “UPDATING”, “CREATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
estimated_cost_saving (float) – The value to assign to the estimated_cost_saving property of this HistorySummary.
status (str) – The value to assign to the status property of this HistorySummary. Allowed values for this property are: “PENDING”, “DISMISSED”, “POSTPONED”, “IMPLEMENTED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
metadata (dict(str, str)) – The value to assign to the metadata property of this HistorySummary.
extended_metadata (dict(str, object)) – The value to assign to the extended_metadata property of this HistorySummary.
time_created (datetime) – The value to assign to the time_created property of this HistorySummary.
- property action¶
[Required] Gets the action of this HistorySummary.
- Returns
The action of this HistorySummary.
- Return type
- property category_id¶
[Required] Gets the category_id of this HistorySummary. The unique OCID associated with the category.
- Returns
The category_id of this HistorySummary.
- Return type
str
- property compartment_id¶
[Required] Gets the compartment_id of this HistorySummary. The OCID of the compartment.
- Returns
The compartment_id of this HistorySummary.
- Return type
str
- property compartment_name¶
[Required] Gets the compartment_name of this HistorySummary. The name assigned to the compartment.
- Returns
The compartment_name of this HistorySummary.
- Return type
str
- property estimated_cost_saving¶
[Required] Gets the estimated_cost_saving of this HistorySummary. The estimated cost savings, in dollars, for the resource action.
- Returns
The estimated_cost_saving of this HistorySummary.
- Return type
float
- property extended_metadata¶
Gets the extended_metadata of this HistorySummary. Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the metadata object.
They are distinguished from metadata fields in that these can be nested JSON objects (whereas metadata fields are string/string maps only).
For example:
{“CurrentShape”: {“name”:”VM.Standard2.16”}, “RecommendedShape”: {“name”:”VM.Standard2.8”}}
- Returns
The extended_metadata of this HistorySummary.
- Return type
dict(str, object)
- property id¶
[Required] Gets the id of this HistorySummary. The unique OCID associated with the recommendation history.
- Returns
The id of this HistorySummary.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this HistorySummary. The recommendation history’s current state.
Allowed values for this property are: “ACTIVE”, “FAILED”, “INACTIVE”, “ATTACHING”, “DETACHING”, “DELETING”, “DELETED”, “UPDATING”, “CREATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this HistorySummary.
- Return type
str
- property metadata¶
Gets the metadata of this HistorySummary. Custom metadata key/value pairs for the resource action.
Metadata Example
- “metadata”{
“cpuRecommendedShape”: “VM.Standard1.1”, “computeMemoryUtilization”: “26.05734124418388”, “currentShape”: “VM.Standard1.2”, “instanceRecommendedShape”: “VM.Standard1.1”, “computeCpuUtilization”: “7.930035319720132”, “memoryRecommendedShape”: “None”
}
- Returns
The metadata of this HistorySummary.
- Return type
dict(str, str)
- property name¶
[Required] Gets the name of this HistorySummary. The name assigned to the resource.
- Returns
The name of this HistorySummary.
- Return type
str
- property recommendation_id¶
[Required] Gets the recommendation_id of this HistorySummary. The unique OCID associated with the recommendation.
- Returns
The recommendation_id of this HistorySummary.
- Return type
str
- property recommendation_name¶
[Required] Gets the recommendation_name of this HistorySummary. The name assigned to the recommendation.
- Returns
The recommendation_name of this HistorySummary.
- Return type
str
- property resource_action_id¶
[Required] Gets the resource_action_id of this HistorySummary. The unique OCID associated with the resource action.
- Returns
The resource_action_id of this HistorySummary.
- Return type
str
- property resource_id¶
[Required] Gets the resource_id of this HistorySummary. The unique OCID associated with the resource.
- Returns
The resource_id of this HistorySummary.
- Return type
str
- property resource_type¶
[Required] Gets the resource_type of this HistorySummary. The kind of resource.
- Returns
The resource_type of this HistorySummary.
- Return type
str
- property status¶
[Required] Gets the status of this HistorySummary. The current status of the resource action.
Allowed values for this property are: “PENDING”, “DISMISSED”, “POSTPONED”, “IMPLEMENTED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The status of this HistorySummary.
- Return type
str
- property time_created¶
Gets the time_created of this HistorySummary. The date and time the recommendation history was created, in the format defined by RFC3339.
- Returns
The time_created of this HistorySummary.
- Return type
datetime