package determined.task.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Address represents an exposed port on a container.

Used in: ResourcesStarted

• string container_ip = 1

  ContainerIP is the IP address from inside the container.

• int32 container_port = 2

  ContainerPort is the port from inside the container.

• string host_ip = 3

  HostIP is the IP address from outside the container. This can be different than the ContainerIP because of network forwarding on the host machine.

• int32 host_port = 4

  HostPort is the IP port from outside the container. This can be different than the ContainerPort because of network forwarding on the host machine.

Allocation tracks a specific instance of a Task.

Used in: api.v1.GetAllocationResponse, Task

• string task_id = 1

  Unique ID of task associated with the allocation.

• State state = 2

  The current state of the allocation.

• optional bool is_ready = 3

  Whether the allocation is ready to access.

• optional string start_time = 4

  Start timestamp.

• optional string end_time = 5

  End timestamp if completed.

• string allocation_id = 6

  Unique ID of the allocation.

• int32 slots = 7

  The number of slots associated with the allocation.

• optional string exit_reason = 8

  The exit reason for the allocation.

• optional int32 status_code = 9

  The status code the allocation exits with.

AllocationSummary contains information about a task for external display.

Used in: api.v1.GetTasksResponse

• string task_id = 1

  TaskID is the unique ID of a task among all tasks.

• string allocation_id = 2

  AllocationID is the ID of an allocation of a task. It is usually of the form TaskID.allocation_number, maybe with some other metadata if different types of allocations run.

• string name = 3

  The name of the task.

• optional google.protobuf.Timestamp registered_time = 4

  The registered time of the task.

• string resource_pool = 5

  The name of the resource pool.

• int32 slots_needed = 6

  The number of slots that are needed.

• repeated ResourcesSummary resources = 7

  ResourcesSummary provides a summary of the resources comprising what we know at the time the allocation is granted.

• string scheduler_type = 8

  The type of the scheduler. Either 'FAIR_SHARE', 'PRIORITY', or 'ROUND_ROBIN'.

• optional int32 priority = 9

  THe priority of the task.

• repeated ProxyPortConfig proxy_ports = 10

  ProxyPortConfig configures a proxy the allocation should start.

The failure type of a resource.

Used in: ResourcesFailure

• FAILURE_TYPE_UNSPECIFIED = 0

  UNSPECIFIED denotes an error that is not defined below.

• FAILURE_TYPE_RESOURCES_FAILED = 1

  ResourcesFailed denotes that the container ran but failed with a non-zero exit code.

• FAILURE_TYPE_RESOURCES_ABORTED = 2

  ResourcesAborted denotes the container was canceled before it was started.

• FAILURE_TYPE_RESOURCES_MISSING = 3

  ResourcesMissing denotes the resources were missing when the master asked about it.

• FAILURE_TYPE_TASK_ABORTED = 4

  TaskAborted denotes that the task was canceled before it was started.

• FAILURE_TYPE_TASK_ERROR = 5

  TaskError denotes that the task failed without an associated exit code.

• FAILURE_TYPE_AGENT_FAILED = 6

  AgentFailed denotes that the agent failed while the container was running.

• FAILURE_TYPE_AGENT_ERROR = 7

  AgentError denotes that the agent failed to launch the container.

• FAILURE_TYPE_RESTORE_ERROR = 8

  RestoreError denotes a failure to restore a running allocation on master blip.

• FAILURE_TYPE_UNKNOWN_ERROR = 9

  UnknownError denotes an internal error that did not map to a know failure type.

State of a Generic task

Used in: Task

• GENERIC_TASK_STATE_UNSPECIFIED = 0

  The task state unknown

• GENERIC_TASK_STATE_ACTIVE = 1

  The task state unknown

• GENERIC_TASK_STATE_CANCELED = 2

  The task state unknown

• GENERIC_TASK_STATE_COMPLETED = 3

  The task state unknown

• GENERIC_TASK_STATE_ERROR = 4

  The task state unknown

• GENERIC_TASK_STATE_PAUSED = 5

  The task state unknown

• GENERIC_TASK_STATE_STOPPING_PAUSED = 6

  The task state unknown

• GENERIC_TASK_STATE_STOPPING_CANCELED = 7

  The task state unknown

• GENERIC_TASK_STATE_STOPPING_COMPLETED = 8

  The task state unknown

• GENERIC_TASK_STATE_STOPPING_ERROR = 9

  The task state unknown

ProxyPortConfig configures a proxy the allocation should start.

Used in: AllocationSummary

• string service_id = 1

  The service ID of the proxy port config.

• int32 port = 2

  The port of the proxy port config.

• bool proxy_tcp = 3

  True if proxy uses TCP.

• bool unauthenticated = 4

  True if the proxy is unauthenticated.

ResourcesFailure contains information about restored resources' failure.

Used in: ResourcesStopped

