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

LocalizableMessage
warningDetails
Optional

Message data which is intended to be displayed according to the locale of a client.

A LocalizableMessage contains both a formatted, localized version of the text and the data needed to perform localization in conjunction with localization catalogs.

Clients of the VIM API may use vim.SessionManager.setLocale() to cause the server to emit a localized message, or may perform client-side localization based on message catalogs provided by the server.

  • If the substition variable is a string, no further lookup is required.
    • arg = [("address" = "127.0.0.1")]
    • CATALOG(locmsg, key) = "IP address is {address}"
    • ==> message = "IP address is 127.0.0.1"
  • If the substitution variable is an integer, value is a lookup key.
    • arg = [("1" = "button.cancel"), ("2" = "msg.revert")]
    • CATALOG(locmsg, key) = "Select '{1}' to {2}"
    • CATALOG(locmsg, button.cancel) = "Cancel"
    • CATALOG(locmsg, msg.revert) = "revert"
    • ==> message = "Select 'Cancel' to revert"
  • If the variable contains '@', value is a label lookup in another catalog, where {[email protected]} looks up prefix.arg[name].label in CATALOG.
    • arg = [("field" = "queued")]
    • CATALOG(locmsg, key) = "State is {[email protected]}"
    • CATALOG(enum, TaskInfo.State.queued.label) is "Queued"
    • ==> message = "State is Queued"
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

ManagedObjectReference
target
Optional

The ManagedObjectReference data object type is a special-purpose data object. Commonly referred to as simply a "reference", "MoRef", "MOR", or other variations of this theme, instances of managed object references contain data that identifies specific server-side managed objects. Managed object references are typically one of the return types from a method invocation.

Managed object references are client application references to server-side managed objects. The client application uses ManagedObjectReference objects when it invokes operations on a server. A ManagedObjectReference is guaranteed to be unique and persistent during an object's lifetime. The reference persists after an object has moved within the inventory, across sessions, and across server restarts. If you remove an object, for example, a virtual machine, from the inventory, and then put it back, the reference changes.

Property Of
Returned By