Merge branch '15370-loopback-dispatchcloud'
[arvados.git] / sdk / go / arvados / container.go
index 6a76f1f396a32c89544f55030cb586ae413d0c0b..466221fe19316ef908db578f005dfa20a0722259 100644 (file)
+// Copyright (C) The Arvados Authors. All rights reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+
 package arvados
 
+import "time"
+
 // Container is an arvados#container resource.
 type Container struct {
-       UUID               string             `json:"uuid"`
-       Command            []string           `json:"command"`
-       ContainerImage     string             `json:"container_image"`
-       Cwd                string             `json:"cwd"`
-       Environment        map[string]string  `json:"environment"`
-       LockedByUUID       string             `json:"locked_by_uuid"`
-       Mounts             map[string]Mount   `json:"mounts"`
-       Output             string             `json:"output"`
-       OutputPath         string             `json:"output_path"`
-       Priority           int                `json:"priority"`
-       RuntimeConstraints RuntimeConstraints `json:"runtime_constraints"`
-       State              ContainerState     `json:"state"`
+       UUID                      string                 `json:"uuid"`
+       Etag                      string                 `json:"etag"`
+       CreatedAt                 time.Time              `json:"created_at"`
+       ModifiedByClientUUID      string                 `json:"modified_by_client_uuid"`
+       ModifiedByUserUUID        string                 `json:"modified_by_user_uuid"`
+       ModifiedAt                time.Time              `json:"modified_at"`
+       Command                   []string               `json:"command"`
+       ContainerImage            string                 `json:"container_image"`
+       Cwd                       string                 `json:"cwd"`
+       Environment               map[string]string      `json:"environment"`
+       LockedByUUID              string                 `json:"locked_by_uuid"`
+       Mounts                    map[string]Mount       `json:"mounts"`
+       Output                    string                 `json:"output"`
+       OutputPath                string                 `json:"output_path"`
+       Priority                  int64                  `json:"priority"`
+       RuntimeConstraints        RuntimeConstraints     `json:"runtime_constraints"`
+       State                     ContainerState         `json:"state"`
+       SchedulingParameters      SchedulingParameters   `json:"scheduling_parameters"`
+       ExitCode                  int                    `json:"exit_code"`
+       RuntimeStatus             map[string]interface{} `json:"runtime_status"`
+       StartedAt                 *time.Time             `json:"started_at"`  // nil if not yet started
+       FinishedAt                *time.Time             `json:"finished_at"` // nil if not yet finished
+       GatewayAddress            string                 `json:"gateway_address"`
+       InteractiveSessionStarted bool                   `json:"interactive_session_started"`
+       OutputStorageClasses      []string               `json:"output_storage_classes"`
+       RuntimeUserUUID           string                 `json:"runtime_user_uuid"`
+       RuntimeAuthScopes         []string               `json:"runtime_auth_scopes"`
+       RuntimeToken              string                 `json:"runtime_token"`
+       AuthUUID                  string                 `json:"auth_uuid"`
+       Log                       string                 `json:"log"`
+}
+
+// ContainerRequest is an arvados#container_request resource.
+type ContainerRequest struct {
+       UUID                    string                 `json:"uuid"`
+       OwnerUUID               string                 `json:"owner_uuid"`
+       CreatedAt               time.Time              `json:"created_at"`
+       ModifiedByClientUUID    string                 `json:"modified_by_client_uuid"`
+       ModifiedByUserUUID      string                 `json:"modified_by_user_uuid"`
+       ModifiedAt              time.Time              `json:"modified_at"`
+       Href                    string                 `json:"href"`
+       Etag                    string                 `json:"etag"`
+       Name                    string                 `json:"name"`
+       Description             string                 `json:"description"`
+       Properties              map[string]interface{} `json:"properties"`
+       State                   ContainerRequestState  `json:"state"`
+       RequestingContainerUUID string                 `json:"requesting_container_uuid"`
+       ContainerUUID           string                 `json:"container_uuid"`
+       ContainerCountMax       int                    `json:"container_count_max"`
+       Mounts                  map[string]Mount       `json:"mounts"`
+       RuntimeConstraints      RuntimeConstraints     `json:"runtime_constraints"`
+       SchedulingParameters    SchedulingParameters   `json:"scheduling_parameters"`
+       ContainerImage          string                 `json:"container_image"`
+       Environment             map[string]string      `json:"environment"`
+       Cwd                     string                 `json:"cwd"`
+       Command                 []string               `json:"command"`
+       OutputPath              string                 `json:"output_path"`
+       OutputName              string                 `json:"output_name"`
+       OutputTTL               int                    `json:"output_ttl"`
+       Priority                int                    `json:"priority"`
+       UseExisting             bool                   `json:"use_existing"`
+       LogUUID                 string                 `json:"log_uuid"`
+       OutputUUID              string                 `json:"output_uuid"`
+       RuntimeToken            string                 `json:"runtime_token"`
+       ExpiresAt               time.Time              `json:"expires_at"`
+       Filters                 []Filter               `json:"filters"`
+       ContainerCount          int                    `json:"container_count"`
+       OutputStorageClasses    []string               `json:"output_storage_classes"`
+       OutputProperties        map[string]interface{} `json:"output_properties"`
 }
 
 // Mount is special behavior to attach to a filesystem path or device.
 type Mount struct {
-       Kind             string      `json:"kind"`
-       Writable         bool        `json:"writable"`
-       PortableDataHash string      `json:"portable_data_hash"`
-       UUID             string      `json:"uuid"`
-       DeviceType       string      `json:"device_type"`
-       Path             string      `json:"path"`
-       Content          interface{} `json:"content"`
+       Kind              string      `json:"kind"`
+       Writable          bool        `json:"writable"`
+       PortableDataHash  string      `json:"portable_data_hash"`
+       UUID              string      `json:"uuid"`
+       DeviceType        string      `json:"device_type"`
+       Path              string      `json:"path"`
+       Content           interface{} `json:"content"`
+       ExcludeFromOutput bool        `json:"exclude_from_output"`
+       Capacity          int64       `json:"capacity"`
+       Commit            string      `json:"commit"`          // only if kind=="git_tree"
+       RepositoryName    string      `json:"repository_name"` // only if kind=="git_tree"
+       GitURL            string      `json:"git_url"`         // only if kind=="git_tree"
+}
+
+type CUDARuntimeConstraints struct {
+       DriverVersion      string `json:"driver_version"`
+       HardwareCapability string `json:"hardware_capability"`
+       DeviceCount        int    `json:"device_count"`
 }
 
 // RuntimeConstraints specify a container's compute resources (RAM,
 // CPU) and network connectivity.
 type RuntimeConstraints struct {
-       API          *bool
-       RAM          int      `json:"ram"`
-       VCPUs        int      `json:"vcpus"`
-       KeepCacheRAM int      `json:"keep_cache_ram"`
-       Partition    []string `json:"partition"`
+       API          bool                   `json:"API"`
+       RAM          int64                  `json:"ram"`
+       VCPUs        int                    `json:"vcpus"`
+       KeepCacheRAM int64                  `json:"keep_cache_ram"`
+       CUDA         CUDARuntimeConstraints `json:"cuda"`
+}
+
+// SchedulingParameters specify a container's scheduling parameters
+// such as Partitions
+type SchedulingParameters struct {
+       Partitions  []string `json:"partitions"`
+       Preemptible bool     `json:"preemptible"`
+       MaxRunTime  int      `json:"max_run_time"`
 }
 
 // ContainerList is an arvados#containerList resource.
@@ -45,6 +127,14 @@ type ContainerList struct {
        Limit          int         `json:"limit"`
 }
 
+// ContainerRequestList is an arvados#containerRequestList resource.
+type ContainerRequestList struct {
+       Items          []ContainerRequest `json:"items"`
+       ItemsAvailable int                `json:"items_available"`
+       Offset         int                `json:"offset"`
+       Limit          int                `json:"limit"`
+}
+
 // ContainerState is a string corresponding to a valid Container state.
 type ContainerState string
 
@@ -55,3 +145,12 @@ const (
        ContainerStateComplete  = ContainerState("Complete")
        ContainerStateCancelled = ContainerState("Cancelled")
 )
+
+// ContainerRequestState is a string corresponding to a valid Container Request state.
+type ContainerRequestState string
+
+const (
+       ContainerRequestStateUncomitted = ContainerRequestState("Uncommitted")
+       ContainerRequestStateCommitted  = ContainerRequestState("Committed")
+       ContainerRequestStateFinal      = ContainerRequestState("Final")
+)