OccmDemandSignalItemSummary

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

Bases: object

A summary model containing information about various demand signal resource requests.

Attributes:

DEMAND_SIGNAL_NAMESPACE_COMPUTE

A constant which can be used with the demand_signal_namespace property of a OccmDemandSignalItemSummary.

DEMAND_SIGNAL_NAMESPACE_GPU

A constant which can be used with the demand_signal_namespace property of a OccmDemandSignalItemSummary.

DEMAND_SIGNAL_NAMESPACE_NETWORK

A constant which can be used with the demand_signal_namespace property of a OccmDemandSignalItemSummary.

DEMAND_SIGNAL_NAMESPACE_STORAGE

A constant which can be used with the demand_signal_namespace property of a OccmDemandSignalItemSummary.

REQUEST_TYPE_DEMAND

A constant which can be used with the request_type property of a OccmDemandSignalItemSummary.

availability_domain

Gets the availability_domain of this OccmDemandSignalItemSummary.

compartment_id

[Required] Gets the compartment_id of this OccmDemandSignalItemSummary.

defined_tags

Gets the defined_tags of this OccmDemandSignalItemSummary.

demand_signal_catalog_resource_id

[Required] Gets the demand_signal_catalog_resource_id of this OccmDemandSignalItemSummary.

demand_signal_id

[Required] Gets the demand_signal_id of this OccmDemandSignalItemSummary.

demand_signal_namespace

[Required] Gets the demand_signal_namespace of this OccmDemandSignalItemSummary.

freeform_tags

Gets the freeform_tags of this OccmDemandSignalItemSummary.

id

[Required] Gets the id of this OccmDemandSignalItemSummary.

lifecycle_state

[Required] Gets the lifecycle_state of this OccmDemandSignalItemSummary.

notes

Gets the notes of this OccmDemandSignalItemSummary.

quantity

[Required] Gets the quantity of this OccmDemandSignalItemSummary.

region

[Required] Gets the region of this OccmDemandSignalItemSummary.

request_type

[Required] Gets the request_type of this OccmDemandSignalItemSummary.

resource_name

[Required] Gets the resource_name of this OccmDemandSignalItemSummary.

resource_properties

[Required] Gets the resource_properties of this OccmDemandSignalItemSummary.

system_tags

Gets the system_tags of this OccmDemandSignalItemSummary.

target_compartment_id

Gets the target_compartment_id of this OccmDemandSignalItemSummary.

time_needed_before

[Required] Gets the time_needed_before of this OccmDemandSignalItemSummary.

Methods:

__init__(**kwargs)

Initializes a new OccmDemandSignalItemSummary 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 OccmDemandSignalItemSummary. 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 OccmDemandSignalItemSummary. 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 OccmDemandSignalItemSummary. 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 OccmDemandSignalItemSummary. This constant has a value of “STORAGE”

REQUEST_TYPE_DEMAND = 'DEMAND'

A constant which can be used with the request_type property of a OccmDemandSignalItemSummary. This constant has a value of “DEMAND”

__init__(**kwargs)

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

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

  • demand_signal_id (str) – The value to assign to the demand_signal_id property of this OccmDemandSignalItemSummary.

  • demand_signal_namespace (str) – The value to assign to the demand_signal_namespace property of this OccmDemandSignalItemSummary. 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 OccmDemandSignalItemSummary.

  • request_type (str) – The value to assign to the request_type property of this OccmDemandSignalItemSummary. 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 OccmDemandSignalItemSummary.

  • region (str) – The value to assign to the region property of this OccmDemandSignalItemSummary.

  • availability_domain (str) – The value to assign to the availability_domain property of this OccmDemandSignalItemSummary.

  • target_compartment_id (str) – The value to assign to the target_compartment_id property of this OccmDemandSignalItemSummary.

  • quantity (int) – The value to assign to the quantity property of this OccmDemandSignalItemSummary.

  • time_needed_before (datetime) – The value to assign to the time_needed_before property of this OccmDemandSignalItemSummary.

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

  • notes (str) – The value to assign to the notes property of this OccmDemandSignalItemSummary.

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

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

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

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

property availability_domain

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

Returns

The availability_domain of this OccmDemandSignalItemSummary.

Return type

str

property compartment_id

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

Returns

The compartment_id of this OccmDemandSignalItemSummary.

Return type

str

property defined_tags

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

Return type

dict(str, dict(str, object))

property demand_signal_catalog_resource_id

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

Returns

The demand_signal_catalog_resource_id of this OccmDemandSignalItemSummary.

Return type

str

property demand_signal_id

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

Returns

The demand_signal_id of this OccmDemandSignalItemSummary.

Return type

str

property demand_signal_namespace

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

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property id

[Required] Gets the id of this OccmDemandSignalItemSummary. The OCID of the demand signal resource request.

Returns

The id of this OccmDemandSignalItemSummary.

Return type

str

property lifecycle_state

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

Returns

The lifecycle_state of this OccmDemandSignalItemSummary.

Return type

str

property notes

Gets the notes of this OccmDemandSignalItemSummary. 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 OccmDemandSignalItemSummary.

Return type

str

property quantity

[Required] Gets the quantity of this OccmDemandSignalItemSummary. The quantity of the resource that you want to demand from OCI or return to OCI.

Returns

The quantity of this OccmDemandSignalItemSummary.

Return type

int

property region

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

Returns

The region of this OccmDemandSignalItemSummary.

Return type

str

property request_type

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

Return type

str

property resource_name

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

Returns

The resource_name of this OccmDemandSignalItemSummary.

Return type

str

property resource_properties

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

Returns

The resource_properties of this OccmDemandSignalItemSummary.

Return type

dict(str, str)

property system_tags

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

Return type

dict(str, dict(str, object))

property target_compartment_id

Gets the target_compartment_id of this OccmDemandSignalItemSummary. 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 OccmDemandSignalItemSummary.

Return type

str

property time_needed_before

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

Returns

The time_needed_before of this OccmDemandSignalItemSummary.

Return type

datetime