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 }
  30
  31 // RuntimeConstraints specify a container's compute resources (RAM,
  32 // CPU) and network connectivity.
  33 type RuntimeConstraints struct {
  34         API          *bool
  35         RAM          int `json:"ram"`
  36         VCPUs        int `json:"vcpus"`
  37         KeepCacheRAM int `json:"keep_cache_ram"`
  38 }
  39
  40 // SchedulingParameters specify a container's scheduling parameters
  41 // such as Partitions
  42 type SchedulingParameters struct {
  43         Partitions []string `json:"partitions"`
  44 }
  45
  46 // ContainerList is an arvados#containerList resource.
  47 type ContainerList struct {
  48         Items          []Container `json:"items"`
  49         ItemsAvailable int         `json:"items_available"`
  50         Offset         int         `json:"offset"`
  51         Limit          int         `json:"limit"`
  52 }
  53
  54 // ContainerState is a string corresponding to a valid Container state.
  55 type ContainerState string
  56
  57 const (
  58         ContainerStateQueued    = ContainerState("Queued")
  59         ContainerStateLocked    = ContainerState("Locked")
  60         ContainerStateRunning   = ContainerState("Running")
  61         ContainerStateComplete  = ContainerState("Complete")
  62         ContainerStateCancelled = ContainerState("Cancelled")
  63 )