OccmDemandSignalSummary

class oci.capacity_management.models.OccmDemandSignalSummary(**kwargs)

Bases: object

A summary model for the occm demand signal.

Methods:

__init__(**kwargs)

Initializes a new OccmDemandSignalSummary object with values from keyword arguments.

Attributes:

compartment_id

[Required] Gets the compartment_id of this OccmDemandSignalSummary.

defined_tags

Gets the defined_tags of this OccmDemandSignalSummary.

description

Gets the description of this OccmDemandSignalSummary.

display_name

[Required] Gets the display_name of this OccmDemandSignalSummary.

freeform_tags

Gets the freeform_tags of this OccmDemandSignalSummary.

id

[Required] Gets the id of this OccmDemandSignalSummary.

lifecycle_details

[Required] Gets the lifecycle_details of this OccmDemandSignalSummary.

lifecycle_state

[Required] Gets the lifecycle_state of this OccmDemandSignalSummary.

system_tags

Gets the system_tags of this OccmDemandSignalSummary.

time_created

[Required] Gets the time_created of this OccmDemandSignalSummary.

time_updated

[Required] Gets the time_updated of this OccmDemandSignalSummary.

__init__(**kwargs)

Initializes a new OccmDemandSignalSummary 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 OccmDemandSignalSummary.

  • compartment_id (str) – The value to assign to the compartment_id property of this OccmDemandSignalSummary.

  • display_name (str) – The value to assign to the display_name property of this OccmDemandSignalSummary.

  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this OccmDemandSignalSummary.

  • description (str) – The value to assign to the description property of this OccmDemandSignalSummary.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this OccmDemandSignalSummary.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OccmDemandSignalSummary.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OccmDemandSignalSummary.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this OccmDemandSignalSummary.

  • time_created (datetime) – The value to assign to the time_created property of this OccmDemandSignalSummary.

  • time_updated (datetime) – The value to assign to the time_updated property of this OccmDemandSignalSummary.

property compartment_id

[Required] Gets the compartment_id of this OccmDemandSignalSummary. The OCID of the tenancy from which the request to create the demand signal was made.

Returns

The compartment_id of this OccmDemandSignalSummary.

Return type

str

property defined_tags

Gets the defined_tags of this OccmDemandSignalSummary. 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 OccmDemandSignalSummary.

Return type

dict(str, dict(str, object))

property description

Gets the description of this OccmDemandSignalSummary. A short description about the demand signal.

Returns

The description of this OccmDemandSignalSummary.

Return type

str

property display_name

[Required] Gets the display_name of this OccmDemandSignalSummary. The display name of the demand signal.

Returns

The display_name of this OccmDemandSignalSummary.

Return type

str

property freeform_tags

Gets the freeform_tags of this OccmDemandSignalSummary. 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 OccmDemandSignalSummary.

Return type

dict(str, str)

property id

[Required] Gets the id of this OccmDemandSignalSummary. The OCID of the demand signal.

Returns

The id of this OccmDemandSignalSummary.

Return type

str

property lifecycle_details

[Required] Gets the lifecycle_details of this OccmDemandSignalSummary. 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 OccmDemandSignalSummary.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this OccmDemandSignalSummary. The current lifecycle state of the demand signal.

Returns

The lifecycle_state of this OccmDemandSignalSummary.

Return type

str

property system_tags

Gets the system_tags of this OccmDemandSignalSummary. 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 OccmDemandSignalSummary.

Return type

dict(str, dict(str, object))

property time_created

[Required] Gets the time_created of this OccmDemandSignalSummary. The time when the demand signal was created.

Returns

The time_created of this OccmDemandSignalSummary.

Return type

datetime

property time_updated

[Required] Gets the time_updated of this OccmDemandSignalSummary. The time when the demand signal was last updated.

Returns

The time_updated of this OccmDemandSignalSummary.

Return type

datetime