CategorySummary

class oci.optimizer.models.CategorySummary(**kwargs)

Bases: object

The metadata associated with the category summary.

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a CategorySummary.
LIFECYCLE_STATE_ATTACHING A constant which can be used with the lifecycle_state property of a CategorySummary.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a CategorySummary.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a CategorySummary.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a CategorySummary.
LIFECYCLE_STATE_DETACHING A constant which can be used with the lifecycle_state property of a CategorySummary.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a CategorySummary.
LIFECYCLE_STATE_INACTIVE A constant which can be used with the lifecycle_state property of a CategorySummary.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a CategorySummary.
compartment_id [Required] Gets the compartment_id of this CategorySummary.
description [Required] Gets the description of this CategorySummary.
estimated_cost_saving [Required] Gets the estimated_cost_saving of this CategorySummary.
id [Required] Gets the id of this CategorySummary.
lifecycle_state [Required] Gets the lifecycle_state of this CategorySummary.
name [Required] Gets the name of this CategorySummary.
recommendation_counts [Required] Gets the recommendation_counts of this CategorySummary.
resource_counts [Required] Gets the resource_counts of this CategorySummary.
time_created [Required] Gets the time_created of this CategorySummary.
time_updated [Required] Gets the time_updated of this CategorySummary.

Methods

__init__(**kwargs) Initializes a new CategorySummary object with values from keyword arguments.
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a CategorySummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_ATTACHING = 'ATTACHING'

A constant which can be used with the lifecycle_state property of a CategorySummary. This constant has a value of “ATTACHING”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a CategorySummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a CategorySummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a CategorySummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_DETACHING = 'DETACHING'

A constant which can be used with the lifecycle_state property of a CategorySummary. This constant has a value of “DETACHING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a CategorySummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a CategorySummary. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a CategorySummary. This constant has a value of “UPDATING”

__init__(**kwargs)

Initializes a new CategorySummary 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 CategorySummary.
  • compartment_id (str) – The value to assign to the compartment_id property of this CategorySummary.
  • name (str) – The value to assign to the name property of this CategorySummary.
  • description (str) – The value to assign to the description property of this CategorySummary.
  • recommendation_counts (list[oci.optimizer.models.RecommendationCount]) – The value to assign to the recommendation_counts property of this CategorySummary.
  • resource_counts (list[oci.optimizer.models.ResourceCount]) – The value to assign to the resource_counts property of this CategorySummary.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this CategorySummary. 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 CategorySummary.
  • time_created (datetime) – The value to assign to the time_created property of this CategorySummary.
  • time_updated (datetime) – The value to assign to the time_updated property of this CategorySummary.
compartment_id

[Required] Gets the compartment_id of this CategorySummary. The OCID of the tenancy. The tenancy is the root compartment.

Returns:The compartment_id of this CategorySummary.
Return type:str
description

[Required] Gets the description of this CategorySummary. Text describing the category. Avoid entering confidential information.

Returns:The description of this CategorySummary.
Return type:str
estimated_cost_saving

[Required] Gets the estimated_cost_saving of this CategorySummary. The estimated cost savings, in dollars, for the category.

Returns:The estimated_cost_saving of this CategorySummary.
Return type:float
id

[Required] Gets the id of this CategorySummary. The unique OCID of the category.

Returns:The id of this CategorySummary.
Return type:str
lifecycle_state

[Required] Gets the lifecycle_state of this CategorySummary. The category’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 CategorySummary.
Return type:str
name

[Required] Gets the name of this CategorySummary. The name assigned to the category. Avoid entering confidential information.

Returns:The name of this CategorySummary.
Return type:str
recommendation_counts

[Required] Gets the recommendation_counts of this CategorySummary. An array of RecommendationCount objects grouped by the level of importance assigned to each recommendation.

Returns:The recommendation_counts of this CategorySummary.
Return type:list[oci.optimizer.models.RecommendationCount]
resource_counts

[Required] Gets the resource_counts of this CategorySummary. An array of ResourceCount objects grouped by the status of each recommendation.

Returns:The resource_counts of this CategorySummary.
Return type:list[oci.optimizer.models.ResourceCount]
time_created

[Required] Gets the time_created of this CategorySummary. The date and time the category details were created, in the format defined by RFC3339.

Returns:The time_created of this CategorySummary.
Return type:datetime
time_updated

[Required] Gets the time_updated of this CategorySummary. The date and time the category details were last updated, in the format defined by RFC3339.

Returns:The time_updated of this CategorySummary.
Return type:datetime