CreateOccmDemandSignalItemDetails¶
- class oci.capacity_management.models.CreateOccmDemandSignalItemDetails(**kwargs)¶
Bases:
objectDetails about different fields required to create a demand signal item resource.
Attributes:
A constant which can be used with the request_type property of a CreateOccmDemandSignalItemDetails.
Gets the availability_domain of this CreateOccmDemandSignalItemDetails.
[Required] Gets the compartment_id of this CreateOccmDemandSignalItemDetails.
Gets the defined_tags of this CreateOccmDemandSignalItemDetails.
[Required] Gets the demand_quantity of this CreateOccmDemandSignalItemDetails.
[Required] Gets the demand_signal_catalog_resource_id of this CreateOccmDemandSignalItemDetails.
[Required] Gets the demand_signal_id of this CreateOccmDemandSignalItemDetails.
Gets the freeform_tags of this CreateOccmDemandSignalItemDetails.
Gets the notes of this CreateOccmDemandSignalItemDetails.
[Required] Gets the region of this CreateOccmDemandSignalItemDetails.
[Required] Gets the request_type of this CreateOccmDemandSignalItemDetails.
[Required] Gets the resource_properties of this CreateOccmDemandSignalItemDetails.
Gets the target_compartment_id of this CreateOccmDemandSignalItemDetails.
[Required] Gets the time_needed_before of this CreateOccmDemandSignalItemDetails.
Methods:
__init__(**kwargs)Initializes a new CreateOccmDemandSignalItemDetails object with values from keyword arguments.
- REQUEST_TYPE_DEMAND = 'DEMAND'¶
A constant which can be used with the request_type property of a CreateOccmDemandSignalItemDetails. This constant has a value of “DEMAND”
- __init__(**kwargs)¶
Initializes a new CreateOccmDemandSignalItemDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
compartment_id (str) – The value to assign to the compartment_id property of this CreateOccmDemandSignalItemDetails.
demand_signal_id (str) – The value to assign to the demand_signal_id property of this CreateOccmDemandSignalItemDetails.
demand_signal_catalog_resource_id (str) – The value to assign to the demand_signal_catalog_resource_id property of this CreateOccmDemandSignalItemDetails.
request_type (str) – The value to assign to the request_type property of this CreateOccmDemandSignalItemDetails. Allowed values for this property are: “DEMAND”
region (str) – The value to assign to the region property of this CreateOccmDemandSignalItemDetails.
availability_domain (str) – The value to assign to the availability_domain property of this CreateOccmDemandSignalItemDetails.
target_compartment_id (str) – The value to assign to the target_compartment_id property of this CreateOccmDemandSignalItemDetails.
demand_quantity (int) – The value to assign to the demand_quantity property of this CreateOccmDemandSignalItemDetails.
time_needed_before (datetime) – The value to assign to the time_needed_before property of this CreateOccmDemandSignalItemDetails.
resource_properties (dict(str, str)) – The value to assign to the resource_properties property of this CreateOccmDemandSignalItemDetails.
notes (str) – The value to assign to the notes property of this CreateOccmDemandSignalItemDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateOccmDemandSignalItemDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateOccmDemandSignalItemDetails.
- property availability_domain¶
Gets the availability_domain of this CreateOccmDemandSignalItemDetails. The name of the availability domain for which you want to request the OCI resource. This is an optional parameter.
- Returns
The availability_domain of this CreateOccmDemandSignalItemDetails.
- Return type
str
- property compartment_id¶
[Required] Gets the compartment_id of this CreateOccmDemandSignalItemDetails. The OCID of the tenancy from which the demand signal item was created.
- Returns
The compartment_id of this CreateOccmDemandSignalItemDetails.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this CreateOccmDemandSignalItemDetails. 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 CreateOccmDemandSignalItemDetails.
- Return type
dict(str, dict(str, object))
- property demand_quantity¶
[Required] Gets the demand_quantity of this CreateOccmDemandSignalItemDetails. The quantity of the resource that you want to demand from OCI.
- Returns
The demand_quantity of this CreateOccmDemandSignalItemDetails.
- Return type
int
- property demand_signal_catalog_resource_id¶
[Required] Gets the demand_signal_catalog_resource_id of this CreateOccmDemandSignalItemDetails. The OCID of the correponding demand signal catalog resource.
- Returns
The demand_signal_catalog_resource_id of this CreateOccmDemandSignalItemDetails.
- Return type
str
- property demand_signal_id¶
[Required] Gets the demand_signal_id of this CreateOccmDemandSignalItemDetails. The OCID of the demand signal under which we need to create this item.
- Returns
The demand_signal_id of this CreateOccmDemandSignalItemDetails.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this CreateOccmDemandSignalItemDetails. 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 CreateOccmDemandSignalItemDetails.
- Return type
dict(str, str)
- property notes¶
Gets the notes of this CreateOccmDemandSignalItemDetails. 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 CreateOccmDemandSignalItemDetails.
- Return type
str
- property region¶
[Required] Gets the region of this CreateOccmDemandSignalItemDetails. The name of region for which you want to request the OCI resource.
- Returns
The region of this CreateOccmDemandSignalItemDetails.
- Return type
str
- property request_type¶
[Required] Gets the request_type of this CreateOccmDemandSignalItemDetails. The type of request (DEMAND or RETURN) that you want to make for this demand signal item.
Allowed values for this property are: “DEMAND”
- Returns
The request_type of this CreateOccmDemandSignalItemDetails.
- Return type
str
- property resource_properties¶
[Required] Gets the resource_properties of this CreateOccmDemandSignalItemDetails. A map of various properties associated with the OCI resource.
- Returns
The resource_properties of this CreateOccmDemandSignalItemDetails.
- Return type
dict(str, str)
- property target_compartment_id¶
Gets the target_compartment_id of this CreateOccmDemandSignalItemDetails. 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 CreateOccmDemandSignalItemDetails.
- Return type
str
- property time_needed_before¶
[Required] Gets the time_needed_before of this CreateOccmDemandSignalItemDetails. the date before which you would ideally like the OCI resource to be delivered to you.
- Returns
The time_needed_before of this CreateOccmDemandSignalItemDetails.
- Return type
datetime