SetTaskStateRequestType

SetTaskStateRequestType
SetTaskStateRequestType

The parameters of SetTaskState.

JSON Example
{
    "state": "string",
    "result": {
        "_typeName": "string"
    },
    "fault": {
        "_typeName": "string",
        "faultCause": "MethodFault Object",
        "faultMessage": [
            {
                "_typeName": "string",
                "key": "string",
                "arg": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": {
                            "_typeName": "string"
                        }
                    }
                ],
                "message": "string"
            }
        ]
    }
}
state
Required

List of possible states of a task.

Possible values:

  • queued: When there are too many tasks for threads to handle.

  • running: When the busy thread is freed from its current task by finishing the task, it picks a queued task to run.

    Then the queued tasks are marked as running.

  • success: When a running task has completed.

  • error: When a running task has encountered an error.

Possible values are : queued, running, success, error,
result
Optional

The base of all data types. Not to be used directly on the wire.

fault
Optional

The base data object type for all the object model faults that an application might handle.