• FailureType failure_type = 1

  FailureType denotes the type of failure that resulted in the container stopping.

• string err_msg = 2

  The error message of the failure.

• optional int32 exit_code = 3

  The exit code of the failure.

ResourcesStarted contains the information needed by tasks from container started.

Used in: ResourcesSummary

• repeated Address addresses = 1

  Addresses represents the exposed ports on a container.

• string native_resources_id = 2

  NativeResourcesID is the native Docker hex container ID of the Determined container.

ResourcesStopped contains the information needed by tasks from container stopped.

Used in: ResourcesSummary

• optional ResourcesFailure failure = 1

  ResourcesFailure contains information about restored resources' failure.

ResourcesSummary provides a summary of the resources comprising what we know at the time the allocation is granted, but for k8s it is granted before being scheduled so it isn't really much and `agent_devices` are missing for k8s.

Used in: AllocationSummary

• string resources_id = 1

  ResourcesID is the ID of some set of resources.

• string resources_type = 2

  ResourcesType is the type of some set of resources. This should be purely informational.

• string allocation_id = 3

  AllocationID is the ID of an allocation of a task.

• map<string, ResourcesSummary.Devices> agent_devices = 4

  ID, an identifier for an agent, maps to the associated devices.

• optional string container_id = 5

  Available if the RM can give information on the container level.

• optional ResourcesStarted started = 6

  Available if the RM knows the resource is already started / exited.

• optional ResourcesStopped exited = 7

  ResourcesStopped contains the information needed by tasks from container stopped.

A wrapper message of a list of devices.

Used in: ResourcesSummary

• repeated device.v1.Device devices = 1

  The devices on an agent.

The current state of the task.

Used in: command.v1.Command, notebook.v1.Notebook, shell.v1.Shell, Allocation, tensorboard.v1.Tensorboard

• STATE_UNSPECIFIED = 0

  The task state is unknown.

• STATE_PULLING = 3

  The task's base image is being pulled from the Docker registry.

• STATE_STARTING = 4

  The image has been pulled and the task is being started, but the task is not ready yet.

• STATE_RUNNING = 5

  The service in the task is running.

• STATE_TERMINATED = 6

  The task has exited or has been aborted.

• STATE_TERMINATING = 7

  The task has begun to exit.

• STATE_WAITING = 9

  The task is waiting on something to complete.

• STATE_QUEUED = 8

  Additional state to cover queueing operations.

Task is the model for a task in the database.

Used in: api.v1.GetTaskResponse

• string task_id = 1

  Unique ID of task.

• TaskType task_type = 2

  Type of Task.

• repeated Allocation allocations = 4

  List of Allocations.

• optional google.protobuf.Timestamp start_time = 5

  Start timestamp.

• optional google.protobuf.Timestamp end_time = 6

  End timestamp if completed.

• optional string config = 7

  The configuration of the task.

• optional string parent_id = 8

  ID of parent task (empty if root task).

• optional GenericTaskState task_state = 9

  State of task execution.

• optional string forked_from = 10

  ID of task this is forked from (If task is a forked task)

• optional bool no_pause = 11

  Flag for whether task can be paused or not.

TaskLog is the model for a task log in the database

Used in: api.v1.PostTaskLogsRequest

• optional int32 id = 1

  The ID of the log.

• string task_id = 2

  The ID of the task.

• optional string allocation_id = 3

  The ID of the allocation.

• optional string agent_id = 4

  The agent the logs came from.

• optional string container_id = 5

  The ID of the container or, in the case of k8s, the pod name.

• optional int32 rank_id = 6

  The rank ID.

• optional google.protobuf.Timestamp timestamp = 7

  The timestamp of the log.

• optional log.v1.LogLevel level = 8

  The level of this log.

• string log = 9

  The text of the log entry.

• optional string source = 10

  The source of the log entry.

• optional string stdtype = 11

  The output stream (e.g. stdout, stderr).

Type of the task

Used in: Task

• TASK_TYPE_UNSPECIFIED = 0

  The task type is unknown

• TASK_TYPE_TRIAL = 1

  "TRIAL" task type for the enum public.task_type in Postgres.

• TASK_TYPE_NOTEBOOK = 2

  "NOTEBOOK" task type for the enum public.task_type in Postgres.

• TASK_TYPE_SHELL = 3

  "SHELL" task type for the enum public.task_type in Postgres.

• TASK_TYPE_COMMAND = 4

  "COMMAND" task type for the enum public.task_type in Postgres.

• TASK_TYPE_TENSORBOARD = 5

  "TENSORBOARD" task type for the enum public.task_type in Postgres.

• TASK_TYPE_CHECKPOINT_GC = 6

  "CHECKPOINT_GC" task type for the enum public.task_type in Postgres.

• TASK_TYPE_GENERIC = 7

  "GENERIC" task type for the enum public.task_type in Postgres.