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

oci/resource_scheduler/models/compartment_id_resource_filter.py

@@ -0,0 +1,113 @@
+# 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 .resource_filter import ResourceFilter
+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 CompartmentIdResourceFilter(ResourceFilter):
+    """
+    This is a resource filter for filtering resource based on compartment OCID.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new CompartmentIdResourceFilter object with values from keyword arguments. The default value of the :py:attr:`~oci.resource_scheduler.models.CompartmentIdResourceFilter.attribute` attribute
+        of this class is ``COMPARTMENT_ID`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param attribute:
+            The value to assign to the attribute property of this CompartmentIdResourceFilter.
+            Allowed values for this property are: "COMPARTMENT_ID", "RESOURCE_TYPE", "DEFINED_TAGS", "TIME_CREATED", "LIFECYCLE_STATE"
+        :type attribute: str
+
+        :param value:
+            The value to assign to the value property of this CompartmentIdResourceFilter.
+        :type value: str
+
+        :param should_include_child_compartments:
+            The value to assign to the should_include_child_compartments property of this CompartmentIdResourceFilter.
+        :type should_include_child_compartments: bool
+
+        """
+        self.swagger_types = {
+            'attribute': 'str',
+            'value': 'str',
+            'should_include_child_compartments': 'bool'
+        }
+
+        self.attribute_map = {
+            'attribute': 'attribute',
+            'value': 'value',
+            'should_include_child_compartments': 'shouldIncludeChildCompartments'
+        }
+
+        self._attribute = None
+        self._value = None
+        self._should_include_child_compartments = None
+        self._attribute = 'COMPARTMENT_ID'
+
+    @property
+    def value(self):
+        """
+        Gets the value of this CompartmentIdResourceFilter.
+        This is the compartment used for filtering.
+
+
+        :return: The value of this CompartmentIdResourceFilter.
+        :rtype: str
+        """
+        return self._value
+
+    @value.setter
+    def value(self, value):
+        """
+        Sets the value of this CompartmentIdResourceFilter.
+        This is the compartment used for filtering.
+
+
+        :param value: The value of this CompartmentIdResourceFilter.
+        :type: str
+        """
+        self._value = value
+
+    @property
+    def should_include_child_compartments(self):
+        """
+        Gets the should_include_child_compartments of this CompartmentIdResourceFilter.
+        This sets whether to include child compartments.
+
+
+        :return: The should_include_child_compartments of this CompartmentIdResourceFilter.
+        :rtype: bool
+        """
+        return self._should_include_child_compartments
+
+    @should_include_child_compartments.setter
+    def should_include_child_compartments(self, should_include_child_compartments):
+        """
+        Sets the should_include_child_compartments of this CompartmentIdResourceFilter.
+        This sets whether to include child compartments.
+
+
+        :param should_include_child_compartments: The should_include_child_compartments of this CompartmentIdResourceFilter.
+        :type: bool
+        """
+        self._should_include_child_compartments = should_include_child_compartments
+
+    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/resource_scheduler/models/create_schedule_details.py

