OccmDemandSignalDeliverySummary¶
- class oci.capacity_management.models.OccmDemandSignalDeliverySummary(**kwargs)¶
Bases:
objectA summary model containing information about the demand signal delivery resources.
Attributes:
A constant which can be used with the lifecycle_details property of a OccmDemandSignalDeliverySummary.
A constant which can be used with the lifecycle_details property of a OccmDemandSignalDeliverySummary.
A constant which can be used with the lifecycle_details property of a OccmDemandSignalDeliverySummary.
A constant which can be used with the lifecycle_state property of a OccmDemandSignalDeliverySummary.
A constant which can be used with the lifecycle_state property of a OccmDemandSignalDeliverySummary.
A constant which can be used with the lifecycle_state property of a OccmDemandSignalDeliverySummary.
A constant which can be used with the lifecycle_state property of a OccmDemandSignalDeliverySummary.
A constant which can be used with the lifecycle_state property of a OccmDemandSignalDeliverySummary.
A constant which can be used with the lifecycle_state property of a OccmDemandSignalDeliverySummary.
[Required] Gets the accepted_quantity of this OccmDemandSignalDeliverySummary.
[Required] Gets the compartment_id of this OccmDemandSignalDeliverySummary.
Gets the defined_tags of this OccmDemandSignalDeliverySummary.
[Required] Gets the demand_signal_id of this OccmDemandSignalDeliverySummary.
[Required] Gets the demand_signal_item_id of this OccmDemandSignalDeliverySummary.
Gets the freeform_tags of this OccmDemandSignalDeliverySummary.
[Required] Gets the id of this OccmDemandSignalDeliverySummary.
Gets the justification of this OccmDemandSignalDeliverySummary.
[Required] Gets the lifecycle_details of this OccmDemandSignalDeliverySummary.
[Required] Gets the lifecycle_state of this OccmDemandSignalDeliverySummary.
Gets the system_tags of this OccmDemandSignalDeliverySummary.
Gets the time_delivered of this OccmDemandSignalDeliverySummary.
Methods:
__init__(**kwargs)Initializes a new OccmDemandSignalDeliverySummary object with values from keyword arguments.
- LIFECYCLE_DETAILS_ACCEPTED = 'ACCEPTED'¶
A constant which can be used with the lifecycle_details property of a OccmDemandSignalDeliverySummary. This constant has a value of “ACCEPTED”
- LIFECYCLE_DETAILS_DECLINED = 'DECLINED'¶
A constant which can be used with the lifecycle_details property of a OccmDemandSignalDeliverySummary. This constant has a value of “DECLINED”
- LIFECYCLE_DETAILS_DELIVERED = 'DELIVERED'¶
A constant which can be used with the lifecycle_details property of a OccmDemandSignalDeliverySummary. This constant has a value of “DELIVERED”
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a OccmDemandSignalDeliverySummary. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a OccmDemandSignalDeliverySummary. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a OccmDemandSignalDeliverySummary. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a OccmDemandSignalDeliverySummary. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a OccmDemandSignalDeliverySummary. This constant has a value of “FAILED”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a OccmDemandSignalDeliverySummary. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new OccmDemandSignalDeliverySummary 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 OccmDemandSignalDeliverySummary.
compartment_id (str) – The value to assign to the compartment_id property of this OccmDemandSignalDeliverySummary.
demand_signal_id (str) – The value to assign to the demand_signal_id property of this OccmDemandSignalDeliverySummary.
demand_signal_item_id (str) – The value to assign to the demand_signal_item_id property of this OccmDemandSignalDeliverySummary.
accepted_quantity (int) – The value to assign to the accepted_quantity property of this OccmDemandSignalDeliverySummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this OccmDemandSignalDeliverySummary. 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’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this OccmDemandSignalDeliverySummary. Allowed values for this property are: “ACCEPTED”, “DECLINED”, “DELIVERED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
justification (str) – The value to assign to the justification property of this OccmDemandSignalDeliverySummary.
time_delivered (datetime) – The value to assign to the time_delivered property of this OccmDemandSignalDeliverySummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OccmDemandSignalDeliverySummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OccmDemandSignalDeliverySummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this OccmDemandSignalDeliverySummary.
- property accepted_quantity¶
[Required] Gets the accepted_quantity of this OccmDemandSignalDeliverySummary. The quantity of the resource that OCI will supply to the customer.
- Returns
The accepted_quantity of this OccmDemandSignalDeliverySummary.
- Return type
int
- property compartment_id¶
[Required] Gets the compartment_id of this OccmDemandSignalDeliverySummary. The OCID of the tenancy from which the demand signal delivery resource is created.
- Returns
The compartment_id of this OccmDemandSignalDeliverySummary.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this OccmDemandSignalDeliverySummary. 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 OccmDemandSignalDeliverySummary.
- Return type
dict(str, dict(str, object))
- property demand_signal_id¶
[Required] Gets the demand_signal_id of this OccmDemandSignalDeliverySummary. The OCID of the demand signal under which this delivery will be grouped.
- Returns
The demand_signal_id of this OccmDemandSignalDeliverySummary.
- Return type
str
- property demand_signal_item_id¶
[Required] Gets the demand_signal_item_id of this OccmDemandSignalDeliverySummary. The OCID of the demand signal item corresponding to which this delivery is made.
- Returns
The demand_signal_item_id of this OccmDemandSignalDeliverySummary.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this OccmDemandSignalDeliverySummary. 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 OccmDemandSignalDeliverySummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this OccmDemandSignalDeliverySummary. The OCID of this demand signal delivery resource.
- Returns
The id of this OccmDemandSignalDeliverySummary.
- Return type
str
- property justification¶
Gets the justification of this OccmDemandSignalDeliverySummary. This field could be used by OCI to communicate the reason for accepting or declining the request.
- Returns
The justification of this OccmDemandSignalDeliverySummary.
- Return type
str
- property lifecycle_details¶
[Required] Gets the lifecycle_details of this OccmDemandSignalDeliverySummary. The enum values corresponding to the various states associated with the delivery resource.
ACCEPTED -> OCI has accepted your resource request and will deliver the quantity as specified by acceptance quantity of this resource. DECLINED -> OCI has declined you resource request. DELIVERED -> OCI has delivered the accepted quantity to the customers.
Note: Under extreme rare scenarios the delivery state can toggle between ACCEPTED and DECLINED states
Allowed values for this property are: “ACCEPTED”, “DECLINED”, “DELIVERED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_details of this OccmDemandSignalDeliverySummary.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this OccmDemandSignalDeliverySummary. 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 OccmDemandSignalDeliverySummary.
- Return type
str
- property system_tags¶
Gets the system_tags of this OccmDemandSignalDeliverySummary. 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 OccmDemandSignalDeliverySummary.
- Return type
dict(str, dict(str, object))
- property time_delivered¶
Gets the time_delivered of this OccmDemandSignalDeliverySummary. The date on which the OCI delivered the resource to the customers.
- Returns
The time_delivered of this OccmDemandSignalDeliverySummary.
- Return type
datetime