File: //lib/mysqlsh/lib/python3.8/site-packages/oci/data_science/models/update_model_details.py
# 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 UpdateModelDetails(object):
"""
Details for updating a model.
"""
def __init__(self, **kwargs):
"""
Initializes a new UpdateModelDetails object with values from keyword arguments.
The following keyword arguments are supported (corresponding to the getters/setters of this class):
:param display_name:
The value to assign to the display_name property of this UpdateModelDetails.
:type display_name: str
:param description:
The value to assign to the description property of this UpdateModelDetails.
:type description: str
:param freeform_tags:
The value to assign to the freeform_tags property of this UpdateModelDetails.
:type freeform_tags: dict(str, str)
:param defined_tags:
The value to assign to the defined_tags property of this UpdateModelDetails.
:type defined_tags: dict(str, dict(str, object))
:param custom_metadata_list:
The value to assign to the custom_metadata_list property of this UpdateModelDetails.
:type custom_metadata_list: list[oci.data_science.models.Metadata]
:param defined_metadata_list:
The value to assign to the defined_metadata_list property of this UpdateModelDetails.
:type defined_metadata_list: list[oci.data_science.models.Metadata]
:param model_version_set_id:
The value to assign to the model_version_set_id property of this UpdateModelDetails.
:type model_version_set_id: str
:param version_label:
The value to assign to the version_label property of this UpdateModelDetails.
:type version_label: str
:param retention_setting:
The value to assign to the retention_setting property of this UpdateModelDetails.
:type retention_setting: oci.data_science.models.RetentionSetting
:param backup_setting:
The value to assign to the backup_setting property of this UpdateModelDetails.
:type backup_setting: oci.data_science.models.BackupSetting
"""
self.swagger_types = {
'display_name': 'str',
'description': 'str',
'freeform_tags': 'dict(str, str)',
'defined_tags': 'dict(str, dict(str, object))',
'custom_metadata_list': 'list[Metadata]',
'defined_metadata_list': 'list[Metadata]',
'model_version_set_id': 'str',
'version_label': 'str',
'retention_setting': 'RetentionSetting',
'backup_setting': 'BackupSetting'
}
self.attribute_map = {
'display_name': 'displayName',
'description': 'description',
'freeform_tags': 'freeformTags',
'defined_tags': 'definedTags',
'custom_metadata_list': 'customMetadataList',
'defined_metadata_list': 'definedMetadataList',
'model_version_set_id': 'modelVersionSetId',
'version_label': 'versionLabel',
'retention_setting': 'retentionSetting',
'backup_setting': 'backupSetting'
}
self._display_name = None
self._description = None
self._freeform_tags = None
self._defined_tags = None
self._custom_metadata_list = None
self._defined_metadata_list = None
self._model_version_set_id = None
self._version_label = None
self._retention_setting = None
self._backup_setting = None
@property
def display_name(self):
"""
Gets the display_name of this UpdateModelDetails.
A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
Example: `My Model`
:return: The display_name of this UpdateModelDetails.
:rtype: str
"""
return self._display_name
@display_name.setter
def display_name(self, display_name):
"""
Sets the display_name of this UpdateModelDetails.
A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
Example: `My Model`
:param display_name: The display_name of this UpdateModelDetails.
:type: str
"""
self._display_name = display_name
@property
def description(self):
"""
Gets the description of this UpdateModelDetails.
A short description of the model.
:return: The description of this UpdateModelDetails.
:rtype: str
"""
return self._description
@description.setter
def description(self, description):
"""
Sets the description of this UpdateModelDetails.
A short description of the model.
:param description: The description of this UpdateModelDetails.
:type: str
"""
self._description = description
@property
def freeform_tags(self):
"""
Gets the freeform_tags of this UpdateModelDetails.
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 UpdateModelDetails.
:rtype: dict(str, str)
"""
return self._freeform_tags
@freeform_tags.setter
def freeform_tags(self, freeform_tags):
"""
Sets the freeform_tags of this UpdateModelDetails.
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 UpdateModelDetails.
:type: dict(str, str)
"""
self._freeform_tags = freeform_tags
@property
def defined_tags(self):
"""
Gets the defined_tags of this UpdateModelDetails.
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 UpdateModelDetails.
: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 UpdateModelDetails.
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 UpdateModelDetails.
:type: dict(str, dict(str, object))
"""
self._defined_tags = defined_tags
@property
def custom_metadata_list(self):
"""
Gets the custom_metadata_list of this UpdateModelDetails.
An array of custom metadata details for the model.
:return: The custom_metadata_list of this UpdateModelDetails.
:rtype: list[oci.data_science.models.Metadata]
"""
return self._custom_metadata_list
@custom_metadata_list.setter
def custom_metadata_list(self, custom_metadata_list):
"""
Sets the custom_metadata_list of this UpdateModelDetails.
An array of custom metadata details for the model.
:param custom_metadata_list: The custom_metadata_list of this UpdateModelDetails.
:type: list[oci.data_science.models.Metadata]
"""
self._custom_metadata_list = custom_metadata_list
@property
def defined_metadata_list(self):
"""
Gets the defined_metadata_list of this UpdateModelDetails.
An array of defined metadata details for the model.
:return: The defined_metadata_list of this UpdateModelDetails.
:rtype: list[oci.data_science.models.Metadata]
"""
return self._defined_metadata_list
@defined_metadata_list.setter
def defined_metadata_list(self, defined_metadata_list):
"""
Sets the defined_metadata_list of this UpdateModelDetails.
An array of defined metadata details for the model.
:param defined_metadata_list: The defined_metadata_list of this UpdateModelDetails.
:type: list[oci.data_science.models.Metadata]
"""
self._defined_metadata_list = defined_metadata_list
@property
def model_version_set_id(self):
"""
Gets the model_version_set_id of this UpdateModelDetails.
The OCID of the model version set that the model is associated to.
:return: The model_version_set_id of this UpdateModelDetails.
:rtype: str
"""
return self._model_version_set_id
@model_version_set_id.setter
def model_version_set_id(self, model_version_set_id):
"""
Sets the model_version_set_id of this UpdateModelDetails.
The OCID of the model version set that the model is associated to.
:param model_version_set_id: The model_version_set_id of this UpdateModelDetails.
:type: str
"""
self._model_version_set_id = model_version_set_id
@property
def version_label(self):
"""
Gets the version_label of this UpdateModelDetails.
The version label can add an additional description of the lifecycle state of the model or the application using/training the model.
:return: The version_label of this UpdateModelDetails.
:rtype: str
"""
return self._version_label
@version_label.setter
def version_label(self, version_label):
"""
Sets the version_label of this UpdateModelDetails.
The version label can add an additional description of the lifecycle state of the model or the application using/training the model.
:param version_label: The version_label of this UpdateModelDetails.
:type: str
"""
self._version_label = version_label
@property
def retention_setting(self):
"""
Gets the retention_setting of this UpdateModelDetails.
:return: The retention_setting of this UpdateModelDetails.
:rtype: oci.data_science.models.RetentionSetting
"""
return self._retention_setting
@retention_setting.setter
def retention_setting(self, retention_setting):
"""
Sets the retention_setting of this UpdateModelDetails.
:param retention_setting: The retention_setting of this UpdateModelDetails.
:type: oci.data_science.models.RetentionSetting
"""
self._retention_setting = retention_setting
@property
def backup_setting(self):
"""
Gets the backup_setting of this UpdateModelDetails.
:return: The backup_setting of this UpdateModelDetails.
:rtype: oci.data_science.models.BackupSetting
"""
return self._backup_setting
@backup_setting.setter
def backup_setting(self, backup_setting):
"""
Sets the backup_setting of this UpdateModelDetails.
:param backup_setting: The backup_setting of this UpdateModelDetails.
:type: oci.data_science.models.BackupSetting
"""
self._backup_setting = backup_setting
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