1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: Apache-2.0
9 // Container is an arvados#container resource.
10 type Container struct {
11 UUID string `json:"uuid"`
12 Etag string `json:"etag"`
13 CreatedAt time.Time `json:"created_at"`
14 ModifiedByClientUUID string `json:"modified_by_client_uuid"`
15 ModifiedByUserUUID string `json:"modified_by_user_uuid"`
16 ModifiedAt time.Time `json:"modified_at"`
17 Command []string `json:"command"`
18 ContainerImage string `json:"container_image"`
19 Cwd string `json:"cwd"`
20 Environment map[string]string `json:"environment"`
21 LockedByUUID string `json:"locked_by_uuid"`
22 Mounts map[string]Mount `json:"mounts"`
23 Output string `json:"output"`
24 OutputPath string `json:"output_path"`
25 Priority int64 `json:"priority"`
26 RuntimeConstraints RuntimeConstraints `json:"runtime_constraints"`
27 State ContainerState `json:"state"`
28 SchedulingParameters SchedulingParameters `json:"scheduling_parameters"`
29 ExitCode int `json:"exit_code"`
30 RuntimeStatus map[string]interface{} `json:"runtime_status"`
31 StartedAt *time.Time `json:"started_at"` // nil if not yet started
32 FinishedAt *time.Time `json:"finished_at"` // nil if not yet finished
35 // ContainerRequest is an arvados#container_request resource.
36 type ContainerRequest struct {
37 UUID string `json:"uuid"`
38 OwnerUUID string `json:"owner_uuid"`
39 CreatedAt time.Time `json:"created_at"`
40 ModifiedByClientUUID string `json:"modified_by_client_uuid"`
41 ModifiedByUserUUID string `json:"modified_by_user_uuid"`
42 ModifiedAt time.Time `json:"modified_at"`
43 Href string `json:"href"`
44 Kind string `json:"kind"`
45 Etag string `json:"etag"`
46 Name string `json:"name"`
47 Description string `json:"description"`
48 Properties map[string]interface{} `json:"properties"`
49 State ContainerRequestState `json:"state"`
50 RequestingContainerUUID string `json:"requesting_container_uuid"`
51 ContainerUUID string `json:"container_uuid"`
52 ContainerCountMax int `json:"container_count_max"`
53 Mounts map[string]Mount `json:"mounts"`
54 RuntimeConstraints RuntimeConstraints `json:"runtime_constraints"`
55 SchedulingParameters SchedulingParameters `json:"scheduling_parameters"`
56 ContainerImage string `json:"container_image"`
57 Environment map[string]string `json:"environment"`
58 Cwd string `json:"cwd"`
59 Command []string `json:"command"`
60 OutputPath string `json:"output_path"`
61 OutputName string `json:"output_name"`
62 OutputTTL int `json:"output_ttl"`
63 Priority int `json:"priority"`
64 UseExisting bool `json:"use_existing"`
65 LogUUID string `json:"log_uuid"`
66 OutputUUID string `json:"output_uuid"`
67 RuntimeToken string `json:"runtime_token"`
68 ExpiresAt time.Time `json:"expires_at"`
69 Filters []Filter `json:"filters"`
70 ContainerCount int `json:"container_count"`
73 // Mount is special behavior to attach to a filesystem path or device.
75 Kind string `json:"kind"`
76 Writable bool `json:"writable"`
77 PortableDataHash string `json:"portable_data_hash"`
78 UUID string `json:"uuid"`
79 DeviceType string `json:"device_type"`
80 Path string `json:"path"`
81 Content interface{} `json:"content"`
82 ExcludeFromOutput bool `json:"exclude_from_output"`
83 Capacity int64 `json:"capacity"`
84 Commit string `json:"commit"` // only if kind=="git_tree"
85 RepositoryName string `json:"repository_name"` // only if kind=="git_tree"
86 GitURL string `json:"git_url"` // only if kind=="git_tree"
89 // RuntimeConstraints specify a container's compute resources (RAM,
90 // CPU) and network connectivity.
91 type RuntimeConstraints struct {
93 RAM int64 `json:"ram"`
94 VCPUs int `json:"vcpus"`
95 KeepCacheRAM int64 `json:"keep_cache_ram"`
98 // SchedulingParameters specify a container's scheduling parameters
100 type SchedulingParameters struct {
101 Partitions []string `json:"partitions"`
102 Preemptible bool `json:"preemptible"`
103 MaxRunTime int `json:"max_run_time"`
106 // ContainerList is an arvados#containerList resource.
107 type ContainerList struct {
108 Items []Container `json:"items"`
109 ItemsAvailable int `json:"items_available"`
110 Offset int `json:"offset"`
111 Limit int `json:"limit"`
114 // ContainerRequestList is an arvados#containerRequestList resource.
115 type ContainerRequestList struct {
116 Items []ContainerRequest `json:"items"`
117 ItemsAvailable int `json:"items_available"`
118 Offset int `json:"offset"`
119 Limit int `json:"limit"`
122 // ContainerState is a string corresponding to a valid Container state.
123 type ContainerState string
126 ContainerStateQueued = ContainerState("Queued")
127 ContainerStateLocked = ContainerState("Locked")
128 ContainerStateRunning = ContainerState("Running")
129 ContainerStateComplete = ContainerState("Complete")
130 ContainerStateCancelled = ContainerState("Cancelled")
133 // ContainerRequestState is a string corresponding to a valid Container Request state.
134 type ContainerRequestState string
137 ContainerRequestStateUncomitted = ContainerRequestState("Uncommitted")
138 ContainerRequestStateCommitted = ContainerRequestState("Committed")
139 ContainerRequestStateFinal = ContainerRequestState("Final")