InternalOccmDemandSignalSummary¶
- class oci.capacity_management.models.InternalOccmDemandSignalSummary(**kwargs)¶
Bases:
objectAn internal summary model for occm demand signal.
Methods:
__init__(**kwargs)Initializes a new InternalOccmDemandSignalSummary object with values from keyword arguments.
Attributes:
[Required] Gets the compartment_id of this InternalOccmDemandSignalSummary.
Gets the defined_tags of this InternalOccmDemandSignalSummary.
Gets the description of this InternalOccmDemandSignalSummary.
[Required] Gets the display_name of this InternalOccmDemandSignalSummary.
Gets the freeform_tags of this InternalOccmDemandSignalSummary.
[Required] Gets the id of this InternalOccmDemandSignalSummary.
[Required] Gets the lifecycle_details of this InternalOccmDemandSignalSummary.
[Required] Gets the lifecycle_state of this InternalOccmDemandSignalSummary.
[Required] Gets the occ_customer_group_id of this InternalOccmDemandSignalSummary.
Gets the system_tags of this InternalOccmDemandSignalSummary.
[Required] Gets the time_created of this InternalOccmDemandSignalSummary.
[Required] Gets the time_updated of this InternalOccmDemandSignalSummary.
- __init__(**kwargs)¶
Initializes a new InternalOccmDemandSignalSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
occ_customer_group_id (str) – The value to assign to the occ_customer_group_id property of this InternalOccmDemandSignalSummary.
id (str) – The value to assign to the id property of this InternalOccmDemandSignalSummary.
compartment_id (str) – The value to assign to the compartment_id property of this InternalOccmDemandSignalSummary.
display_name (str) – The value to assign to the display_name property of this InternalOccmDemandSignalSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this InternalOccmDemandSignalSummary.
description (str) – The value to assign to the description property of this InternalOccmDemandSignalSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this InternalOccmDemandSignalSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this InternalOccmDemandSignalSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this InternalOccmDemandSignalSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this InternalOccmDemandSignalSummary.
time_created (datetime) – The value to assign to the time_created property of this InternalOccmDemandSignalSummary.
time_updated (datetime) – The value to assign to the time_updated property of this InternalOccmDemandSignalSummary.
- property compartment_id¶
[Required] Gets the compartment_id of this InternalOccmDemandSignalSummary. The OCID of the tenancy from which the request to create the demand signal was made.
- Returns
The compartment_id of this InternalOccmDemandSignalSummary.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this InternalOccmDemandSignalSummary. 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 InternalOccmDemandSignalSummary.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this InternalOccmDemandSignalSummary. A short description about the demand signal.
- Returns
The description of this InternalOccmDemandSignalSummary.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this InternalOccmDemandSignalSummary. The display name of the demand signal.
- Returns
The display_name of this InternalOccmDemandSignalSummary.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this InternalOccmDemandSignalSummary. 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 InternalOccmDemandSignalSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this InternalOccmDemandSignalSummary. The OCID of the demand signal.
- Returns
The id of this InternalOccmDemandSignalSummary.
- Return type
str
- property lifecycle_details¶
[Required] Gets the lifecycle_details of this InternalOccmDemandSignalSummary. The different states associated with a demand signal.
CREATED -> A demand signal is by default created in this state. SUBMITTED -> Once you have reviewed the details of the demand signal, you can transition it to SUBMITTED state so that OCI can start working on it. DELETED -> You can delete a demand signal as long as it is in either CREATED or SUBMITTED state. IN_PROGRESS -> Once OCI starts working on a given demand signal. They transition it to IN_PROGRESS. REJECTED -> OCI can transition the demand signal to this state if all the demand signal items of that demand signal are declined. COMPLETED -> OCI will transition the demand signal to COMPLETED state once the quantities which OCI committed to deliver to you has been delivered.
- Returns
The lifecycle_details of this InternalOccmDemandSignalSummary.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this InternalOccmDemandSignalSummary. The current lifecycle state of the demand signal.
- Returns
The lifecycle_state of this InternalOccmDemandSignalSummary.
- Return type
str
- property occ_customer_group_id¶
[Required] Gets the occ_customer_group_id of this InternalOccmDemandSignalSummary. The OCID of the customer group in which the demand signal is created.
- Returns
The occ_customer_group_id of this InternalOccmDemandSignalSummary.
- Return type
str
- property system_tags¶
Gets the system_tags of this InternalOccmDemandSignalSummary. 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 InternalOccmDemandSignalSummary.
- Return type
dict(str, dict(str, object))
- property time_created¶
[Required] Gets the time_created of this InternalOccmDemandSignalSummary. The time when the demand signal was created.
- Returns
The time_created of this InternalOccmDemandSignalSummary.
- Return type
datetime
- property time_updated¶
[Required] Gets the time_updated of this InternalOccmDemandSignalSummary. The time when the demand signal was last updated.
- Returns
The time_updated of this InternalOccmDemandSignalSummary.
- Return type
datetime