OccmDemandSignalItem¶

class oci.capacity_management.models.OccmDemandSignalItem(**kwargs)¶

Bases: object

An occm demand signal item is a resource that is used to communicate the forecasting need for a particular resource with OCI. It’s a sub-resource and need to be grouped inside a demand signal.

Attributes

`DEMAND_SIGNAL_NAMESPACE_COMPUTE`	A constant which can be used with the demand_signal_namespace property of a OccmDemandSignalItem.
`DEMAND_SIGNAL_NAMESPACE_GPU`	A constant which can be used with the demand_signal_namespace property of a OccmDemandSignalItem.
`DEMAND_SIGNAL_NAMESPACE_NETWORK`	A constant which can be used with the demand_signal_namespace property of a OccmDemandSignalItem.
`DEMAND_SIGNAL_NAMESPACE_STORAGE`	A constant which can be used with the demand_signal_namespace property of a OccmDemandSignalItem.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a OccmDemandSignalItem.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a OccmDemandSignalItem.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a OccmDemandSignalItem.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a OccmDemandSignalItem.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a OccmDemandSignalItem.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a OccmDemandSignalItem.
`REQUEST_TYPE_DEMAND`	A constant which can be used with the request_type property of a OccmDemandSignalItem.
`availability_domain`	Gets the availability_domain of this OccmDemandSignalItem.
`compartment_id`	[Required] Gets the compartment_id of this OccmDemandSignalItem.
`defined_tags`	Gets the defined_tags of this OccmDemandSignalItem.
`demand_quantity`	[Required] Gets the demand_quantity of this OccmDemandSignalItem.
`demand_signal_catalog_resource_id`	[Required] Gets the demand_signal_catalog_resource_id of this OccmDemandSignalItem.
`demand_signal_id`	[Required] Gets the demand_signal_id of this OccmDemandSignalItem.
`demand_signal_namespace`	[Required] Gets the demand_signal_namespace of this OccmDemandSignalItem.
`freeform_tags`	Gets the freeform_tags of this OccmDemandSignalItem.
`id`	[Required] Gets the id of this OccmDemandSignalItem.
`lifecycle_state`	[Required] Gets the lifecycle_state of this OccmDemandSignalItem.
`notes`	Gets the notes of this OccmDemandSignalItem.
`region`	[Required] Gets the region of this OccmDemandSignalItem.
`request_type`	[Required] Gets the request_type of this OccmDemandSignalItem.
`resource_name`	[Required] Gets the resource_name of this OccmDemandSignalItem.
`resource_properties`	[Required] Gets the resource_properties of this OccmDemandSignalItem.
`system_tags`	Gets the system_tags of this OccmDemandSignalItem.
`target_compartment_id`	Gets the target_compartment_id of this OccmDemandSignalItem.
`time_needed_before`	[Required] Gets the time_needed_before of this OccmDemandSignalItem.

Methods

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

DEMAND_SIGNAL_NAMESPACE_COMPUTE = 'COMPUTE'¶: A constant which can be used with the demand_signal_namespace property of a OccmDemandSignalItem. This constant has a value of “COMPUTE”

DEMAND_SIGNAL_NAMESPACE_GPU = 'GPU'¶: A constant which can be used with the demand_signal_namespace property of a OccmDemandSignalItem. This constant has a value of “GPU”

DEMAND_SIGNAL_NAMESPACE_NETWORK = 'NETWORK'¶: A constant which can be used with the demand_signal_namespace property of a OccmDemandSignalItem. This constant has a value of “NETWORK”

DEMAND_SIGNAL_NAMESPACE_STORAGE = 'STORAGE'¶: A constant which can be used with the demand_signal_namespace property of a OccmDemandSignalItem. This constant has a value of “STORAGE”

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

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

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

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

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

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

REQUEST_TYPE_DEMAND = 'DEMAND'¶: A constant which can be used with the request_type property of a OccmDemandSignalItem. This constant has a value of “DEMAND”

__init__(**kwargs)¶

