ChargebackPlan¶
- class oci.opsi.models.ChargebackPlan(**kwargs)¶
Bases:
objectA chargeback plan that allows Ops Insights services to compute chargeback costs.
Attributes:
A constant which can be used with the entity_source property of a ChargebackPlan.
A constant which can be used with the entity_source property of a ChargebackPlan.
A constant which can be used with the lifecycle_state property of a ChargebackPlan.
A constant which can be used with the lifecycle_state property of a ChargebackPlan.
A constant which can be used with the lifecycle_state property of a ChargebackPlan.
A constant which can be used with the lifecycle_state property of a ChargebackPlan.
A constant which can be used with the lifecycle_state property of a ChargebackPlan.
A constant which can be used with the lifecycle_state property of a ChargebackPlan.
A constant which can be used with the lifecycle_state property of a ChargebackPlan.
A constant which can be used with the plan_category property of a ChargebackPlan.
A constant which can be used with the plan_category property of a ChargebackPlan.
[Required] Gets the compartment_id of this ChargebackPlan.
Gets the defined_tags of this ChargebackPlan.
Gets the entity_source of this ChargebackPlan.
Gets the freeform_tags of this ChargebackPlan.
[Required] Gets the id of this ChargebackPlan.
Gets the is_customizable of this ChargebackPlan.
Gets the lifecycle_details of this ChargebackPlan.
[Required] Gets the lifecycle_state of this ChargebackPlan.
Gets the plan_category of this ChargebackPlan.
Gets the plan_custom_items of this ChargebackPlan.
Gets the plan_description of this ChargebackPlan.
[Required] Gets the plan_name of this ChargebackPlan.
[Required] Gets the plan_type of this ChargebackPlan.
Gets the system_tags of this ChargebackPlan.
[Required] Gets the time_created of this ChargebackPlan.
Gets the time_updated of this ChargebackPlan.
Methods:
__init__(**kwargs)Initializes a new ChargebackPlan 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 ChargebackPlan. 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 ChargebackPlan. 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 ChargebackPlan. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a ChargebackPlan. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a ChargebackPlan. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a ChargebackPlan. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a ChargebackPlan. 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 ChargebackPlan. 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 ChargebackPlan. This constant has a value of “UPDATING”
- PLAN_CATEGORY_CUSTOM = 'CUSTOM'¶
A constant which can be used with the plan_category property of a ChargebackPlan. This constant has a value of “CUSTOM”
- PLAN_CATEGORY_OOB = 'OOB'¶
A constant which can be used with the plan_category property of a ChargebackPlan. This constant has a value of “OOB”
- __init__(**kwargs)¶
Initializes a new ChargebackPlan 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 ChargebackPlan.
compartment_id (str) – The value to assign to the compartment_id property of this ChargebackPlan.
plan_name (str) – The value to assign to the plan_name property of this ChargebackPlan.
plan_description (str) – The value to assign to the plan_description property of this ChargebackPlan.
plan_type (str) – The value to assign to the plan_type property of this ChargebackPlan.
plan_category (str) – The value to assign to the plan_category property of this ChargebackPlan. 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 ChargebackPlan.
entity_source (str) – The value to assign to the entity_source property of this ChargebackPlan. 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 ChargebackPlan.
time_updated (datetime) – The value to assign to the time_updated property of this ChargebackPlan.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ChargebackPlan. 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 ChargebackPlan.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ChargebackPlan.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ChargebackPlan.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ChargebackPlan.
plan_custom_items (list[oci.opsi.models.CreatePlanCustomItemDetails]) – The value to assign to the plan_custom_items property of this ChargebackPlan.
- property compartment_id¶
[Required] Gets the compartment_id of this ChargebackPlan. The OCID of the compartment.
- Returns
The compartment_id of this ChargebackPlan.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this ChargebackPlan. 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 ChargebackPlan.
- Return type
dict(str, dict(str, object))
- property entity_source¶
Gets the entity_source of this ChargebackPlan. 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 ChargebackPlan.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this ChargebackPlan. 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 ChargebackPlan.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this ChargebackPlan. OCID of OPSI Chargeback plan resource.
- Returns
The id of this ChargebackPlan.
- Return type
str
- property is_customizable¶
Gets the is_customizable of this ChargebackPlan. Indicates whether the chargeback plan can be customized.
- Returns
The is_customizable of this ChargebackPlan.
- Return type
bool
- property lifecycle_details¶
Gets the lifecycle_details of this ChargebackPlan. 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 ChargebackPlan.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this ChargebackPlan. 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 ChargebackPlan.
- Return type
str
- property plan_category¶
Gets the plan_category of this ChargebackPlan. 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 ChargebackPlan.
- Return type
str
- property plan_custom_items¶
Gets the plan_custom_items of this ChargebackPlan. List of chargeback plan customizations.
- Returns
The plan_custom_items of this ChargebackPlan.
- Return type
- property plan_description¶
Gets the plan_description of this ChargebackPlan. Description of OPSI Chargeback Plan.
- Returns
The plan_description of this ChargebackPlan.
- Return type
str
- property plan_name¶
[Required] Gets the plan_name of this ChargebackPlan. Name for the OPSI Chargeback plan.
- Returns
The plan_name of this ChargebackPlan.
- Return type
str
- property plan_type¶
[Required] Gets the plan_type of this ChargebackPlan. 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 ChargebackPlan.
- Return type
str
- property system_tags¶
Gets the system_tags of this ChargebackPlan. 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 ChargebackPlan.
- Return type
dict(str, dict(str, object))
- property time_created¶
[Required] Gets the time_created of this ChargebackPlan. The date and time the chargeback plan was created, in the format defined by RFC3339.
- Returns
The time_created of this ChargebackPlan.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this ChargebackPlan. The time chargeback plan was updated. An RFC3339 formatted datetime string
- Returns
The time_updated of this ChargebackPlan.
- Return type
datetime