@@ -0,0 +1,487 @@
+# 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 CreateScheduleDetails(object):
+    """
+    This is the data to create a schedule.
+    """
+
+    #: A constant which can be used with the action property of a CreateScheduleDetails.
+    #: This constant has a value of "START_RESOURCE"
+    ACTION_START_RESOURCE = "START_RESOURCE"
+
+    #: A constant which can be used with the action property of a CreateScheduleDetails.
+    #: This constant has a value of "STOP_RESOURCE"
+    ACTION_STOP_RESOURCE = "STOP_RESOURCE"
+
+    #: A constant which can be used with the recurrence_type property of a CreateScheduleDetails.
+    #: This constant has a value of "CRON"
+    RECURRENCE_TYPE_CRON = "CRON"
+
+    #: A constant which can be used with the recurrence_type property of a CreateScheduleDetails.
+    #: This constant has a value of "ICAL"
+    RECURRENCE_TYPE_ICAL = "ICAL"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new CreateScheduleDetails object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param compartment_id:
+            The value to assign to the compartment_id property of this CreateScheduleDetails.
+        :type compartment_id: str
+
+        :param display_name:
+            The value to assign to the display_name property of this CreateScheduleDetails.
+        :type display_name: str
+
+        :param description:
+            The value to assign to the description property of this CreateScheduleDetails.
+        :type description: str
+
+        :param action:
+            The value to assign to the action property of this CreateScheduleDetails.
+            Allowed values for this property are: "START_RESOURCE", "STOP_RESOURCE"
+        :type action: str
+
+        :param recurrence_details:
+            The value to assign to the recurrence_details property of this CreateScheduleDetails.
+        :type recurrence_details: str
+
+        :param recurrence_type:
+            The value to assign to the recurrence_type property of this CreateScheduleDetails.
+            Allowed values for this property are: "CRON", "ICAL"
+        :type recurrence_type: str
+
+        :param resource_filters:
+            The value to assign to the resource_filters property of this CreateScheduleDetails.
+        :type resource_filters: list[oci.resource_scheduler.models.ResourceFilter]
+
+        :param resources:
+            The value to assign to the resources property of this CreateScheduleDetails.
+        :type resources: list[oci.resource_scheduler.models.Resource]
+
+        :param time_starts:
+            The value to assign to the time_starts property of this CreateScheduleDetails.
+        :type time_starts: datetime
+
+        :param time_ends:
+            The value to assign to the time_ends property of this CreateScheduleDetails.
+        :type time_ends: datetime
+
+        :param freeform_tags:
+            The value to assign to the freeform_tags property of this CreateScheduleDetails.
+        :type freeform_tags: dict(str, str)
+
+        :param defined_tags:
+            The value to assign to the defined_tags property of this CreateScheduleDetails.
+        :type defined_tags: dict(str, dict(str, object))
+
+        """
+        self.swagger_types = {
+            'compartment_id': 'str',
+            'display_name': 'str',
+            'description': 'str',
+            'action': 'str',
+            'recurrence_details': 'str',
+            'recurrence_type': 'str',
+            'resource_filters': 'list[ResourceFilter]',
+            'resources': 'list[Resource]',
+            'time_starts': 'datetime',
+            'time_ends': 'datetime',
+            'freeform_tags': 'dict(str, str)',
+            'defined_tags': 'dict(str, dict(str, object))'
+        }
+
+        self.attribute_map = {
+            'compartment_id': 'compartmentId',
+            'display_name': 'displayName',
+            'description': 'description',
+            'action': 'action',
+            'recurrence_details': 'recurrenceDetails',
+            'recurrence_type': 'recurrenceType',
+            'resource_filters': 'resourceFilters',
+            'resources': 'resources',
+            'time_starts': 'timeStarts',
+            'time_ends': 'timeEnds',
+            'freeform_tags': 'freeformTags',
+            'defined_tags': 'definedTags'
+        }
+
+        self._compartment_id = None
+        self._display_name = None
+        self._description = None
+        self._action = None
+        self._recurrence_details = None
+        self._recurrence_type = None
+        self._resource_filters = None
+        self._resources = None
+        self._time_starts = None
+        self._time_ends = None
+        self._freeform_tags = None
+        self._defined_tags = None
+
+    @property
+    def compartment_id(self):
+        """
+        **[Required]** Gets the compartment_id of this CreateScheduleDetails.
+        The `OCID`__ of the compartment in which the schedule is created
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :return: The compartment_id of this CreateScheduleDetails.
+        :rtype: str
+        """
+        return self._compartment_id
+
+    @compartment_id.setter
+    def compartment_id(self, compartment_id):
+        """
+        Sets the compartment_id of this CreateScheduleDetails.
+        The `OCID`__ of the compartment in which the schedule is created
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :param compartment_id: The compartment_id of this CreateScheduleDetails.
+        :type: str
+        """
+        self._compartment_id = compartment_id
+
+    @property
+    def display_name(self):
+        """
+        Gets the display_name of this CreateScheduleDetails.
+        This is a user-friendly name for the schedule. It does not have to be unique, and it's changeable.
+
+
+        :return: The display_name of this CreateScheduleDetails.
+        :rtype: str
+        """
+        return self._display_name
+
+    @display_name.setter
+    def display_name(self, display_name):
+        """
+        Sets the display_name of this CreateScheduleDetails.
+        This is a user-friendly name for the schedule. It does not have to be unique, and it's changeable.
+
+
+        :param display_name: The display_name of this CreateScheduleDetails.
+        :type: str
+        """
+        self._display_name = display_name
+
+    @property
+    def description(self):
+        """
+        Gets the description of this CreateScheduleDetails.
+        This is the description of the schedule.
+
+
+        :return: The description of this CreateScheduleDetails.
+        :rtype: str
+        """
+        return self._description
+
+    @description.setter
+    def description(self, description):
+        """
+        Sets the description of this CreateScheduleDetails.
+        This is the description of the schedule.
+
+
+        :param description: The description of this CreateScheduleDetails.
+        :type: str
+        """
+        self._description = description
+
+    @property
+    def action(self):
+        """
+        **[Required]** Gets the action of this CreateScheduleDetails.
+        This is the action that will be executed by the schedule.
+
+        Allowed values for this property are: "START_RESOURCE", "STOP_RESOURCE"
+
+
+        :return: The action of this CreateScheduleDetails.
+        :rtype: str
+        """
+        return self._action
+
+    @action.setter
+    def action(self, action):
+        """
+        Sets the action of this CreateScheduleDetails.
+        This is the action that will be executed by the schedule.
+
+
+        :param action: The action of this CreateScheduleDetails.
+        :type: str
+        """
+        allowed_values = ["START_RESOURCE", "STOP_RESOURCE"]
+        if not value_allowed_none_or_none_sentinel(action, allowed_values):
+            raise ValueError(
+                f"Invalid value for `action`, must be None or one of {allowed_values}"
+            )
+        self._action = action
+
+    @property
+    def recurrence_details(self):
+        """
+        **[Required]** Gets the recurrence_details of this CreateScheduleDetails.
+        This is the frequency of recurrence of a schedule. The frequency field can either conform to RFC-5545 formatting
+        or UNIX cron formatting for recurrences, based on the value specified by the recurrenceType field.
+
+
+        :return: The recurrence_details of this CreateScheduleDetails.
+        :rtype: str
+        """
+        return self._recurrence_details
+
+    @recurrence_details.setter
+    def recurrence_details(self, recurrence_details):
+        """
+        Sets the recurrence_details of this CreateScheduleDetails.
+        This is the frequency of recurrence of a schedule. The frequency field can either conform to RFC-5545 formatting
+        or UNIX cron formatting for recurrences, based on the value specified by the recurrenceType field.
+
+
+        :param recurrence_details: The recurrence_details of this CreateScheduleDetails.
+        :type: str
+        """
+        self._recurrence_details = recurrence_details
+
+    @property
+    def recurrence_type(self):
+        """
+        **[Required]** Gets the recurrence_type of this CreateScheduleDetails.
+        Type of recurrence of a schedule
+
+        Allowed values for this property are: "CRON", "ICAL"
+
+
+        :return: The recurrence_type of this CreateScheduleDetails.
+        :rtype: str
+        """
+        return self._recurrence_type
+
+    @recurrence_type.setter
+    def recurrence_type(self, recurrence_type):
+        """
+        Sets the recurrence_type of this CreateScheduleDetails.
+        Type of recurrence of a schedule
+
+
+        :param recurrence_type: The recurrence_type of this CreateScheduleDetails.
+        :type: str
+        """
+        allowed_values = ["CRON", "ICAL"]
+        if not value_allowed_none_or_none_sentinel(recurrence_type, allowed_values):
+            raise ValueError(
+                f"Invalid value for `recurrence_type`, must be None or one of {allowed_values}"
+            )
+        self._recurrence_type = recurrence_type
+
+    @property
+    def resource_filters(self):
+        """
+        Gets the resource_filters of this CreateScheduleDetails.
+        This is a list of resources filters.  The schedule will be applied to resources matching all of them.
+
+
+        :return: The resource_filters of this CreateScheduleDetails.
+        :rtype: list[oci.resource_scheduler.models.ResourceFilter]
+        """
+        return self._resource_filters
+
+    @resource_filters.setter
+    def resource_filters(self, resource_filters):
+        """
+        Sets the resource_filters of this CreateScheduleDetails.
+        This is a list of resources filters.  The schedule will be applied to resources matching all of them.
+
+
+        :param resource_filters: The resource_filters of this CreateScheduleDetails.
+        :type: list[oci.resource_scheduler.models.ResourceFilter]
+        """
+        self._resource_filters = resource_filters
+
+    @property
+    def resources(self):
+        """
+        Gets the resources of this CreateScheduleDetails.
+        This is the list of resources to which the scheduled operation is applied.
+
+
+        :return: The resources of this CreateScheduleDetails.
+        :rtype: list[oci.resource_scheduler.models.Resource]
+        """
+        return self._resources
+
+    @resources.setter
+    def resources(self, resources):
+        """
+        Sets the resources of this CreateScheduleDetails.
+        This is the list of resources to which the scheduled operation is applied.
+
+
+        :param resources: The resources of this CreateScheduleDetails.
+        :type: list[oci.resource_scheduler.models.Resource]
+        """
+        self._resources = resources
+
+    @property
+    def time_starts(self):
+        """
+        Gets the time_starts of this CreateScheduleDetails.
+        This is the date and time the schedule starts, in the format defined by `RFC 3339`__
+
+        Example: `2016-08-25T21:10:29.600Z`
+
+        __ https://tools.ietf.org/html/rfc3339
+
+
+        :return: The time_starts of this CreateScheduleDetails.
+        :rtype: datetime
+        """
+        return self._time_starts
+
+    @time_starts.setter
+    def time_starts(self, time_starts):
+        """
+        Sets the time_starts of this CreateScheduleDetails.
+        This is the date and time the schedule starts, in the format defined by `RFC 3339`__
+
+        Example: `2016-08-25T21:10:29.600Z`
+
+        __ https://tools.ietf.org/html/rfc3339
+
+
+        :param time_starts: The time_starts of this CreateScheduleDetails.
+        :type: datetime
+        """
+        self._time_starts = time_starts
+
+    @property
+    def time_ends(self):
+        """
+        Gets the time_ends of this CreateScheduleDetails.
+        This is the date and time the schedule ends, in the format defined by `RFC 3339`__
+
+        Example: `2016-08-25T21:10:29.600Z`
+
+        __ https://tools.ietf.org/html/rfc3339
+
+
+        :return: The time_ends of this CreateScheduleDetails.
+        :rtype: datetime
+        """
+        return self._time_ends
+
+    @time_ends.setter
+    def time_ends(self, time_ends):
+        """
+        Sets the time_ends of this CreateScheduleDetails.
+        This is the date and time the schedule ends, in the format defined by `RFC 3339`__
+
+        Example: `2016-08-25T21:10:29.600Z`
+
+        __ https://tools.ietf.org/html/rfc3339
+
+
+        :param time_ends: The time_ends of this CreateScheduleDetails.
+        :type: datetime
+        """
+        self._time_ends = time_ends
+
+    @property
+    def freeform_tags(self):
+        """
+        Gets the freeform_tags of this CreateScheduleDetails.
+        These are 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 CreateScheduleDetails.
+        :rtype: dict(str, str)
+        """
+        return self._freeform_tags
+
+    @freeform_tags.setter
+    def freeform_tags(self, freeform_tags):
+        """
+        Sets the freeform_tags of this CreateScheduleDetails.
+        These are 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 CreateScheduleDetails.
+        :type: dict(str, str)
+        """
+        self._freeform_tags = freeform_tags
+
+    @property
+    def defined_tags(self):
+        """
+        Gets the defined_tags of this CreateScheduleDetails.
+        These are 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 CreateScheduleDetails.
+        :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 CreateScheduleDetails.
+        These are 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 CreateScheduleDetails.
+        :type: dict(str, dict(str, object))
+        """
+        self._defined_tags = defined_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