oci 2.152.0__py3-none-any.whl → 2.153.0__py3-none-any.whl

oci/capacity_management/models/occm_demand_signal.py

@@ -0,0 +1,464 @@
+# coding: utf-8
+# Copyright (c) 2016, 2025, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20231107
+
+
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class OccmDemandSignal(object):
+    """
+    An occm demand signal is a resource that communicates the forecasting needs of a customer to OCI in advance.
+    """
+
+    #: A constant which can be used with the lifecycle_details property of a OccmDemandSignal.
+    #: This constant has a value of "CREATED"
+    LIFECYCLE_DETAILS_CREATED = "CREATED"
+
+    #: A constant which can be used with the lifecycle_details property of a OccmDemandSignal.
+    #: This constant has a value of "SUBMITTED"
+    LIFECYCLE_DETAILS_SUBMITTED = "SUBMITTED"
+
+    #: A constant which can be used with the lifecycle_details property of a OccmDemandSignal.
+    #: This constant has a value of "DELETED"
+    LIFECYCLE_DETAILS_DELETED = "DELETED"
+
+    #: A constant which can be used with the lifecycle_details property of a OccmDemandSignal.
+    #: This constant has a value of "IN_PROGRESS"
+    LIFECYCLE_DETAILS_IN_PROGRESS = "IN_PROGRESS"
+
+    #: A constant which can be used with the lifecycle_details property of a OccmDemandSignal.
+    #: This constant has a value of "REJECTED"
+    LIFECYCLE_DETAILS_REJECTED = "REJECTED"
+
+    #: A constant which can be used with the lifecycle_details property of a OccmDemandSignal.
+    #: This constant has a value of "COMPLETED"
+    LIFECYCLE_DETAILS_COMPLETED = "COMPLETED"
+
+    #: A constant which can be used with the lifecycle_state property of a OccmDemandSignal.
+    #: This constant has a value of "CREATING"
+    LIFECYCLE_STATE_CREATING = "CREATING"
+
+    #: A constant which can be used with the lifecycle_state property of a OccmDemandSignal.
+    #: This constant has a value of "ACTIVE"
+    LIFECYCLE_STATE_ACTIVE = "ACTIVE"
+
+    #: A constant which can be used with the lifecycle_state property of a OccmDemandSignal.
+    #: This constant has a value of "UPDATING"
+    LIFECYCLE_STATE_UPDATING = "UPDATING"
+
+    #: A constant which can be used with the lifecycle_state property of a OccmDemandSignal.
+    #: This constant has a value of "DELETED"
+    LIFECYCLE_STATE_DELETED = "DELETED"
+
+    #: A constant which can be used with the lifecycle_state property of a OccmDemandSignal.
+    #: This constant has a value of "DELETING"
+    LIFECYCLE_STATE_DELETING = "DELETING"
+
+    #: A constant which can be used with the lifecycle_state property of a OccmDemandSignal.
+    #: This constant has a value of "FAILED"
+    LIFECYCLE_STATE_FAILED = "FAILED"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new OccmDemandSignal object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param id:
+            The value to assign to the id property of this OccmDemandSignal.
+        :type id: str
+
+        :param compartment_id:
+            The value to assign to the compartment_id property of this OccmDemandSignal.
+        :type compartment_id: str
+
+        :param lifecycle_details:
+            The value to assign to the lifecycle_details property of this OccmDemandSignal.
+            Allowed values for this property are: "CREATED", "SUBMITTED", "DELETED", "IN_PROGRESS", "REJECTED", "COMPLETED", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type lifecycle_details: str
+
+        :param display_name:
+            The value to assign to the display_name property of this OccmDemandSignal.
+        :type display_name: str
+
+        :param description:
+            The value to assign to the description property of this OccmDemandSignal.
+        :type description: str
+
+        :param lifecycle_state:
+            The value to assign to the lifecycle_state property of this OccmDemandSignal.
+            Allowed values for this property are: "CREATING", "ACTIVE", "UPDATING", "DELETED", "DELETING", "FAILED", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type lifecycle_state: str
+
+        :param freeform_tags:
+            The value to assign to the freeform_tags property of this OccmDemandSignal.
+        :type freeform_tags: dict(str, str)
+
+        :param defined_tags:
+            The value to assign to the defined_tags property of this OccmDemandSignal.
+        :type defined_tags: dict(str, dict(str, object))
+
+        :param system_tags:
+            The value to assign to the system_tags property of this OccmDemandSignal.
+        :type system_tags: dict(str, dict(str, object))
+
+        :param time_created:
+            The value to assign to the time_created property of this OccmDemandSignal.
+        :type time_created: datetime
+
+        :param time_updated:
+            The value to assign to the time_updated property of this OccmDemandSignal.
+        :type time_updated: datetime
+
+        """
+        self.swagger_types = {
+            'id': 'str',
+            'compartment_id': 'str',
+            'lifecycle_details': 'str',
+            'display_name': 'str',
+            'description': 'str',
+            'lifecycle_state': 'str',
+            'freeform_tags': 'dict(str, str)',
+            'defined_tags': 'dict(str, dict(str, object))',
+            'system_tags': 'dict(str, dict(str, object))',
+            'time_created': 'datetime',
+            'time_updated': 'datetime'
+        }
+        self.attribute_map = {
+            'id': 'id',
+            'compartment_id': 'compartmentId',
+            'lifecycle_details': 'lifecycleDetails',
+            'display_name': 'displayName',
+            'description': 'description',
+            'lifecycle_state': 'lifecycleState',
+            'freeform_tags': 'freeformTags',
+            'defined_tags': 'definedTags',
+            'system_tags': 'systemTags',
+            'time_created': 'timeCreated',
+            'time_updated': 'timeUpdated'
+        }
+        self._id = None
+        self._compartment_id = None
+        self._lifecycle_details = None
+        self._display_name = None
+        self._description = None
+        self._lifecycle_state = None
+        self._freeform_tags = None
+        self._defined_tags = None
+        self._system_tags = None
+        self._time_created = None
+        self._time_updated = None
+
+    @property
+    def id(self):
+        """
+        **[Required]** Gets the id of this OccmDemandSignal.
+        The OCID of the demand signal.
+
+
+        :return: The id of this OccmDemandSignal.
+        :rtype: str
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """
+        Sets the id of this OccmDemandSignal.
+        The OCID of the demand signal.
+
+
+        :param id: The id of this OccmDemandSignal.
+        :type: str
+        """
+        self._id = id
+
+    @property
+    def compartment_id(self):
+        """
+        **[Required]** Gets the compartment_id of this OccmDemandSignal.
+        The OCID of the tenancy from which the request to create the demand signal was made.
+
+
+        :return: The compartment_id of this OccmDemandSignal.
+        :rtype: str
+        """
+        return self._compartment_id
+
+    @compartment_id.setter
+    def compartment_id(self, compartment_id):
+        """
+        Sets the compartment_id of this OccmDemandSignal.
+        The OCID of the tenancy from which the request to create the demand signal was made.
+
+
+        :param compartment_id: The compartment_id of this OccmDemandSignal.
+        :type: str
+        """
+        self._compartment_id = compartment_id
+
+    @property
+    def lifecycle_details(self):
+        """
+        **[Required]** Gets the lifecycle_details of this OccmDemandSignal.
+        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.
+        CANCELLED -> OCI can transition the demand signal to this state.
+        COMPLETED -> OCI will transition the demand signal to COMPLETED state once the quantities which OCI committed to deliver to you has been delivered.
+
+        Allowed values for this property are: "CREATED", "SUBMITTED", "DELETED", "IN_PROGRESS", "REJECTED", "COMPLETED", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The lifecycle_details of this OccmDemandSignal.
+        :rtype: str
+        """
+        return self._lifecycle_details
+
+    @lifecycle_details.setter
+    def lifecycle_details(self, lifecycle_details):
+        """
+        Sets the lifecycle_details of this OccmDemandSignal.
+        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.
+        CANCELLED -> OCI can transition the demand signal to this state.
+        COMPLETED -> OCI will transition the demand signal to COMPLETED state once the quantities which OCI committed to deliver to you has been delivered.
+
+
+        :param lifecycle_details: The lifecycle_details of this OccmDemandSignal.
+        :type: str
+        """
+        allowed_values = ["CREATED", "SUBMITTED", "DELETED", "IN_PROGRESS", "REJECTED", "COMPLETED"]
+        if not value_allowed_none_or_none_sentinel(lifecycle_details, allowed_values):
+            lifecycle_details = 'UNKNOWN_ENUM_VALUE'
+        self._lifecycle_details = lifecycle_details
+
+    @property
+    def display_name(self):
+        """
+        **[Required]** Gets the display_name of this OccmDemandSignal.
+        The display name of the demand signal.
+
+
+        :return: The display_name of this OccmDemandSignal.
+        :rtype: str
+        """
+        return self._display_name
+
+    @display_name.setter
+    def display_name(self, display_name):
+        """
+        Sets the display_name of this OccmDemandSignal.
+        The display name of the demand signal.
+
+
+        :param display_name: The display_name of this OccmDemandSignal.
+        :type: str
+        """
+        self._display_name = display_name
+
+    @property
+    def description(self):
+        """
+        Gets the description of this OccmDemandSignal.
+        Meaningful text about the demand signal.
+
+
+        :return: The description of this OccmDemandSignal.
+        :rtype: str
+        """
+        return self._description
+
+    @description.setter
+    def description(self, description):
+        """
+        Sets the description of this OccmDemandSignal.
+        Meaningful text about the demand signal.
+
+
+        :param description: The description of this OccmDemandSignal.
+        :type: str
+        """
+        self._description = description
+
+    @property
+    def lifecycle_state(self):
+        """
+        **[Required]** Gets the lifecycle_state of this OccmDemandSignal.
+        The current lifecycle state of the resource.
+
+        Allowed values for this property are: "CREATING", "ACTIVE", "UPDATING", "DELETED", "DELETING", "FAILED", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The lifecycle_state of this OccmDemandSignal.
+        :rtype: str
+        """
+        return self._lifecycle_state
+
+    @lifecycle_state.setter
+    def lifecycle_state(self, lifecycle_state):
+        """
+        Sets the lifecycle_state of this OccmDemandSignal.
+        The current lifecycle state of the resource.
+
+
+        :param lifecycle_state: The lifecycle_state of this OccmDemandSignal.
+        :type: str
+        """
+        allowed_values = ["CREATING", "ACTIVE", "UPDATING", "DELETED", "DELETING", "FAILED"]
+        if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values):
+            lifecycle_state = 'UNKNOWN_ENUM_VALUE'
+        self._lifecycle_state = lifecycle_state
+
+    @property
+    def freeform_tags(self):
+        """
+        Gets the freeform_tags of this OccmDemandSignal.
+        Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
+        Example: `{\"bar-key\": \"value\"}`
+
+
+        :return: The freeform_tags of this OccmDemandSignal.
+        :rtype: dict(str, str)
+        """
+        return self._freeform_tags
+
+    @freeform_tags.setter
+    def freeform_tags(self, freeform_tags):
+        """
+        Sets the freeform_tags of this OccmDemandSignal.
+        Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
+        Example: `{\"bar-key\": \"value\"}`
+
+
+        :param freeform_tags: The freeform_tags of this OccmDemandSignal.
+        :type: dict(str, str)
+        """
+        self._freeform_tags = freeform_tags
+
+    @property
+    def defined_tags(self):
+        """
+        Gets the defined_tags of this OccmDemandSignal.
+        Defined tags for this resource. Each key is predefined and scoped to a namespace.
+        Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
+
+
+        :return: The defined_tags of this OccmDemandSignal.
+        :rtype: dict(str, dict(str, object))
+        """
+        return self._defined_tags
+
+    @defined_tags.setter
+    def defined_tags(self, defined_tags):
+        """
+        Sets the defined_tags of this OccmDemandSignal.
+        Defined tags for this resource. Each key is predefined and scoped to a namespace.
+        Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
+
+
+        :param defined_tags: The defined_tags of this OccmDemandSignal.
+        :type: dict(str, dict(str, object))
+        """
+        self._defined_tags = defined_tags
+
+    @property
+    def system_tags(self):
+        """
+        Gets the system_tags of this OccmDemandSignal.
+        System tags for this resource. Each key is predefined and scoped to a namespace.
+        Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
+
+
+        :return: The system_tags of this OccmDemandSignal.
+        :rtype: dict(str, dict(str, object))
+        """
+        return self._system_tags
+
+    @system_tags.setter
+    def system_tags(self, system_tags):
+        """
+        Sets the system_tags of this OccmDemandSignal.
+        System tags for this resource. Each key is predefined and scoped to a namespace.
+        Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
+
+
+        :param system_tags: The system_tags of this OccmDemandSignal.
+        :type: dict(str, dict(str, object))
+        """
+        self._system_tags = system_tags
+
+    @property
+    def time_created(self):
+        """
+        **[Required]** Gets the time_created of this OccmDemandSignal.
+        The time when the demand signal was created.
+
+
+        :return: The time_created of this OccmDemandSignal.
+        :rtype: datetime
+        """
+        return self._time_created
+
+    @time_created.setter
+    def time_created(self, time_created):
+        """
+        Sets the time_created of this OccmDemandSignal.
+        The time when the demand signal was created.
+
+
+        :param time_created: The time_created of this OccmDemandSignal.
+        :type: datetime
+        """
+        self._time_created = time_created
+
+    @property
+    def time_updated(self):
+        """
+        **[Required]** Gets the time_updated of this OccmDemandSignal.
+        The time when the demand signal was last updated.
+
+
+        :return: The time_updated of this OccmDemandSignal.
+        :rtype: datetime
+        """
+        return self._time_updated
+
+    @time_updated.setter
+    def time_updated(self, time_updated):
+        """
+        Sets the time_updated of this OccmDemandSignal.
+        The time when the demand signal was last updated.
+
+
+        :param time_updated: The time_updated of this OccmDemandSignal.
+        :type: datetime
+        """
+        self._time_updated = time_updated
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other