ProfileSummary¶

class oci.optimizer.models.ProfileSummary(**kwargs)¶

Bases: object

The metadata associated with the profile summary.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ProfileSummary.
`LIFECYCLE_STATE_ATTACHING`	A constant which can be used with the lifecycle_state property of a ProfileSummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a ProfileSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ProfileSummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a ProfileSummary.
`LIFECYCLE_STATE_DETACHING`	A constant which can be used with the lifecycle_state property of a ProfileSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a ProfileSummary.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a ProfileSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a ProfileSummary.
`aggregation_interval_in_days`	Gets the aggregation_interval_in_days of this ProfileSummary.
`compartment_id`	[Required] Gets the compartment_id of this ProfileSummary.
`defined_tags`	Gets the defined_tags of this ProfileSummary.
`description`	[Required] Gets the description of this ProfileSummary.
`freeform_tags`	Gets the freeform_tags of this ProfileSummary.
`id`	[Required] Gets the id of this ProfileSummary.
`levels_configuration`	Gets the levels_configuration of this ProfileSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ProfileSummary.
`name`	[Required] Gets the name of this ProfileSummary.
`system_tags`	Gets the system_tags of this ProfileSummary.
`target_compartments`	Gets the target_compartments of this ProfileSummary.
`target_tags`	Gets the target_tags of this ProfileSummary.
`time_created`	[Required] Gets the time_created of this ProfileSummary.
`time_updated`	[Required] Gets the time_updated of this ProfileSummary.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a ProfileSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_ATTACHING = 'ATTACHING'¶: A constant which can be used with the lifecycle_state property of a ProfileSummary. This constant has a value of “ATTACHING”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a ProfileSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a ProfileSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a ProfileSummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_DETACHING = 'DETACHING'¶: A constant which can be used with the lifecycle_state property of a ProfileSummary. This constant has a value of “DETACHING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a ProfileSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a ProfileSummary. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a ProfileSummary. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new ProfileSummary 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 ProfileSummary.
compartment_id (str) – The value to assign to the compartment_id property of this ProfileSummary.
name (str) – The value to assign to the name property of this ProfileSummary.
description (str) – The value to assign to the description property of this ProfileSummary.
aggregation_interval_in_days (int) – The value to assign to the aggregation_interval_in_days property of this ProfileSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ProfileSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ProfileSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ProfileSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ProfileSummary. 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’.
levels_configuration (oci.optimizer.models.LevelsConfiguration) – The value to assign to the levels_configuration property of this ProfileSummary.
target_compartments (oci.optimizer.models.TargetCompartments) – The value to assign to the target_compartments property of this ProfileSummary.
target_tags (oci.optimizer.models.TargetTags) – The value to assign to the target_tags property of this ProfileSummary.
time_created (datetime) – The value to assign to the time_created property of this ProfileSummary.
time_updated (datetime) – The value to assign to the time_updated property of this ProfileSummary.

aggregation_interval_in_days¶

Gets the aggregation_interval_in_days of this ProfileSummary. The time period over which to collect data for the recommendations, measured in number of days.

Returns:	The aggregation_interval_in_days of this ProfileSummary.
Return type:	int

compartment_id¶

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

Returns:	The compartment_id of this ProfileSummary.
Return type:	str

defined_tags¶

Gets the defined_tags of this ProfileSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this ProfileSummary.
Return type:	dict(str, dict(str, object))

description¶

[Required] Gets the description of this ProfileSummary. Text describing the profile.

Returns:	The description of this ProfileSummary.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this ProfileSummary. Simple key-value pair applied without any predefined name, type, or namespace. For more information, see Resource Tags. Exists for cross-compatibility only.

Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this ProfileSummary.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this ProfileSummary. The unique OCID of the profile.

Returns:	The id of this ProfileSummary.
Return type:	str

levels_configuration¶

Gets the levels_configuration of this ProfileSummary.

Returns:	The levels_configuration of this ProfileSummary.
Return type:	oci.optimizer.models.LevelsConfiguration

lifecycle_state¶

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

name¶

[Required] Gets the name of this ProfileSummary. The name assigned to the profile.

Returns:	The name of this ProfileSummary.
Return type:	str

system_tags¶

Gets the system_tags of this ProfileSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: { “orcl-cloud”: { “free-tier-retained”: “true” } }

Returns:	The system_tags of this ProfileSummary.
Return type:	dict(str, dict(str, object))

target_compartments¶

Gets the target_compartments of this ProfileSummary.

Returns:	The target_compartments of this ProfileSummary.
Return type:	oci.optimizer.models.TargetCompartments

target_tags¶

Gets the target_tags of this ProfileSummary.

Returns:	The target_tags of this ProfileSummary.
Return type:	oci.optimizer.models.TargetTags

time_created¶

[Required] Gets the time_created of this ProfileSummary. The date and time the profile was created, in the format defined by RFC3339.

Returns:	The time_created of this ProfileSummary.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this ProfileSummary. The date and time the profile was last updated, in the format defined by RFC3339.

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