sdk/go/arvados/container.go

   1 package arvados
   2
   3 // Container is an arvados#container resource.
   4 type Container struct {
   5         UUID                 string               `json:"uuid"`
   6         Command              []string             `json:"command"`
   7         ContainerImage       string               `json:"container_image"`
   8         Cwd                  string               `json:"cwd"`
   9         Environment          map[string]string    `json:"environment"`
  10         LockedByUUID         string               `json:"locked_by_uuid"`
  11         Mounts               map[string]Mount     `json:"mounts"`
  12         Output               string               `json:"output"`
  13         OutputPath           string               `json:"output_path"`
  14         Priority             int                  `json:"priority"`
  15         RuntimeConstraints   RuntimeConstraints   `json:"runtime_constraints"`
  16         State                ContainerState       `json:"state"`
  17         SchedulingParameters SchedulingParameters `json:"scheduling_parameters"`
  18 }
  19
  20 // Mount is special behavior to attach to a filesystem path or device.
  21 type Mount struct {
  22         Kind              string      `json:"kind"`
  23         Writable          bool        `json:"writable"`
  24         PortableDataHash  string      `json:"portable_data_hash"`
  25         UUID              string      `json:"uuid"`
  26         DeviceType        string      `json:"device_type"`
  27         Path              string      `json:"path"`
  28         Content           interface{} `json:"content"`
  29         ExcludeFromOutput bool        `json:"exclude_from_output"`
  30 }
  31
  32 // RuntimeConstraints specify a container's compute resources (RAM,
  33 // CPU) and network connectivity.
  34 type RuntimeConstraints struct {
  35         API          *bool
  36         RAM          int `json:"ram"`
  37         VCPUs        int `json:"vcpus"`
  38         KeepCacheRAM int `json:"keep_cache_ram"`
  39 }
  40
  41 // SchedulingParameters specify a container's scheduling parameters
  42 // such as Partitions
  43 type SchedulingParameters struct {
  44         Partitions []string `json:"partitions"`
  45 }
  46
  47 // ContainerList is an arvados#containerList resource.
  48 type ContainerList struct {
  49         Items          []Container `json:"items"`
  50         ItemsAvailable int         `json:"items_available"`
  51         Offset         int         `json:"offset"`
  52         Limit          int         `json:"limit"`
  53 }
  54
  55 // ContainerState is a string corresponding to a valid Container state.
  56 type ContainerState string
  57
  58 const (
  59         ContainerStateQueued    = ContainerState("Queued")
  60         ContainerStateLocked    = ContainerState("Locked")
  61         ContainerStateRunning   = ContainerState("Running")
  62         ContainerStateComplete  = ContainerState("Complete")
  63         ContainerStateCancelled = ContainerState("Cancelled")
  64 )