OccDemandSignal¶

class oci.demand_signal.models.OccDemandSignal(**kwargs)¶

Bases: object

An OccDemandSignal is a forecast created for different Resource Types.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a OccDemandSignal.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a OccDemandSignal.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a OccDemandSignal.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a OccDemandSignal.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a OccDemandSignal.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a OccDemandSignal.
`compartment_id`	[Required] Gets the compartment_id of this OccDemandSignal.
`defined_tags`	[Required] Gets the defined_tags of this OccDemandSignal.
`display_name`	[Required] Gets the display_name of this OccDemandSignal.
`freeform_tags`	[Required] Gets the freeform_tags of this OccDemandSignal.
`id`	[Required] Gets the id of this OccDemandSignal.
`is_active`	[Required] Gets the is_active of this OccDemandSignal.
`lifecycle_details`	Gets the lifecycle_details of this OccDemandSignal.
`lifecycle_state`	[Required] Gets the lifecycle_state of this OccDemandSignal.
`occ_demand_signals`	[Required] Gets the occ_demand_signals of this OccDemandSignal.
`system_tags`	Gets the system_tags of this OccDemandSignal.
`time_created`	[Required] Gets the time_created of this OccDemandSignal.
`time_updated`	Gets the time_updated of this OccDemandSignal.

Methods

__init__(**kwargs) Initializes a new OccDemandSignal object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a OccDemandSignal. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a OccDemandSignal. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a OccDemandSignal. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a OccDemandSignal. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a OccDemandSignal. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a OccDemandSignal. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new OccDemandSignal 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 OccDemandSignal.
compartment_id (str) – The value to assign to the compartment_id property of this OccDemandSignal.
display_name (str) – The value to assign to the display_name property of this OccDemandSignal.
occ_demand_signals (list[oci.demand_signal.models.OccDemandSignalData]) – The value to assign to the occ_demand_signals property of this OccDemandSignal.
is_active (bool) – The value to assign to the is_active property of this OccDemandSignal.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this OccDemandSignal. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘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 OccDemandSignal.
time_updated (datetime) – The value to assign to the time_updated property of this OccDemandSignal.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this OccDemandSignal.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OccDemandSignal.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OccDemandSignal.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this OccDemandSignal.

compartment_id¶

[Required] Gets the compartment_id of this OccDemandSignal. The OCID of the compartment.

Returns:	The compartment_id of this OccDemandSignal.
Return type:	str

defined_tags¶

[Required] Gets the defined_tags of this OccDemandSignal. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this OccDemandSignal.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this OccDemandSignal. A user-friendly name. Does not have to be unique, and it’s changeable.

Returns:	The display_name of this OccDemandSignal.
Return type:	str

freeform_tags¶

[Required] Gets the freeform_tags of this OccDemandSignal. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this OccDemandSignal.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this OccDemandSignal. The OCID of the OccDemandSignal.

Returns:	The id of this OccDemandSignal.
Return type:	str

is_active¶

[Required] Gets the is_active of this OccDemandSignal. Indicator of whether to share the data with Oracle.

Returns:	The is_active of this OccDemandSignal.
Return type:	bool

lifecycle_details¶

Gets the lifecycle_details of this OccDemandSignal. A message that describes the current state of the OccDemandSignal in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

Returns:	The lifecycle_details of this OccDemandSignal.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this OccDemandSignal. The current state of the OccDemandSignal.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this OccDemandSignal.
Return type:	str

occ_demand_signals¶

[Required] Gets the occ_demand_signals of this OccDemandSignal. The OccDemandSignal data.

Returns:	The occ_demand_signals of this OccDemandSignal.
Return type:	list[oci.demand_signal.models.OccDemandSignalData]

system_tags¶

Gets the system_tags of this OccDemandSignal. 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 OccDemandSignal.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this OccDemandSignal. The date and time the OccDemandSignal was created, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_created of this OccDemandSignal.
Return type:	datetime

time_updated¶

Gets the time_updated of this OccDemandSignal. The date and time the OccDemandSignal was updated, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_updated of this OccDemandSignal.
Return type:	datetime