oci 2.126.4__py3-none-any.whl → 2.128.0__py3-none-any.whl

oci/demand_signal/models/occ_demand_signal.py

@@ -0,0 +1,501 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, 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: 20240430
+
+
+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 OccDemandSignal(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`__.
+
+    __ https://docs.cloud.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm
+    """
+
+    #: A constant which can be used with the lifecycle_state property of a OccDemandSignal.
+    #: This constant has a value of "CREATING"
+    LIFECYCLE_STATE_CREATING = "CREATING"
+
+    #: A constant which can be used with the lifecycle_state property of a OccDemandSignal.
+    #: This constant has a value of "UPDATING"
+    LIFECYCLE_STATE_UPDATING = "UPDATING"
+
+    #: A constant which can be used with the lifecycle_state property of a OccDemandSignal.
+    #: This constant has a value of "ACTIVE"
+    LIFECYCLE_STATE_ACTIVE = "ACTIVE"
+
+    #: A constant which can be used with the lifecycle_state property of a OccDemandSignal.
+    #: This constant has a value of "DELETING"
+    LIFECYCLE_STATE_DELETING = "DELETING"
+
+    #: A constant which can be used with the lifecycle_state property of a OccDemandSignal.
+    #: This constant has a value of "DELETED"
+    LIFECYCLE_STATE_DELETED = "DELETED"
+
+    #: A constant which can be used with the lifecycle_state property of a OccDemandSignal.
+    #: This constant has a value of "FAILED"
+    LIFECYCLE_STATE_FAILED = "FAILED"
+
+    def __init__(self, **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):
+
+        :param id:
+            The value to assign to the id property of this OccDemandSignal.
+        :type id: str
+
+        :param compartment_id:
+            The value to assign to the compartment_id property of this OccDemandSignal.
+        :type compartment_id: str
+
+        :param display_name:
+            The value to assign to the display_name property of this OccDemandSignal.
+        :type display_name: str
+
+        :param occ_demand_signals:
+            The value to assign to the occ_demand_signals property of this OccDemandSignal.
+        :type occ_demand_signals: list[oci.demand_signal.models.OccDemandSignalData]
+
+        :param is_active:
+            The value to assign to the is_active property of this OccDemandSignal.
+        :type is_active: bool
+
+        :param lifecycle_state:
+            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'.
+        :type lifecycle_state: str
+
+        :param time_created:
+            The value to assign to the time_created property of this OccDemandSignal.
+        :type time_created: datetime
+
+        :param time_updated:
+            The value to assign to the time_updated property of this OccDemandSignal.
+        :type time_updated: datetime
+
+        :param lifecycle_details:
+            The value to assign to the lifecycle_details property of this OccDemandSignal.
+        :type lifecycle_details: str
+
+        :param freeform_tags:
+            The value to assign to the freeform_tags property of this OccDemandSignal.
+        :type freeform_tags: dict(str, str)
+
+        :param defined_tags:
+            The value to assign to the defined_tags property of this OccDemandSignal.
+        :type defined_tags: dict(str, dict(str, object))
+
+        :param system_tags:
+            The value to assign to the system_tags property of this OccDemandSignal.
+        :type system_tags: dict(str, dict(str, object))
+
+        """
+        self.swagger_types = {
+            'id': 'str',
+            'compartment_id': 'str',
+            'display_name': 'str',
+            'occ_demand_signals': 'list[OccDemandSignalData]',
+            'is_active': 'bool',
+            'lifecycle_state': 'str',
+            'time_created': 'datetime',
+            'time_updated': 'datetime',
+            'lifecycle_details': 'str',
+            'freeform_tags': 'dict(str, str)',
+            'defined_tags': 'dict(str, dict(str, object))',
+            'system_tags': 'dict(str, dict(str, object))'
+        }
+
+        self.attribute_map = {
+            'id': 'id',
+            'compartment_id': 'compartmentId',
+            'display_name': 'displayName',
+            'occ_demand_signals': 'occDemandSignals',
+            'is_active': 'isActive',
+            'lifecycle_state': 'lifecycleState',
+            'time_created': 'timeCreated',
+            'time_updated': 'timeUpdated',
+            'lifecycle_details': 'lifecycleDetails',
+            'freeform_tags': 'freeformTags',
+            'defined_tags': 'definedTags',
+            'system_tags': 'systemTags'
+        }
+
+        self._id = None
+        self._compartment_id = None
+        self._display_name = None
+        self._occ_demand_signals = None
+        self._is_active = None
+        self._lifecycle_state = None
+        self._time_created = None
+        self._time_updated = None
+        self._lifecycle_details = None
+        self._freeform_tags = None
+        self._defined_tags = None
+        self._system_tags = None
+
+    @property
+    def id(self):
+        """
+        **[Required]** Gets the id of this OccDemandSignal.
+        The `OCID`__ of the OccDemandSignal.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :return: The id of this OccDemandSignal.
+        :rtype: str
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """
+        Sets the id of this OccDemandSignal.
+        The `OCID`__ of the OccDemandSignal.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :param id: The id of this OccDemandSignal.
+        :type: str
+        """
+        self._id = id
+
+    @property
+    def compartment_id(self):
+        """
+        **[Required]** Gets the compartment_id of this OccDemandSignal.
+        The `OCID`__ of the compartment.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :return: The compartment_id of this OccDemandSignal.
+        :rtype: str
+        """
+        return self._compartment_id
+
+    @compartment_id.setter
+    def compartment_id(self, compartment_id):
+        """
+        Sets the compartment_id of this OccDemandSignal.
+        The `OCID`__ of the compartment.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :param compartment_id: The compartment_id of this OccDemandSignal.
+        :type: str
+        """
+        self._compartment_id = compartment_id
+
+    @property
+    def display_name(self):
+        """
+        **[Required]** Gets the display_name of this OccDemandSignal.
+        A user-friendly name. Does not have to be unique, and it's changeable.
+
+
+        :return: The display_name of this OccDemandSignal.
+        :rtype: str
+        """
+        return self._display_name
+
+    @display_name.setter
+    def display_name(self, display_name):
+        """
+        Sets the display_name of this OccDemandSignal.
+        A user-friendly name. Does not have to be unique, and it's changeable.
+
+
+        :param display_name: The display_name of this OccDemandSignal.
+        :type: str
+        """
+        self._display_name = display_name
+
+    @property
+    def occ_demand_signals(self):
+        """
+        **[Required]** Gets the occ_demand_signals of this OccDemandSignal.
+        The OccDemandSignal data.
+
+
+        :return: The occ_demand_signals of this OccDemandSignal.
+        :rtype: list[oci.demand_signal.models.OccDemandSignalData]
+        """
+        return self._occ_demand_signals
+
+    @occ_demand_signals.setter
+    def occ_demand_signals(self, occ_demand_signals):
+        """
+        Sets the occ_demand_signals of this OccDemandSignal.
+        The OccDemandSignal data.
+
+
+        :param occ_demand_signals: The occ_demand_signals of this OccDemandSignal.
+        :type: list[oci.demand_signal.models.OccDemandSignalData]
+        """
+        self._occ_demand_signals = occ_demand_signals
+
+    @property
+    def is_active(self):
+        """
+        **[Required]** Gets the is_active of this OccDemandSignal.
+        Indicator of whether to share the data with Oracle.
+
+
+        :return: The is_active of this OccDemandSignal.
+        :rtype: bool
+        """
+        return self._is_active
+
+    @is_active.setter
+    def is_active(self, is_active):
+        """
+        Sets the is_active of this OccDemandSignal.
+        Indicator of whether to share the data with Oracle.
+
+
+        :param is_active: The is_active of this OccDemandSignal.
+        :type: bool
+        """
+        self._is_active = is_active
+
+    @property
+    def lifecycle_state(self):
+        """
+        **[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'.
+
+
+        :return: The lifecycle_state of this OccDemandSignal.
+        :rtype: str
+        """
+        return self._lifecycle_state
+
+    @lifecycle_state.setter
+    def lifecycle_state(self, lifecycle_state):
+        """
+        Sets the lifecycle_state of this OccDemandSignal.
+        The current state of the OccDemandSignal.
+
+
+        :param lifecycle_state: The lifecycle_state of this OccDemandSignal.
+        :type: str
+        """
+        allowed_values = ["CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "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 time_created(self):
+        """
+        **[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`
+
+        __ https://tools.ietf.org/html/rfc3339
+
+
+        :return: The time_created of this OccDemandSignal.
+        :rtype: datetime
+        """
+        return self._time_created
+
+    @time_created.setter
+    def time_created(self, time_created):
+        """
+        Sets 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`
+
+        __ https://tools.ietf.org/html/rfc3339
+
+
+        :param time_created: The time_created of this OccDemandSignal.
+        :type: datetime
+        """
+        self._time_created = time_created
+
+    @property
+    def time_updated(self):
+        """
+        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`
+
+        __ https://tools.ietf.org/html/rfc3339
+
+
+        :return: The time_updated of this OccDemandSignal.
+        :rtype: datetime
+        """
+        return self._time_updated
+
+    @time_updated.setter
+    def time_updated(self, time_updated):
+        """
+        Sets 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`
+
+        __ https://tools.ietf.org/html/rfc3339
+
+
+        :param time_updated: The time_updated of this OccDemandSignal.
+        :type: datetime
+        """
+        self._time_updated = time_updated
+
+    @property
+    def lifecycle_details(self):
+        """
+        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.
+
+
+        :return: The lifecycle_details of this OccDemandSignal.
+        :rtype: str
+        """
+        return self._lifecycle_details
+
+    @lifecycle_details.setter
+    def lifecycle_details(self, lifecycle_details):
+        """
+        Sets 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.
+
+
+        :param lifecycle_details: The lifecycle_details of this OccDemandSignal.
+        :type: str
+        """
+        self._lifecycle_details = lifecycle_details
+
+    @property
+    def freeform_tags(self):
+        """
+        **[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\"}`
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm
+
+
+        :return: The freeform_tags of this OccDemandSignal.
+        :rtype: dict(str, str)
+        """
+        return self._freeform_tags
+
+    @freeform_tags.setter
+    def freeform_tags(self, freeform_tags):
+        """
+        Sets 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\"}`
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm
+
+
+        :param freeform_tags: The freeform_tags of this OccDemandSignal.
+        :type: dict(str, str)
+        """
+        self._freeform_tags = freeform_tags
+
+    @property
+    def defined_tags(self):
+        """
+        **[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\"}}`
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm
+
+
+        :return: The defined_tags of this OccDemandSignal.
+        :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 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\"}}`
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm
+
+
+        :param defined_tags: The defined_tags of this OccDemandSignal.
+        :type: dict(str, dict(str, object))
+        """
+        self._defined_tags = defined_tags
+
+    @property
+    def system_tags(self):
+        """
+        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\"}}`
+
+
+        :return: The system_tags of this OccDemandSignal.
+        :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 OccDemandSignal.
+        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 OccDemandSignal.
+        :type: dict(str, dict(str, object))
+        """
+        self._system_tags = system_tags
+
+    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

oci/demand_signal/models/occ_demand_signal_collection.py

@@ -0,0 +1,72 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, 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: 20240430
+
+
+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 OccDemandSignalCollection(object):
+    """
+    Results of a occDemandSignal search. Contains both OccDemandSignalSummary items and other information, such as metadata.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new OccDemandSignalCollection object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param items:
+            The value to assign to the items property of this OccDemandSignalCollection.
+        :type items: list[oci.demand_signal.models.OccDemandSignalSummary]
+
+        """
+        self.swagger_types = {
+            'items': 'list[OccDemandSignalSummary]'
+        }
+
+        self.attribute_map = {
+            'items': 'items'
+        }
+
+        self._items = None
+
+    @property
+    def items(self):
+        """
+        **[Required]** Gets the items of this OccDemandSignalCollection.
+        List of occDemandSignals.
+
+
+        :return: The items of this OccDemandSignalCollection.
+        :rtype: list[oci.demand_signal.models.OccDemandSignalSummary]
+        """
+        return self._items
+
+    @items.setter
+    def items(self, items):
+        """
+        Sets the items of this OccDemandSignalCollection.
+        List of occDemandSignals.
+
+
+        :param items: The items of this OccDemandSignalCollection.
+        :type: list[oci.demand_signal.models.OccDemandSignalSummary]
+        """
+        self._items = items
+
+    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

oci/demand_signal/models/occ_demand_signal_data.py

@@ -0,0 +1,134 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, 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: 20240430
+
+
+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 OccDemandSignalData(object):
+    """
+    The Data Object For Demand Signal.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new OccDemandSignalData object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param resource_type:
+            The value to assign to the resource_type property of this OccDemandSignalData.
+        :type resource_type: str
+
+        :param units:
+            The value to assign to the units property of this OccDemandSignalData.
+        :type units: str
+
+        :param values:
+            The value to assign to the values property of this OccDemandSignalData.
+        :type values: list[oci.demand_signal.models.OccDemandSignalValue]
+
+        """
+        self.swagger_types = {
+            'resource_type': 'str',
+            'units': 'str',
+            'values': 'list[OccDemandSignalValue]'
+        }
+
+        self.attribute_map = {
+            'resource_type': 'resourceType',
+            'units': 'units',
+            'values': 'values'
+        }
+
+        self._resource_type = None
+        self._units = None
+        self._values = None
+
+    @property
+    def resource_type(self):
+        """
+        **[Required]** Gets the resource_type of this OccDemandSignalData.
+        The name of the resource for the data.
+
+
+        :return: The resource_type of this OccDemandSignalData.
+        :rtype: str
+        """
+        return self._resource_type
+
+    @resource_type.setter
+    def resource_type(self, resource_type):
+        """
+        Sets the resource_type of this OccDemandSignalData.
+        The name of the resource for the data.
+
+
+        :param resource_type: The resource_type of this OccDemandSignalData.
+        :type: str
+        """
+        self._resource_type = resource_type
+
+    @property
+    def units(self):
+        """
+        **[Required]** Gets the units of this OccDemandSignalData.
+        The units of the data.
+
+
+        :return: The units of this OccDemandSignalData.
+        :rtype: str
+        """
+        return self._units
+
+    @units.setter
+    def units(self, units):
+        """
+        Sets the units of this OccDemandSignalData.
+        The units of the data.
+
+
+        :param units: The units of this OccDemandSignalData.
+        :type: str
+        """
+        self._units = units
+
+    @property
+    def values(self):
+        """
+        **[Required]** Gets the values of this OccDemandSignalData.
+        The values of forecast.
+
+
+        :return: The values of this OccDemandSignalData.
+        :rtype: list[oci.demand_signal.models.OccDemandSignalValue]
+        """
+        return self._values
+
+    @values.setter
+    def values(self, values):
+        """
+        Sets the values of this OccDemandSignalData.
+        The values of forecast.
+
+
+        :param values: The values of this OccDemandSignalData.
+        :type: list[oci.demand_signal.models.OccDemandSignalValue]
+        """
+        self._values = values
+
+    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