1. Types
  2. vcenter
  3. extension
  4. tasks

vcenter extension tasks: update spec

The update_spec structure contains fields used to update the information of the operation associated with a task. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Representation:

{
    "result" : "opaque_string_value",
    "start_time" : "2015-01-01T22:13:05.651Z",
    "percent_done" : {
        "total" : 1,
        "completed" : 1,
        "message" : {
            "args" : [
                "string",
                "string"
            ],
            "default_message" : "string",
            "localized" : "string",
            "id" : "string",
            "params" : {
                "<string>" : {
                    "dt" : "2015-01-01T22:13:05.651Z",
                    "s" : "string",
                    "d" : 1.5,
                    "precision" : 1,
                    "format" : "SHORT_DATE",
                    "i" : 1,
                    "l" : {
                        "id" : "string",
                        "params" : {
                            "<string>" : {
                                "dt" : "2015-01-01T22:13:05.651Z",
                                "s" : "string",
                                "d" : 1.5,
                                "precision" : 1,
                                "format" : "SHORT_DATE",
                                "i" : 1,
                                "l" : {
                                    "id" : "string",
                                    "params" : {}
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "end_time" : "2015-01-01T22:13:05.651Z",
    "description" : {
        "args" : [
            "string",
            "string"
        ],
        "default_message" : "string",
        "localized" : "string",
        "id" : "string",
        "params" : {
            "<string>" : {
                "dt" : "2015-01-01T22:13:05.651Z",
                "s" : "string",
                "d" : 1.5,
                "precision" : 1,
                "format" : "SHORT_DATE",
                "i" : 1,
                "l" : {
                    "id" : "string",
                    "params" : {
                        "<string>" : {
                            "dt" : "2015-01-01T22:13:05.651Z",
                            "s" : "string",
                            "d" : 1.5,
                            "precision" : 1,
                            "format" : "SHORT_DATE",
                            "i" : 1,
                            "l" : {
                                "id" : "string",
                                "params" : {}
                            }
                        }
                    }
                }
            }
        }
    },
    "error" : {},
    "status" : "PENDING"
}
{
    "result" : "opaque_string_value",
    "start_time" : "2015-01-01T22:13:05.651Z",
    "percent_done" : {
        "total" : 1,
        "completed" : 1,
        "message" : {
            "args" : [
                "string",
                "string"
            ],
            "default_message" : "string",
            "localized" : "string",
            "id" : "string",
            "params" : [
                {
                    "value" : {
                        "dt" : "2015-01-01T22:13:05.651Z",
                        "s" : "string",
                        "d" : 1.5,
                        "precision" : 1,
                        "format" : "SHORT_DATE",
                        "i" : 1,
                        "l" : {
                            "id" : "string",
                            "params" : [
                                {
                                    "value" : {
                                        "dt" : "2015-01-01T22:13:05.651Z",
                                        "s" : "string",
                                        "d" : 1.5,
                                        "precision" : 1,
                                        "format" : "SHORT_DATE",
                                        "i" : 1,
                                        "l" : {
                                            "id" : "string",
                                            "params" : [
                                                {
                                                    "key" : "string"
                                                }
                                            ]
                                        }
                                    },
                                    "key" : "string"
                                }
                            ]
                        }
                    },
                    "key" : "string"
                }
            ]
        }
    },
    "end_time" : "2015-01-01T22:13:05.651Z",
    "description" : {
        "args" : [
            "string",
            "string"
        ],
        "default_message" : "string",
        "localized" : "string",
        "id" : "string",
        "params" : [
            {
                "value" : {
                    "dt" : "2015-01-01T22:13:05.651Z",
                    "s" : "string",
                    "d" : 1.5,
                    "precision" : 1,
                    "format" : "SHORT_DATE",
                    "i" : 1,
                    "l" : {
                        "id" : "string",
                        "params" : [
                            {
                                "value" : {
                                    "dt" : "2015-01-01T22:13:05.651Z",
                                    "s" : "string",
                                    "d" : 1.5,
                                    "precision" : 1,
                                    "format" : "SHORT_DATE",
                                    "i" : 1,
                                    "l" : {
                                        "id" : "string",
                                        "params" : [
                                            {
                                                "key" : "string"
                                            }
                                        ]
                                    }
                                },
                                "key" : "string"
                            }
                        ]
                    }
                },
                "key" : "string"
            }
        ]
    },
    "error" : {},
    "status" : "PENDING"
}

Attributes:

Name Type Description
Required
-.percent_done.total long Total amount of the work for the operation. This attribute was added in vSphere API 6.7.
-.percent_done.completed long The amount of work completed for the operation. The value can only be incremented. This attribute was added in vSphere API 6.7.
-.percent_done.message localizable_message Message about the work progress. This attribute was added in vSphere API 6.7.
-.percent_done.message.id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
-.percent_done.message.default_message string The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
-.percent_done.message.args string[] Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments.
-.description.id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
-.description.default_message string The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
-.description.args string[] Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments.
Optional
-.percent_done progress The percentage completion of the operation associated with the task. In the current release, the 'LocalizableMessage message' field of Info.progress will be ignored. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. If unset, the current percentDone will remain as-is.
-.percent_done.message.params object Named arguments to be substituted into the message template. This attribute was added in vSphere API 7.0.0.0.

Optional. Unset means that the message template requires no arguments or positional arguments are used.
-.percent_done.message.localized string Localized string value as per request requirements. This attribute was added in vSphere API 7.0.0.0.

Optional. when the client has not requested specific locale the implementation may not populate this field to conserve resources.
-.description localizable_message The description of the operation associated with the task. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. If unset, the current state will remain as-is.
-.description.params object Named arguments to be substituted into the message template. This attribute was added in vSphere API 7.0.0.0.

Optional. Unset means that the message template requires no arguments or positional arguments are used.
-.description.localized string Localized string value as per request requirements. This attribute was added in vSphere API 7.0.0.0.

Optional. when the client has not requested specific locale the implementation may not populate this field to conserve resources.
-.status string The status of a task on the Targets. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. If unset, the current state will remain as-is.
-.error exception Description of the error if the operation status is "FAILED". Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when status has value [FAILED]. If unset when status is "FAILED", InvalidArgument exception will be thrown.
-.result opaque Result of the operation. If an operation reports partial results before it completes, this field could be set before the status has the value "SUCCEEDED". The value could change as the operation progresses. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when status has value [RUNNING, BLOCKED, SUCCEEDED, FAILED]. This field will be unset if the operation does not return a result or if the result is not available at the current step of the operation.
-.start_time date_time Time when the operation is started. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when status has value [RUNNING, BLOCKED, SUCCEEDED, FAILED]. This field will be unset if the status is PENDING. If the status is not PENDING, and the client does not provide this field, the current system time will be set.
-.end_time date_time Time when the operation is completed. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when status has value [SUCCEEDED, FAILED]. This field will be unset if the status is not SUCCEEDED or FAILED. If status is SUCCEEDED or FAILED and client does not this field, the current system time will be set.