INPUT_OBJECT

UpdateTask

link GraphQL Schema definition

1input UpdateTask {
3
2id: ID!
5
4status: TaskStatus!
7
6jobId: ID
9
8output: JSONData
12
10# Task output as JSON string
11outputString: String
37
13# Use this parameter if your task output does not take the form of valid
14# JSON. Provide a key and the server will convert your output into
15# JSON with a single string value. For example,
16# ```
17#
18# mutation {
19#
20# updateTask(input: {
21#
22# id:
23#
24# outputString: "more stuff "
25#
26# outputJsonKey: "response"
27#
28# }) { id }
29#
30# }
31#
32# ```
33# Will set the task output JSON to
34#
35# ` {"response":"more stuff "}`
36outputJsonKey: String
40
38# Backwards compatibility only
39taskOutput: JSONData
43
41# Update the task with a new payload
42payload: JSONData
46
44# Save execution location metadata
45executionLocationData: JSONData
57
47# Optional timestamp used to control change ordering.
48# The client may set this to the `modifiedDateTime` value
49# of most recent copy of the task it has before making the
50# update. The server will _only_ update the task with the
51# requested changes _if_ and only if the current
52# `modifiedDateTime` value is equal to or earlier than
53# the supplied `clientTimestamp` value. Thus, changes
54# that were made after the client last retrieved the task
55# data will not be overwritten.
56clientTimestamp: DateTime
62
58# A code indicating why the task failed. Should be set
59# if and only if task status is `failed`.
60# If set with any other task status, the API will return an error.
61failureReason: TaskFailureReason
69
63# A human-readable string with detail on the
64# task failure reason. Should be set if and only if
65# task status is `failed` and `failureReason` is set.
66# If set with any other task status or if `failureReason` is not set,
67# the API will return an error.
68failureMessage: String
72
70# This contains a list of URIs engine toolkit will send completed chunks.
71notificationUris: [String]
73}