NamespaceManagement_SupervisorServices_CheckResult

NamespaceManagement_SupervisorServices_CheckResult
NamespaceManagement_SupervisorServices_CheckResult

The SupervisorServices.CheckResult structure defines the result of the validation checks on the content of a Supervisor Service version.

JSON Example
{
    "status": "string",
    "content_type": "string",
    "vsphere_apps_check_result": {
        "supervisor_service": "string",
        "version": "string",
        "display_name": "string",
        "description": "string",
        "eula": "string"
    },
    "carvel_apps_check_result": {
        "supervisor_service": "string",
        "version": "string",
        "display_name": "string",
        "description": "string"
    },
    "warning_messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "error_messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ]
}
status
Required

The SupervisorServices.ValidationStatus enumerated type defines the type of status for validating content of a Supervisor Service version.
VALID : Indicates the content is valid for a Supervisor Service version.
VALID_WITH_WARNINGS : Indicates the content is valid for a Supervisor Service version, but the content may contain information that should be reviewed closely and could prevent the Supervisor Service version to be created successfully later, which is explained in SupervisorServices.CheckResult.warning-messages. For example, the content may specify a Supervisor Service version that already exists on this vCenter.
INVALID : Indicates the content is invalid for a Supervisor Service version, in which case the reasons can be found in SupervisorServices.CheckResult.error-messages.

content_type
Optional

The Versions.ContentType enumerated type defines the type of content that describes the format of Supervisor Service version definition.
VSPHERE_APPS_YAML : The Supervisor Service version definition is provided as inline YAML document that follows the vSphere application service format.
CARVEL_APPS_YAML : The Supervisor Service version definition is provided as inline YAML document that follows the Carvel application package format.
CUSTOM_YAML : The Supervisor Service version definition is provided as inline YAML document that follows a plain Kubernetes YAML format.

vsphere_apps_check_result
Optional

The SupervisorServices.VsphereAppsCheckResult structure contains the information of a Supervisor Service version that is retrieved from the content in vSphere application service format as a result of the SupervisorServices.check-content operation.

carvel_apps_check_result
Optional

The SupervisorServices.CarvelAppsCheckResult structure contains the information of a Supervisor Service version that is retrieved from the content in Carvel application package format as a result of the SupervisorServices.check-content operation.

warning_messages
Optional

A list of messages indicating why the content was considered valid but contains information that should be reviewed closely. This field is optional and it is only relevant when the value of SupervisorServices.CheckResult.status is VALID_WITH_WARNINGS.

error_messages
Optional

A list of messages indicating why the content was considered invalid. This field is optional and it is only relevant when the value of SupervisorServices.CheckResult.status is INVALID.