RecommendationDetails¶

class oci.data_catalog.models.RecommendationDetails(**kwargs)¶

Bases: object

Details of a recommendation.

Attributes

`RECOMMENDATION_STATUS_ACCEPTED`	A constant which can be used with the recommendation_status property of a RecommendationDetails.
`RECOMMENDATION_STATUS_INFERRED`	A constant which can be used with the recommendation_status property of a RecommendationDetails.
`RECOMMENDATION_STATUS_REJECTED`	A constant which can be used with the recommendation_status property of a RecommendationDetails.
`RECOMMENDATION_TYPE_LINK_GLOSSARY_TERM`	A constant which can be used with the recommendation_type property of a RecommendationDetails.
`SOURCE_OBJECT_TYPE_ATTRIBUTE`	A constant which can be used with the source_object_type property of a RecommendationDetails.
`SOURCE_OBJECT_TYPE_CATEGORY`	A constant which can be used with the source_object_type property of a RecommendationDetails.
`SOURCE_OBJECT_TYPE_DATA_ENTITY`	A constant which can be used with the source_object_type property of a RecommendationDetails.
`SOURCE_OBJECT_TYPE_TERM`	A constant which can be used with the source_object_type property of a RecommendationDetails.
`TARGET_OBJECT_TYPE_ATTRIBUTE`	A constant which can be used with the target_object_type property of a RecommendationDetails.
`TARGET_OBJECT_TYPE_CATEGORY`	A constant which can be used with the target_object_type property of a RecommendationDetails.
`TARGET_OBJECT_TYPE_DATA_ENTITY`	A constant which can be used with the target_object_type property of a RecommendationDetails.
`TARGET_OBJECT_TYPE_TERM`	A constant which can be used with the target_object_type property of a RecommendationDetails.
`confidence_score`	Gets the confidence_score of this RecommendationDetails.
`properties`	Gets the properties of this RecommendationDetails.
`recommendation_key`	[Required] Gets the recommendation_key of this RecommendationDetails.
`recommendation_status`	[Required] Gets the recommendation_status of this RecommendationDetails.
`recommendation_type`	[Required] Gets the recommendation_type of this RecommendationDetails.
`source_object_key`	Gets the source_object_key of this RecommendationDetails.
`source_object_name`	Gets the source_object_name of this RecommendationDetails.
`source_object_type`	Gets the source_object_type of this RecommendationDetails.
`target_object_key`	Gets the target_object_key of this RecommendationDetails.
`target_object_name`	Gets the target_object_name of this RecommendationDetails.
`target_object_type`	Gets the target_object_type of this RecommendationDetails.

Methods

__init__(**kwargs) Initializes a new RecommendationDetails object with values from keyword arguments.

RECOMMENDATION_STATUS_ACCEPTED = 'ACCEPTED'¶: A constant which can be used with the recommendation_status property of a RecommendationDetails. This constant has a value of “ACCEPTED”

RECOMMENDATION_STATUS_INFERRED = 'INFERRED'¶: A constant which can be used with the recommendation_status property of a RecommendationDetails. This constant has a value of “INFERRED”

RECOMMENDATION_STATUS_REJECTED = 'REJECTED'¶: A constant which can be used with the recommendation_status property of a RecommendationDetails. This constant has a value of “REJECTED”

RECOMMENDATION_TYPE_LINK_GLOSSARY_TERM = 'LINK_GLOSSARY_TERM'¶: A constant which can be used with the recommendation_type property of a RecommendationDetails. This constant has a value of “LINK_GLOSSARY_TERM”

SOURCE_OBJECT_TYPE_ATTRIBUTE = 'ATTRIBUTE'¶: A constant which can be used with the source_object_type property of a RecommendationDetails. This constant has a value of “ATTRIBUTE”

SOURCE_OBJECT_TYPE_CATEGORY = 'CATEGORY'¶: A constant which can be used with the source_object_type property of a RecommendationDetails. This constant has a value of “CATEGORY”

SOURCE_OBJECT_TYPE_DATA_ENTITY = 'DATA_ENTITY'¶: A constant which can be used with the source_object_type property of a RecommendationDetails. This constant has a value of “DATA_ENTITY”

SOURCE_OBJECT_TYPE_TERM = 'TERM'¶: A constant which can be used with the source_object_type property of a RecommendationDetails. This constant has a value of “TERM”

TARGET_OBJECT_TYPE_ATTRIBUTE = 'ATTRIBUTE'¶: A constant which can be used with the target_object_type property of a RecommendationDetails. This constant has a value of “ATTRIBUTE”

