ChargebackPlanSummary¶

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

Bases: object

Summary of a Ops Insights chargeback plan.

Attributes

`ENTITY_SOURCE_CHARGEBACK_COMPUTE`	A constant which can be used with the entity_source property of a ChargebackPlanSummary.
`ENTITY_SOURCE_CHARGEBACK_EXADATA`	A constant which can be used with the entity_source property of a ChargebackPlanSummary.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ChargebackPlanSummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a ChargebackPlanSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ChargebackPlanSummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a ChargebackPlanSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a ChargebackPlanSummary.
`LIFECYCLE_STATE_NEEDS_ATTENTION`	A constant which can be used with the lifecycle_state property of a ChargebackPlanSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a ChargebackPlanSummary.
`PLAN_CATEGORY_CUSTOM`	A constant which can be used with the plan_category property of a ChargebackPlanSummary.
`PLAN_CATEGORY_OOB`	A constant which can be used with the plan_category property of a ChargebackPlanSummary.
`compartment_id`	[Required] Gets the compartment_id of this ChargebackPlanSummary.
`defined_tags`	[Required] Gets the defined_tags of this ChargebackPlanSummary.
`entity_source`	[Required] Gets the entity_source of this ChargebackPlanSummary.
`freeform_tags`	[Required] Gets the freeform_tags of this ChargebackPlanSummary.
`id`	[Required] Gets the id of this ChargebackPlanSummary.
`is_customizable`	Gets the is_customizable of this ChargebackPlanSummary.
`lifecycle_details`	Gets the lifecycle_details of this ChargebackPlanSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ChargebackPlanSummary.
`plan_category`	Gets the plan_category of this ChargebackPlanSummary.
`plan_custom_items`	[Required] Gets the plan_custom_items of this ChargebackPlanSummary.
`plan_description`	Gets the plan_description of this ChargebackPlanSummary.
`plan_name`	[Required] Gets the plan_name of this ChargebackPlanSummary.
`plan_type`	[Required] Gets the plan_type of this ChargebackPlanSummary.
`system_tags`	Gets the system_tags of this ChargebackPlanSummary.
`time_created`	[Required] Gets the time_created of this ChargebackPlanSummary.
`time_updated`	[Required] Gets the time_updated of this ChargebackPlanSummary.

Methods

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

ENTITY_SOURCE_CHARGEBACK_COMPUTE = 'CHARGEBACK_COMPUTE'¶: A constant which can be used with the entity_source property of a ChargebackPlanSummary. This constant has a value of “CHARGEBACK_COMPUTE”

ENTITY_SOURCE_CHARGEBACK_EXADATA = 'CHARGEBACK_EXADATA'¶: A constant which can be used with the entity_source property of a ChargebackPlanSummary. This constant has a value of “CHARGEBACK_EXADATA”

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

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

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

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

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

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the lifecycle_state property of a ChargebackPlanSummary. This constant has a value of “NEEDS_ATTENTION”

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

PLAN_CATEGORY_CUSTOM = 'CUSTOM'¶: A constant which can be used with the plan_category property of a ChargebackPlanSummary. This constant has a value of “CUSTOM”

PLAN_CATEGORY_OOB = 'OOB'¶: A constant which can be used with the plan_category property of a ChargebackPlanSummary. This constant has a value of “OOB”

__init__(**kwargs)¶

Initializes a new ChargebackPlanSummary 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 ChargebackPlanSummary.
compartment_id (str) – The value to assign to the compartment_id property of this ChargebackPlanSummary.
plan_name (str) – The value to assign to the plan_name property of this ChargebackPlanSummary.
plan_description (str) – The value to assign to the plan_description property of this ChargebackPlanSummary.
plan_type (str) – The value to assign to the plan_type property of this ChargebackPlanSummary.
plan_category (str) – The value to assign to the plan_category property of this ChargebackPlanSummary. Allowed values for this property are: “OOB”, “CUSTOM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_customizable (bool) – The value to assign to the is_customizable property of this ChargebackPlanSummary.
entity_source (str) – The value to assign to the entity_source property of this ChargebackPlanSummary. Allowed values for this property are: “CHARGEBACK_EXADATA”, “CHARGEBACK_COMPUTE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this ChargebackPlanSummary.
time_updated (datetime) – The value to assign to the time_updated property of this ChargebackPlanSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ChargebackPlanSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ChargebackPlanSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ChargebackPlanSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ChargebackPlanSummary. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this ChargebackPlanSummary.
plan_custom_items (list[oci.opsi.models.CreatePlanCustomItemDetails]) – The value to assign to the plan_custom_items property of this ChargebackPlanSummary.

compartment_id¶

[Required] Gets the compartment_id of this ChargebackPlanSummary. The OCID of the compartment.

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

defined_tags¶

[Required] Gets the defined_tags of this ChargebackPlanSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

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

entity_source¶

[Required] Gets the entity_source of this ChargebackPlanSummary. Source of the chargeback plan.

Allowed values for this property are: “CHARGEBACK_EXADATA”, “CHARGEBACK_COMPUTE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The entity_source of this ChargebackPlanSummary.
Return type:	str

freeform_tags¶

[Required] Gets the freeform_tags of this ChargebackPlanSummary. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

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

id¶

[Required] Gets the id of this ChargebackPlanSummary. OCID of OPSI Chargeback plan resource.

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

is_customizable¶

Gets the is_customizable of this ChargebackPlanSummary. Indicates whether the chargeback plan can be customized.

Returns:	The is_customizable of this ChargebackPlanSummary.
Return type:	bool

lifecycle_details¶

Gets the lifecycle_details of this ChargebackPlanSummary. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns:	The lifecycle_details of this ChargebackPlanSummary.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this ChargebackPlanSummary. Chargeback Plan lifecycle states

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this ChargebackPlanSummary.
Return type:	str

plan_category¶

Gets the plan_category of this ChargebackPlanSummary. Chargeback Plan category of the chargeback entity. It can be OOB, or CUSTOM.

Allowed values for this property are: “OOB”, “CUSTOM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The plan_category of this ChargebackPlanSummary.
Return type:	str

plan_custom_items¶

[Required] Gets the plan_custom_items of this ChargebackPlanSummary. List of chargeback plan customizations.

Returns:	The plan_custom_items of this ChargebackPlanSummary.
Return type:	list[oci.opsi.models.CreatePlanCustomItemDetails]

plan_description¶

Gets the plan_description of this ChargebackPlanSummary. Description of OPSI Chargeback Plan.

Returns:	The plan_description of this ChargebackPlanSummary.
Return type:	str

plan_name¶

[Required] Gets the plan_name of this ChargebackPlanSummary. Name for the OPSI Chargeback plan.

Returns:	The plan_name of this ChargebackPlanSummary.
Return type:	str

plan_type¶

[Required] Gets the plan_type of this ChargebackPlanSummary. Chargeback Plan type of the chargeback entity. For an Exadata it can be WEIGHTED_ALLOCATION, EQUAL_ALLOCATION, UNUSED_ALLOCATION.

Returns:	The plan_type of this ChargebackPlanSummary.
Return type:	str

system_tags¶

Gets the system_tags of this ChargebackPlanSummary. System tags for this resource. Each key is predefined and scoped to a namespace. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

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

time_created¶

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

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

time_updated¶

[Required] Gets the time_updated of this ChargebackPlanSummary. The time chargeback plan was updated. An RFC3339 formatted datetime string

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