Settings_EffectiveComponentDetails

The EffectiveComponentDetails structure contains information that provide more details about the component from the depot.

JSON Example

{
    "display_name": "string",
    "display_version": "string",
    "vendor": "string",
    "source": "string",
    "note": {
        "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"
    },
    "overridden_components": [
        {
            "version": "string",
            "display_version": "string",
            "source": "Settings_ComponentSource Object",
            "note": "Std_LocalizableMessage Object"
        }
    ],
    "removable": false,
    "image_customization_action": "string",
    "image_customization_description": {
        "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"
    }
}

string

display_name

Required

Display name of the component.

string

display_version

Required

Human readable version of the component.

string

vendor

Required

Vendor of the component.

Settings_ComponentSource

source

Required

The ComponentSource enumerated type contains the component's source information.
BASE_IMAGE : Base image is the source for this component
ADD_ON : Addon is the source for this component
USER : User is the source for this component
SOLUTION : Solution is the source for this component
HARDWARE_SUPPORT_PACKAGE : Hardware Support Package (HSP) is the source for this component
USER_REMOVED : This component was removed by the user

Std_LocalizableMessage

note

Optional

The LocalizableMessage structure represents localizable string and message template. Services include one or more localizable message templates in the errors they report so that clients can display diagnostic messages in the native language of the user. Services can include localizable strings in the data returned from operations to allow clients to display localized status information in the native language of the user.

array of Settings_ComponentOverrideInfo

overridden_components

Required

List of other component versions present in base image, add-ons or solutions that this component is overriding. For example, if a component version-1 was implicitly present in the base image, but user wants it to be changed to version-2. In that case, EffectiveComponentDetails.source would be USER and there will be one entry in this list indicating base image component version-1 is being overridden.

boolean

removable

Optional

Flag to indicate if the component can be removed by specifying its name in the removed components section of the software specification. This field is optional because it was added in a newer version than its parent node.

Settings_ImageCustomizationAction

image_customization_action

Optional

The ImageCustomizationAction enumerated type contains the different possible types of image customization status. It will be set only when the desired image is customized by the user.
RETAINED : The component is retained at an older version in the desired software specification.
REMOVED : The component is removed by the user in the desired software specification.

Std_LocalizableMessage

image_customization_description

Optional