TARGET_OBJECT_TYPE_CATEGORY = 'CATEGORY'¶: A constant which can be used with the target_object_type property of a RecommendationDetails. This constant has a value of “CATEGORY”

TARGET_OBJECT_TYPE_DATA_ENTITY = 'DATA_ENTITY'¶: A constant which can be used with the target_object_type property of a RecommendationDetails. This constant has a value of “DATA_ENTITY”

TARGET_OBJECT_TYPE_TERM = 'TERM'¶: A constant which can be used with the target_object_type property of a RecommendationDetails. This constant has a value of “TERM”

__init__(**kwargs)¶

Initializes a new RecommendationDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

recommendation_key (str) – The value to assign to the recommendation_key property of this RecommendationDetails.
recommendation_type (str) – The value to assign to the recommendation_type property of this RecommendationDetails. Allowed values for this property are: “LINK_GLOSSARY_TERM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
recommendation_status (str) – The value to assign to the recommendation_status property of this RecommendationDetails. Allowed values for this property are: “ACCEPTED”, “REJECTED”, “INFERRED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
confidence_score (float) – The value to assign to the confidence_score property of this RecommendationDetails.
source_object_key (str) – The value to assign to the source_object_key property of this RecommendationDetails.
source_object_name (str) – The value to assign to the source_object_name property of this RecommendationDetails.
source_object_type (str) – The value to assign to the source_object_type property of this RecommendationDetails. Allowed values for this property are: “DATA_ENTITY”, “ATTRIBUTE”, “TERM”, “CATEGORY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
target_object_key (str) – The value to assign to the target_object_key property of this RecommendationDetails.
target_object_name (str) – The value to assign to the target_object_name property of this RecommendationDetails.
target_object_type (str) – The value to assign to the target_object_type property of this RecommendationDetails. Allowed values for this property are: “DATA_ENTITY”, “ATTRIBUTE”, “TERM”, “CATEGORY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
properties (dict(str, dict(str, str))) – The value to assign to the properties property of this RecommendationDetails.

confidence_score¶

Gets the confidence_score of this RecommendationDetails. Level of confidence, on a scale between 0 and 1, that the recommendation is applicable.

Returns:	The confidence_score of this RecommendationDetails.
Return type:	float

properties¶

Gets the properties of this RecommendationDetails. A map of maps that contains additional properties which are specific to the associated objects. Each associated object defines it’s set of required and optional properties. Example: `{

“DataEntity”: {

“parentId”: “entityId”

}, “Term”: {

“parentId”: “glossaryId”

}

}`

Returns:	The properties of this RecommendationDetails.
Return type:	dict(str, dict(str, str))

recommendation_key¶

[Required] Gets the recommendation_key of this RecommendationDetails. Unique identifier of the recommendation.

Returns:	The recommendation_key of this RecommendationDetails.
Return type:	str

recommendation_status¶

[Required] Gets the recommendation_status of this RecommendationDetails. Status of a recommendation.

Allowed values for this property are: “ACCEPTED”, “REJECTED”, “INFERRED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The recommendation_status of this RecommendationDetails.
Return type:	str

recommendation_type¶

[Required] Gets the recommendation_type of this RecommendationDetails. Type of recommendation.

Allowed values for this property are: “LINK_GLOSSARY_TERM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The recommendation_type of this RecommendationDetails.
Return type:	str

source_object_key¶

Gets the source_object_key of this RecommendationDetails. Unique identifier of the source object; the one for which a recommendation is made.

Returns:	The source_object_key of this RecommendationDetails.
Return type:	str

source_object_name¶

Gets the source_object_name of this RecommendationDetails. Name of the source object; the one for which a recommendation is made.

Returns:	The source_object_name of this RecommendationDetails.
Return type:	str

source_object_type¶

Gets the source_object_type of this RecommendationDetails. Type of the source object; the one for which a recommendation is made.

Allowed values for this property are: “DATA_ENTITY”, “ATTRIBUTE”, “TERM”, “CATEGORY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The source_object_type of this RecommendationDetails.
Return type:	str

target_object_key¶

Gets the target_object_key of this RecommendationDetails. Unique identifier of the target object; the one which has been recommended.

Returns:	The target_object_key of this RecommendationDetails.
Return type:	str

target_object_name¶

Gets the target_object_name of this RecommendationDetails. Name of the target object; the one which has been recommended.

Returns:	The target_object_name of this RecommendationDetails.
Return type:	str

target_object_type¶

Gets the target_object_type of this RecommendationDetails. Type of the target object; the one which has been recommended.

Allowed values for this property are: “DATA_ENTITY”, “ATTRIBUTE”, “TERM”, “CATEGORY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The target_object_type of this RecommendationDetails.
Return type:	str