-
Notifications
You must be signed in to change notification settings - Fork 368
Expand file tree
/
Copy path_object.md.erb
More file actions
29 lines (27 loc) · 1.63 KB
/
_object.md.erb
File metadata and controls
29 lines (27 loc) · 1.63 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
### The task object
```
Example Task object
```
```json
<%= yield_content :single_task %>
```
Name | Type | Description
---- | ---- | -----------
**guid** | _uuid_ | Unique identifier for the task
**created_at** | _[timestamp](#timestamps)_ | The time with zone when the object was created
**updated_at** | _[timestamp](#timestamps)_ | The time with zone when the object was last updated
**sequence_id** | _integer_ | User-facing id of the task; this number is unique for every task associated with a given app
**name** | _string_ | Name of the task
**command** | _string_ | Command that will be executed; this field may be excluded based on a user's role
**user** | _string_ or _null_ | The OS user used to run the task in the runtime
**state** | _string_ | State of the task Possible states are `PENDING`, `RUNNING`, `SUCCEEDED`, `CANCELING`, and `FAILED`
**memory_in_mb** | _integer_ | Amount of memory to allocate for the task in MB
**disk_in_mb** | _integer_ | Amount of disk to allocate for the task in MB
**log_rate_limit_per_second** | _integer_ | Amount of log rate to allocate for the task in bytes
**result** | _object_ | Results from the task
**result.failure_reason** | _string_ | Null if the task succeeds, contains the error message if it fails
**droplet_guid** | _uuid_ | The guid of the droplet that will be used to run the command
**relationships.app** | _[timestamp](#timestamps)_ | The app the task belongs to
**metadata.labels** | [_label object_](#labels) | Labels applied to the task
**metadata.annotations** | [_annotation object_](#annotations) | Annotations applied to the task
**links** | [_links object_](#links) | Links to related resources