ClusterRecommendation

ClusterRecommendation
ClusterRecommendation

Recommendation is the base class for any packaged group of actions that are intended to take the system from one state to another one.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "key": "string",
    "type": "string",
    "time": "string",
    "rating": 0,
    "reason": "string",
    "reasonText": "string",
    "warningText": "string",
    "warningDetails": {
        "_typeName": "string",
        "key": "string",
        "arg": [
            {
                "_typeName": "string",
                "key": "string",
                "value": {
                    "_typeName": "string"
                }
            }
        ],
        "message": "string"
    },
    "prerequisite": [
        "string"
    ],
    "action": [
        {
            "_typeName": "string",
            "type": "string",
            "target": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            }
        }
    ],
    "target": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
}
string
key
Required

Key to identify the recommendation when calling applyRecommendation.

string
type
Required

Type of the recommendation.

This differentiates between various of recommendations aimed at achieving different goals.

string As date-time As date-time
time
Required

The time this recommendation was computed.

integer As int32 As int32
rating
Required

A rating of the recommendation.

Valid values range from 1 (lowest confidence) to 5 (highest confidence).

string
reason
Required

A reason code explaining why this set of migrations is being suggested.

string
reasonText
Required

Text that provides more information about the reason code for the suggested set of migrations.

string
warningText
Optional

Text that provides warnings about potential adverse implications of applying this recommendation

warningDetails
Optional

Warning about potential adverse implications of applying a recommendation

array of string
prerequisite
Optional

This recommendation may depend on some other recommendations.

The prerequisite recommendations are listed by their keys.

array of ClusterAction
action
Optional

List of actions that are executed as part of this recommendation

target
Optional

The target object of this recommendation.

Property Of