oci 2.149.0__py3-none-any.whl → 2.149.2__py3-none-any.whl

oci/data_science/models/ml_application_implementation.py

@@ -0,0 +1,666 @@
+# 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: 20190101
+
+
+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 MlApplicationImplementation(object):
+    """
+    Resource representing solution for AI/ML use-case defined by ML Application
+    """
+
+    #: A constant which can be used with the lifecycle_state property of a MlApplicationImplementation.
+    #: This constant has a value of "CREATING"
+    LIFECYCLE_STATE_CREATING = "CREATING"
+
+    #: A constant which can be used with the lifecycle_state property of a MlApplicationImplementation.
+    #: This constant has a value of "ACTIVE"
+    LIFECYCLE_STATE_ACTIVE = "ACTIVE"
+
+    #: A constant which can be used with the lifecycle_state property of a MlApplicationImplementation.
+    #: This constant has a value of "NEEDS_ATTENTION"
+    LIFECYCLE_STATE_NEEDS_ATTENTION = "NEEDS_ATTENTION"
+
+    #: A constant which can be used with the lifecycle_state property of a MlApplicationImplementation.
+    #: This constant has a value of "FAILED"
+    LIFECYCLE_STATE_FAILED = "FAILED"
+
+    #: A constant which can be used with the lifecycle_state property of a MlApplicationImplementation.
+    #: This constant has a value of "DELETING"
+    LIFECYCLE_STATE_DELETING = "DELETING"
+
+    #: A constant which can be used with the lifecycle_state property of a MlApplicationImplementation.
+    #: This constant has a value of "UPDATING"
+    LIFECYCLE_STATE_UPDATING = "UPDATING"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new MlApplicationImplementation 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 MlApplicationImplementation.
+        :type id: str
+
+        :param name:
+            The value to assign to the name property of this MlApplicationImplementation.
+        :type name: str
+
+        :param description:
+            The value to assign to the description property of this MlApplicationImplementation.
+        :type description: str
+
+        :param ml_application_id:
+            The value to assign to the ml_application_id property of this MlApplicationImplementation.
+        :type ml_application_id: str
+
+        :param ml_application_name:
+            The value to assign to the ml_application_name property of this MlApplicationImplementation.
+        :type ml_application_name: str
+
+        :param package_version:
+            The value to assign to the package_version property of this MlApplicationImplementation.
+        :type package_version: str
+
+        :param application_components:
+            The value to assign to the application_components property of this MlApplicationImplementation.
+        :type application_components: list[oci.data_science.models.ApplicationComponent]
+
+        :param configuration_schema:
+            The value to assign to the configuration_schema property of this MlApplicationImplementation.
+        :type configuration_schema: list[oci.data_science.models.ConfigurationPropertySchema]
+
+        :param ml_application_package_arguments:
+            The value to assign to the ml_application_package_arguments property of this MlApplicationImplementation.
+        :type ml_application_package_arguments: oci.data_science.models.MlApplicationPackageArguments
+
+        :param allowed_migration_destinations:
+            The value to assign to the allowed_migration_destinations property of this MlApplicationImplementation.
+        :type allowed_migration_destinations: list[str]
+
+        :param logging:
+            The value to assign to the logging property of this MlApplicationImplementation.
+        :type logging: oci.data_science.models.ImplementationLogging
+
+        :param compartment_id:
+            The value to assign to the compartment_id property of this MlApplicationImplementation.
+        :type compartment_id: str
+
+        :param time_created:
+            The value to assign to the time_created property of this MlApplicationImplementation.
+        :type time_created: datetime
+
+        :param time_updated:
+            The value to assign to the time_updated property of this MlApplicationImplementation.
+        :type time_updated: datetime
+
+        :param lifecycle_state:
+            The value to assign to the lifecycle_state property of this MlApplicationImplementation.
+            Allowed values for this property are: "CREATING", "ACTIVE", "NEEDS_ATTENTION", "FAILED", "DELETING", "UPDATING", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type lifecycle_state: str
+
+        :param lifecycle_details:
+            The value to assign to the lifecycle_details property of this MlApplicationImplementation.
+        :type lifecycle_details: str
+
+        :param freeform_tags:
+            The value to assign to the freeform_tags property of this MlApplicationImplementation.
+        :type freeform_tags: dict(str, str)
+
+        :param defined_tags:
+            The value to assign to the defined_tags property of this MlApplicationImplementation.
+        :type defined_tags: dict(str, dict(str, object))
+
+        :param system_tags:
+            The value to assign to the system_tags property of this MlApplicationImplementation.
+        :type system_tags: dict(str, dict(str, object))
+
+        """
+        self.swagger_types = {
+            'id': 'str',
+            'name': 'str',
+            'description': 'str',
+            'ml_application_id': 'str',
+            'ml_application_name': 'str',
+            'package_version': 'str',
+            'application_components': 'list[ApplicationComponent]',
+            'configuration_schema': 'list[ConfigurationPropertySchema]',
+            'ml_application_package_arguments': 'MlApplicationPackageArguments',
+            'allowed_migration_destinations': 'list[str]',
+            'logging': 'ImplementationLogging',
+            'compartment_id': 'str',
+            'time_created': 'datetime',
+            'time_updated': 'datetime',
+            'lifecycle_state': 'str',
+            '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',
+            'name': 'name',
+            'description': 'description',
+            'ml_application_id': 'mlApplicationId',
+            'ml_application_name': 'mlApplicationName',
+            'package_version': 'packageVersion',
+            'application_components': 'applicationComponents',
+            'configuration_schema': 'configurationSchema',
+            'ml_application_package_arguments': 'mlApplicationPackageArguments',
+            'allowed_migration_destinations': 'allowedMigrationDestinations',
+            'logging': 'logging',
+            'compartment_id': 'compartmentId',
+            'time_created': 'timeCreated',
+            'time_updated': 'timeUpdated',
+            'lifecycle_state': 'lifecycleState',
+            'lifecycle_details': 'lifecycleDetails',
+            'freeform_tags': 'freeformTags',
+            'defined_tags': 'definedTags',
+            'system_tags': 'systemTags'
+        }
+        self._id = None
+        self._name = None
+        self._description = None
+        self._ml_application_id = None
+        self._ml_application_name = None
+        self._package_version = None
+        self._application_components = None
+        self._configuration_schema = None
+        self._ml_application_package_arguments = None
+        self._allowed_migration_destinations = None
+        self._logging = None
+        self._compartment_id = None
+        self._time_created = None
+        self._time_updated = None
+        self._lifecycle_state = 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 MlApplicationImplementation.
+        The OCID of the MlApplicationImplementation. Unique identifier that is immutable after creation.
+
+
+        :return: The id of this MlApplicationImplementation.
+        :rtype: str
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """
+        Sets the id of this MlApplicationImplementation.
+        The OCID of the MlApplicationImplementation. Unique identifier that is immutable after creation.
+
+
+        :param id: The id of this MlApplicationImplementation.
+        :type: str
+        """
+        self._id = id
+
+    @property
+    def name(self):
+        """
+        **[Required]** Gets the name of this MlApplicationImplementation.
+        ML Application Implementation name which is unique for given ML Application.
+
+
+        :return: The name of this MlApplicationImplementation.
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """
+        Sets the name of this MlApplicationImplementation.
+        ML Application Implementation name which is unique for given ML Application.
+
+
+        :param name: The name of this MlApplicationImplementation.
+        :type: str
+        """
+        self._name = name
+
+    @property
+    def description(self):
+        """
+        Gets the description of this MlApplicationImplementation.
+        Description of ML Application Implementation defined in ML Application package descriptor
+
+
+        :return: The description of this MlApplicationImplementation.
+        :rtype: str
+        """
+        return self._description
+
+    @description.setter
+    def description(self, description):
+        """
+        Sets the description of this MlApplicationImplementation.
+        Description of ML Application Implementation defined in ML Application package descriptor
+
+
+        :param description: The description of this MlApplicationImplementation.
+        :type: str
+        """
+        self._description = description
+
+    @property
+    def ml_application_id(self):
+        """
+        **[Required]** Gets the ml_application_id of this MlApplicationImplementation.
+        The OCID of the ML Application implemented by this ML Application Implementation.
+
+
+        :return: The ml_application_id of this MlApplicationImplementation.
+        :rtype: str
+        """
+        return self._ml_application_id
+
+    @ml_application_id.setter
+    def ml_application_id(self, ml_application_id):
+        """
+        Sets the ml_application_id of this MlApplicationImplementation.
+        The OCID of the ML Application implemented by this ML Application Implementation.
+
+
+        :param ml_application_id: The ml_application_id of this MlApplicationImplementation.
+        :type: str
+        """
+        self._ml_application_id = ml_application_id
+
+    @property
+    def ml_application_name(self):
+        """
+        **[Required]** Gets the ml_application_name of this MlApplicationImplementation.
+        The name of ML Application (based on mlApplicationId)
+
+
+        :return: The ml_application_name of this MlApplicationImplementation.
+        :rtype: str
+        """
+        return self._ml_application_name
+
+    @ml_application_name.setter
+    def ml_application_name(self, ml_application_name):
+        """
+        Sets the ml_application_name of this MlApplicationImplementation.
+        The name of ML Application (based on mlApplicationId)
+
+
+        :param ml_application_name: The ml_application_name of this MlApplicationImplementation.
+        :type: str
+        """
+        self._ml_application_name = ml_application_name
+
+    @property
+    def package_version(self):
+        """
+        Gets the package_version of this MlApplicationImplementation.
+        The version of ML Application Package (e.g. \"1.2\" or \"2.0.4\") defined in ML Application package descriptor. Value is not mandatory only for CREATING state otherwise it must be always presented.
+
+
+        :return: The package_version of this MlApplicationImplementation.
+        :rtype: str
+        """
+        return self._package_version
+
+    @package_version.setter
+    def package_version(self, package_version):
+        """
+        Sets the package_version of this MlApplicationImplementation.
+        The version of ML Application Package (e.g. \"1.2\" or \"2.0.4\") defined in ML Application package descriptor. Value is not mandatory only for CREATING state otherwise it must be always presented.
+
+
+        :param package_version: The package_version of this MlApplicationImplementation.
+        :type: str
+        """
+        self._package_version = package_version
+
+    @property
+    def application_components(self):
+        """
+        Gets the application_components of this MlApplicationImplementation.
+        List of application components (OCI resources shared for all MlApplicationInstances). These have been created automatically based on their definitions in the ML Application package.
+
+
+        :return: The application_components of this MlApplicationImplementation.
+        :rtype: list[oci.data_science.models.ApplicationComponent]
+        """
+        return self._application_components
+
+    @application_components.setter
+    def application_components(self, application_components):
+        """
+        Sets the application_components of this MlApplicationImplementation.
+        List of application components (OCI resources shared for all MlApplicationInstances). These have been created automatically based on their definitions in the ML Application package.
+
+
+        :param application_components: The application_components of this MlApplicationImplementation.
+        :type: list[oci.data_science.models.ApplicationComponent]
+        """
+        self._application_components = application_components
+
+    @property
+    def configuration_schema(self):
+        """
+        Gets the configuration_schema of this MlApplicationImplementation.
+        Schema of configuration which needs to be provided for each ML Application Instance. It is defined in the ML Application package descriptor.
+
+
+        :return: The configuration_schema of this MlApplicationImplementation.
+        :rtype: list[oci.data_science.models.ConfigurationPropertySchema]
+        """
+        return self._configuration_schema
+
+    @configuration_schema.setter
+    def configuration_schema(self, configuration_schema):
+        """
+        Sets the configuration_schema of this MlApplicationImplementation.
+        Schema of configuration which needs to be provided for each ML Application Instance. It is defined in the ML Application package descriptor.
+
+
+        :param configuration_schema: The configuration_schema of this MlApplicationImplementation.
+        :type: list[oci.data_science.models.ConfigurationPropertySchema]
+        """
+        self._configuration_schema = configuration_schema
+
+    @property
+    def ml_application_package_arguments(self):
+        """
+        Gets the ml_application_package_arguments of this MlApplicationImplementation.
+
+        :return: The ml_application_package_arguments of this MlApplicationImplementation.
+        :rtype: oci.data_science.models.MlApplicationPackageArguments
+        """
+        return self._ml_application_package_arguments
+
+    @ml_application_package_arguments.setter
+    def ml_application_package_arguments(self, ml_application_package_arguments):
+        """
+        Sets the ml_application_package_arguments of this MlApplicationImplementation.
+
+        :param ml_application_package_arguments: The ml_application_package_arguments of this MlApplicationImplementation.
+        :type: oci.data_science.models.MlApplicationPackageArguments
+        """
+        self._ml_application_package_arguments = ml_application_package_arguments
+
+    @property
+    def allowed_migration_destinations(self):
+        """
+        Gets the allowed_migration_destinations of this MlApplicationImplementation.
+        List of ML Application Implementation OCIDs for which migration from this implementation is allowed. Migration means that if consumers change implementation for their instances to implementation with OCID from this list, instance components will be updated in place otherwise new instance components are created based on the new implementation and old instance components are removed.
+
+
+        :return: The allowed_migration_destinations of this MlApplicationImplementation.
+        :rtype: list[str]
+        """
+        return self._allowed_migration_destinations
+
+    @allowed_migration_destinations.setter
+    def allowed_migration_destinations(self, allowed_migration_destinations):
+        """
+        Sets the allowed_migration_destinations of this MlApplicationImplementation.
+        List of ML Application Implementation OCIDs for which migration from this implementation is allowed. Migration means that if consumers change implementation for their instances to implementation with OCID from this list, instance components will be updated in place otherwise new instance components are created based on the new implementation and old instance components are removed.
+
+
+        :param allowed_migration_destinations: The allowed_migration_destinations of this MlApplicationImplementation.
+        :type: list[str]
+        """
+        self._allowed_migration_destinations = allowed_migration_destinations
+
+    @property
+    def logging(self):
+        """
+        Gets the logging of this MlApplicationImplementation.
+
+        :return: The logging of this MlApplicationImplementation.
+        :rtype: oci.data_science.models.ImplementationLogging
+        """
+        return self._logging
+
+    @logging.setter
+    def logging(self, logging):
+        """
+        Sets the logging of this MlApplicationImplementation.
+
+        :param logging: The logging of this MlApplicationImplementation.
+        :type: oci.data_science.models.ImplementationLogging
+        """
+        self._logging = logging
+
+    @property
+    def compartment_id(self):
+        """
+        **[Required]** Gets the compartment_id of this MlApplicationImplementation.
+        The OCID of the compartment where ML Application Implementation is created.
+
+
+        :return: The compartment_id of this MlApplicationImplementation.
+        :rtype: str
+        """
+        return self._compartment_id
+
+    @compartment_id.setter
+    def compartment_id(self, compartment_id):
+        """
+        Sets the compartment_id of this MlApplicationImplementation.
+        The OCID of the compartment where ML Application Implementation is created.
+
+
+        :param compartment_id: The compartment_id of this MlApplicationImplementation.
+        :type: str
+        """
+        self._compartment_id = compartment_id
+
+    @property
+    def time_created(self):
+        """
+        **[Required]** Gets the time_created of this MlApplicationImplementation.
+        Creation time of MlApplicationImplementation creation in the format defined by RFC 3339.
+
+
+        :return: The time_created of this MlApplicationImplementation.
+        :rtype: datetime
+        """
+        return self._time_created
+
+    @time_created.setter
+    def time_created(self, time_created):
+        """
+        Sets the time_created of this MlApplicationImplementation.
+        Creation time of MlApplicationImplementation creation in the format defined by RFC 3339.
+
+
+        :param time_created: The time_created of this MlApplicationImplementation.
+        :type: datetime
+        """
+        self._time_created = time_created
+
+    @property
+    def time_updated(self):
+        """
+        **[Required]** Gets the time_updated of this MlApplicationImplementation.
+        Time of last MlApplicationImplementation update in the format defined by RFC 3339.
+
+
+        :return: The time_updated of this MlApplicationImplementation.
+        :rtype: datetime
+        """
+        return self._time_updated
+
+    @time_updated.setter
+    def time_updated(self, time_updated):
+        """
+        Sets the time_updated of this MlApplicationImplementation.
+        Time of last MlApplicationImplementation update in the format defined by RFC 3339.
+
+
+        :param time_updated: The time_updated of this MlApplicationImplementation.
+        :type: datetime
+        """
+        self._time_updated = time_updated
+
+    @property
+    def lifecycle_state(self):
+        """
+        **[Required]** Gets the lifecycle_state of this MlApplicationImplementation.
+        The current state of the MlApplicationImplementation.
+
+        Allowed values for this property are: "CREATING", "ACTIVE", "NEEDS_ATTENTION", "FAILED", "DELETING", "UPDATING", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The lifecycle_state of this MlApplicationImplementation.
+        :rtype: str
+        """
+        return self._lifecycle_state
+
+    @lifecycle_state.setter
+    def lifecycle_state(self, lifecycle_state):
+        """
+        Sets the lifecycle_state of this MlApplicationImplementation.
+        The current state of the MlApplicationImplementation.
+
+
+        :param lifecycle_state: The lifecycle_state of this MlApplicationImplementation.
+        :type: str
+        """
+        allowed_values = ["CREATING", "ACTIVE", "NEEDS_ATTENTION", "FAILED", "DELETING", "UPDATING"]
+        if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values):
+            lifecycle_state = 'UNKNOWN_ENUM_VALUE'
+        self._lifecycle_state = lifecycle_state
+
+    @property
+    def lifecycle_details(self):
+        """
+        **[Required]** Gets the lifecycle_details of this MlApplicationImplementation.
+        A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
+
+
+        :return: The lifecycle_details of this MlApplicationImplementation.
+        :rtype: str
+        """
+        return self._lifecycle_details
+
+    @lifecycle_details.setter
+    def lifecycle_details(self, lifecycle_details):
+        """
+        Sets the lifecycle_details of this MlApplicationImplementation.
+        A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
+
+
+        :param lifecycle_details: The lifecycle_details of this MlApplicationImplementation.
+        :type: str
+        """
+        self._lifecycle_details = lifecycle_details
+
+    @property
+    def freeform_tags(self):
+        """
+        **[Required]** Gets the freeform_tags of this MlApplicationImplementation.
+        Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See `Resource Tags`__.
+        Example: `{\"Department\": \"Finance\"}`
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
+
+
+        :return: The freeform_tags of this MlApplicationImplementation.
+        :rtype: dict(str, str)
+        """
+        return self._freeform_tags
+
+    @freeform_tags.setter
+    def freeform_tags(self, freeform_tags):
+        """
+        Sets the freeform_tags of this MlApplicationImplementation.
+        Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See `Resource Tags`__.
+        Example: `{\"Department\": \"Finance\"}`
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
+
+
+        :param freeform_tags: The freeform_tags of this MlApplicationImplementation.
+        :type: dict(str, str)
+        """
+        self._freeform_tags = freeform_tags
+
+    @property
+    def defined_tags(self):
+        """
+        **[Required]** Gets the defined_tags of this MlApplicationImplementation.
+        Defined tags for this resource. Each key is predefined and scoped to a namespace. See `Resource Tags`__.
+        Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
+
+
+        :return: The defined_tags of this MlApplicationImplementation.
+        :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 MlApplicationImplementation.
+        Defined tags for this resource. Each key is predefined and scoped to a namespace. See `Resource Tags`__.
+        Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
+
+
+        :param defined_tags: The defined_tags of this MlApplicationImplementation.
+        :type: dict(str, dict(str, object))
+        """
+        self._defined_tags = defined_tags
+
+    @property
+    def system_tags(self):
+        """
+        Gets the system_tags of this MlApplicationImplementation.
+        Usage of system tag keys. These predefined keys are scoped to namespaces.
+        Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
+
+
+        :return: The system_tags of this MlApplicationImplementation.
+        :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 MlApplicationImplementation.
+        Usage of system tag keys. These predefined keys are scoped to namespaces.
+        Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
+
+
+        :param system_tags: The system_tags of this MlApplicationImplementation.
+        :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