Initializes a new OccmDemandSignalItem 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 OccmDemandSignalItem.
compartment_id (str) – The value to assign to the compartment_id property of this OccmDemandSignalItem.
demand_signal_id (str) – The value to assign to the demand_signal_id property of this OccmDemandSignalItem.
demand_signal_namespace (str) – The value to assign to the demand_signal_namespace property of this OccmDemandSignalItem. Allowed values for this property are: “COMPUTE”, “NETWORK”, “GPU”, “STORAGE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
demand_signal_catalog_resource_id (str) – The value to assign to the demand_signal_catalog_resource_id property of this OccmDemandSignalItem.
request_type (str) – The value to assign to the request_type property of this OccmDemandSignalItem. Allowed values for this property are: “DEMAND”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
resource_name (str) – The value to assign to the resource_name property of this OccmDemandSignalItem.
region (str) – The value to assign to the region property of this OccmDemandSignalItem.
availability_domain (str) – The value to assign to the availability_domain property of this OccmDemandSignalItem.
target_compartment_id (str) – The value to assign to the target_compartment_id property of this OccmDemandSignalItem.
demand_quantity (int) – The value to assign to the demand_quantity property of this OccmDemandSignalItem.
time_needed_before (datetime) – The value to assign to the time_needed_before property of this OccmDemandSignalItem.
resource_properties (dict(str, str)) – The value to assign to the resource_properties property of this OccmDemandSignalItem.
notes (str) – The value to assign to the notes property of this OccmDemandSignalItem.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this OccmDemandSignalItem. 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’.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OccmDemandSignalItem.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OccmDemandSignalItem.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this OccmDemandSignalItem.

availability_domain¶

Gets the availability_domain of this OccmDemandSignalItem. The name of the availability domain for which you want to request the OCI resource.

Returns:	The availability_domain of this OccmDemandSignalItem.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this OccmDemandSignalItem. The OCID of the tenancy from which the demand signal item was created.

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

defined_tags¶

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

demand_quantity¶

[Required] Gets the demand_quantity of this OccmDemandSignalItem. The quantity of the resource that you want to demand from OCI.

Returns:	The demand_quantity of this OccmDemandSignalItem.
Return type:	int

demand_signal_catalog_resource_id¶

[Required] Gets the demand_signal_catalog_resource_id of this OccmDemandSignalItem. The OCID of the corresponding demand signal catalog resource.

Returns:	The demand_signal_catalog_resource_id of this OccmDemandSignalItem.
Return type:	str

demand_signal_id¶

[Required] Gets the demand_signal_id of this OccmDemandSignalItem. The OCID of the demand signal under which this item will be grouped.

Returns:	The demand_signal_id of this OccmDemandSignalItem.
Return type:	str

demand_signal_namespace¶

[Required] Gets the demand_signal_namespace of this OccmDemandSignalItem. The name of the OCI service in consideration for demand signal submission. For example: COMPUTE, NETWORK, GPU etc.

Allowed values for this property are: “COMPUTE”, “NETWORK”, “GPU”, “STORAGE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The demand_signal_namespace of this OccmDemandSignalItem.
Return type:	str

freeform_tags¶

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

id¶

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

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this OccmDemandSignalItem. The current lifecycle state of the resource.

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 OccmDemandSignalItem.
Return type:	str

notes¶

Gets the notes of this OccmDemandSignalItem. This field will serve as notes section for you. You can use this section to convey a message to OCI regarding your resource request.

NOTE: The previous value gets overwritten with the new one for this once updated.

Returns:	The notes of this OccmDemandSignalItem.
Return type:	str

region¶

[Required] Gets the region of this OccmDemandSignalItem. The name of region for which you want to request the OCI resource.

Returns:	The region of this OccmDemandSignalItem.
Return type:	str

request_type¶

[Required] Gets the request_type of this OccmDemandSignalItem. The type of request (DEMAND or RETURN) made against a particular demand signal item.

Allowed values for this property are: “DEMAND”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The request_type of this OccmDemandSignalItem.
Return type:	str

resource_name¶

[Required] Gets the resource_name of this OccmDemandSignalItem. The name of the OCI resource that you want to request.

Returns:	The resource_name of this OccmDemandSignalItem.
Return type:	str

resource_properties¶

[Required] Gets the resource_properties of this OccmDemandSignalItem. A map of various properties associated with the OCI resource.

Returns:	The resource_properties of this OccmDemandSignalItem.
Return type:	dict(str, str)

system_tags¶

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

target_compartment_id¶

Gets the target_compartment_id of this OccmDemandSignalItem. The OCID of the tenancy for which you want to request the OCI resource for. This is an optional parameter.

Returns:	The target_compartment_id of this OccmDemandSignalItem.
Return type:	str

time_needed_before¶

[Required] Gets the time_needed_before of this OccmDemandSignalItem. the date before which you would ideally like the OCI resource to be delivered to you.

Returns:	The time_needed_before of this OccmDemandSignalItem.
Return type:	datetime