OccmDemandSignal¶
- class oci.capacity_management.models.OccmDemandSignal(**kwargs)¶
Bases:
objectAn occm demand signal is a resource that communicates the forecasting needs of a customer to OCI in advance.
Attributes:
A constant which can be used with the lifecycle_details property of a OccmDemandSignal.
A constant which can be used with the lifecycle_details property of a OccmDemandSignal.
A constant which can be used with the lifecycle_details property of a OccmDemandSignal.
A constant which can be used with the lifecycle_details property of a OccmDemandSignal.
A constant which can be used with the lifecycle_details property of a OccmDemandSignal.
A constant which can be used with the lifecycle_details property of a OccmDemandSignal.
A constant which can be used with the lifecycle_state property of a OccmDemandSignal.
A constant which can be used with the lifecycle_state property of a OccmDemandSignal.
A constant which can be used with the lifecycle_state property of a OccmDemandSignal.
A constant which can be used with the lifecycle_state property of a OccmDemandSignal.
A constant which can be used with the lifecycle_state property of a OccmDemandSignal.
A constant which can be used with the lifecycle_state property of a OccmDemandSignal.
[Required] Gets the compartment_id of this OccmDemandSignal.
Gets the defined_tags of this OccmDemandSignal.
Gets the description of this OccmDemandSignal.
[Required] Gets the display_name of this OccmDemandSignal.
Gets the freeform_tags of this OccmDemandSignal.
[Required] Gets the id of this OccmDemandSignal.
[Required] Gets the lifecycle_details of this OccmDemandSignal.
[Required] Gets the lifecycle_state of this OccmDemandSignal.
Gets the system_tags of this OccmDemandSignal.
[Required] Gets the time_created of this OccmDemandSignal.
[Required] Gets the time_updated of this OccmDemandSignal.
Methods:
__init__(**kwargs)Initializes a new OccmDemandSignal object with values from keyword arguments.
- LIFECYCLE_DETAILS_COMPLETED = 'COMPLETED'¶
A constant which can be used with the lifecycle_details property of a OccmDemandSignal. This constant has a value of “COMPLETED”
- LIFECYCLE_DETAILS_CREATED = 'CREATED'¶
A constant which can be used with the lifecycle_details property of a OccmDemandSignal. This constant has a value of “CREATED”
- LIFECYCLE_DETAILS_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_details property of a OccmDemandSignal. This constant has a value of “DELETED”
- LIFECYCLE_DETAILS_IN_PROGRESS = 'IN_PROGRESS'¶
A constant which can be used with the lifecycle_details property of a OccmDemandSignal. This constant has a value of “IN_PROGRESS”
- LIFECYCLE_DETAILS_REJECTED = 'REJECTED'¶
A constant which can be used with the lifecycle_details property of a OccmDemandSignal. This constant has a value of “REJECTED”
- LIFECYCLE_DETAILS_SUBMITTED = 'SUBMITTED'¶
A constant which can be used with the lifecycle_details property of a OccmDemandSignal. This constant has a value of “SUBMITTED”
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a OccmDemandSignal. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a OccmDemandSignal. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a OccmDemandSignal. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a OccmDemandSignal. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a OccmDemandSignal. This constant has a value of “FAILED”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a OccmDemandSignal. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new OccmDemandSignal 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 OccmDemandSignal.
compartment_id (str) – The value to assign to the compartment_id property of this OccmDemandSignal.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this OccmDemandSignal. Allowed values for this property are: “CREATED”, “SUBMITTED”, “DELETED”, “IN_PROGRESS”, “REJECTED”, “COMPLETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
display_name (str) – The value to assign to the display_name property of this OccmDemandSignal.
description (str) – The value to assign to the description property of this OccmDemandSignal.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this OccmDemandSignal. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETED”, “DELETING”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OccmDemandSignal.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OccmDemandSignal.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this OccmDemandSignal.
time_created (datetime) – The value to assign to the time_created property of this OccmDemandSignal.
time_updated (datetime) – The value to assign to the time_updated property of this OccmDemandSignal.
- property compartment_id¶
[Required] Gets the compartment_id of this OccmDemandSignal. The OCID of the tenancy from which the request to create the demand signal was made.
- Returns
The compartment_id of this OccmDemandSignal.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this OccmDemandSignal. 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 OccmDemandSignal.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this OccmDemandSignal. Meaningful text about the demand signal.
- Returns
The description of this OccmDemandSignal.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this OccmDemandSignal. The display name of the demand signal.
- Returns
The display_name of this OccmDemandSignal.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this OccmDemandSignal. 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 OccmDemandSignal.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this OccmDemandSignal. The OCID of the demand signal.
- Returns
The id of this OccmDemandSignal.
- Return type
str
- property lifecycle_details¶
[Required] Gets the lifecycle_details of this OccmDemandSignal. 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. CANCELLED -> OCI can transition the demand signal to this state. COMPLETED -> OCI will transition the demand signal to COMPLETED state once the quantities which OCI committed to deliver to you has been delivered.
Allowed values for this property are: “CREATED”, “SUBMITTED”, “DELETED”, “IN_PROGRESS”, “REJECTED”, “COMPLETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_details of this OccmDemandSignal.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this OccmDemandSignal. The current lifecycle state of the resource.
Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETED”, “DELETING”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this OccmDemandSignal.
- Return type
str
- property system_tags¶
Gets the system_tags of this OccmDemandSignal. 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 OccmDemandSignal.
- Return type
dict(str, dict(str, object))
- property time_created¶
[Required] Gets the time_created of this OccmDemandSignal. The time when the demand signal was created.
- Returns
The time_created of this OccmDemandSignal.
- Return type
datetime
- property time_updated¶
[Required] Gets the time_updated of this OccmDemandSignal. The time when the demand signal was last updated.
- Returns
The time_updated of this OccmDemandSignal.
- Return type
datetime