package peloton.api.v0.task.svc

Get desktop application:
View/edit binary Protocol Buffers messages

* Task service defines the task related methods such as get, list, start, stop and restart tasks.

• rpc GetTask (GetTaskRequest, GetTaskResponse)

  task_svc.proto:23

  Get the info of a task in job.

  message GetTaskRequest

  task_svc.proto:66

  * Request message for TaskService.GetTask method.

  • optional peloton.JobID jobId = 1

    The job ID of the task to get.

  • uint32 instanceId = 2

    The instance ID of the task to get.

  message GetTaskResponse

  task_svc.proto:82

  * Response message for TaskService.GetTask method. Return errors: NOT_FOUND: if the job or task not found. OUT_OF_RANGE: if the instance ID is out of range.

  • optional TaskInfo result = 1

    The task info of the task. DEPRECATED

  • repeated TaskInfo results = 2

    Returns all active and completed tasks of the given instance.

• rpc ListTasks (ListTasksRequest, ListTasksResponse)

  task_svc.proto:26

  List a set of tasks in a job for a given range of instance IDs.

  message ListTasksRequest

  task_svc.proto:95

  * Request message for TaskService.ListTasks method.

  • optional peloton.JobID jobId = 1

    The job ID of the tasks to list.

  • optional InstanceRange range = 2

    The instance ID range of the tasks to list.

  message ListTasksResponse

  task_svc.proto:111

  * Response message for TaskService.GetTask method. Return errors: NOT_FOUND: if the job ID is not found. OUT_OF_RANGE: if the instance IDs are out of range.

  • map<uint32, TaskInfo> tasks = 1

    The map of instance ID to task info for all matching tasks.

• rpc StartTasks (StartTasksRequest, StartTasksResponse)

  task_svc.proto:31

  Start a set of tasks for a job. Will be no-op for tasks that are currently running. The tasks are started asynchronously after the API call returns.

  message StartTasksRequest

  task_svc.proto:120

  * Request message for TaskService.StartTasks method.

  • optional peloton.JobID jobId = 1

    The job ID of the tasks to start.

  • repeated InstanceRange ranges = 2

    The instance ID ranges of the tasks to start.

  message StartTasksResponse

  task_svc.proto:137

  * Response message for TaskService.StartTasks method. Return errors: NOT_FOUND: if the job ID is not found. OUT_OF_RANGE: if the instance IDs are out of range. INTERNAL: if the tasks fail to start for internal errors.

  • repeated uint32 started = 1

    The set of instance IDs that have been started.

  • repeated uint32 failed = 2

    The set of instance IDs that are failed to start.

• rpc StopTasks (StopTasksRequest, StopTasksResponse)

  task_svc.proto:36

  Stop a set of tasks for a job. Will be no-op for tasks that are currently stopped. The tasks are stopped asynchronously after the API call returns.

  message StopTasksRequest

  task_svc.proto:149

  * Request message for TaskService.StopTasks method.

  • optional peloton.JobID jobId = 1

    The job ID of the tasks to stop.

  • repeated InstanceRange ranges = 2

    The instance ID ranges of the tasks to stop. If you dont specify any range it will signal all instance IDs to stop.

  message StopTasksResponse

  task_svc.proto:167

  * Response message for TaskService.StopTasks method. Return errors: NOT_FOUND: if the job ID is not found in Peloton. OUT_OF_RANGE: if the instance IDs are out of range. INTERNAL: if the tasks fail to stop for internal errors.

  • repeated uint32 stopped = 1

    The set of instance IDs that have been signalled to be stopped. These instanced IDs will be asynchronously stopped.

  • repeated uint32 failed = 2

    The set of instance IDs that have failed to be signalled successfuly.

• rpc RestartTasks (RestartTasksRequest, RestartTasksResponse)

  task_svc.proto:40

  Restart a set of tasks for a job. Will start tasks that are currently stopped. This is an asynchronous call.

  message RestartTasksRequest

  task_svc.proto:180

  * Request message for TaskService.RestartTasks method.

  • optional peloton.JobID jobId = 1

    The job ID of the tasks to restart.

  • repeated InstanceRange ranges = 2

    The instance ID ranges of the tasks to restart.

  message RestartTasksResponse

  task_svc.proto:197

  * Response message for TaskService.RestartTasks method. Return errors: NOT_FOUND: if the job ID is not found. OUT_OF_RANGE: if the instance IDs are out of range. INTERNAL: if the tasks fail to restart for internal errors.

  • repeated uint32 stopped = 1

    The set of instance IDs that have been stopped.

  • repeated uint32 failed = 2

    The set of instance IDs that are failed to stop.

• rpc QueryTasks (QueryTasksRequest, QueryTasksResponse)

  task_svc.proto:43

  Query task info in a job, using a set of filters.

  message QueryTasksRequest

  task_svc.proto:209

  * Request message for TaskService.QueryTasks method.

  • optional peloton.JobID jobId = 1

    The job ID of the tasks to query.

  • optional QuerySpec spec = 2

    The spec of query criteria for the tasks.

  • optional query.PaginationSpec pagination = 3

    The spec of how to do pagination for the query results.

  message QueryTasksResponse

  task_svc.proto:228

  * Response message for TaskService.QueryTasks method. Return errors: NOT_FOUND: if the job ID is not found. INTERNAL: if fail to query the tasks for internal errors.

  • repeated TaskInfo records = 1

    List of tasks that match the task query criteria.

  • optional query.Pagination pagination = 2

    Pagination result of the task query.

• rpc BrowseSandbox (BrowseSandboxRequest, BrowseSandboxResponse)

  task_svc.proto:48

  BrowseSandbox returns list of file paths inside sandbox. The client can use the Mesos Agent HTTP endpoints to read and download the files. http://mesos.apache.org/documentation/latest/endpoints/

  message BrowseSandboxRequest

  task_svc.proto:240

  * Request message for TaskService.BrowseSandbox method.

  • optional peloton.JobID jobId = 1

    The job ID of the task to browse the sandbox.

  • uint32 instanceId = 2

    The instance ID of the task to browse the sandbox.

  • string taskId = 3

    Get the sandbox path of a particular task of an instance. This should be set to the mesos task id in the runtime of the task for which the sandbox is being requested. If not provided, the path of the latest task is returned.

  message BrowseSandboxResponse

  task_svc.proto:264

  * Response message for TaskService.BrowseSandbox method. Return errors: NOT_FOUND: if the job ID is not found. OUT_OF_RANGE: if the instance IDs are out of range. INTERNAL: if fail to browse the sandbox for internal errors. FAILED_PRECONDITION: if the task has not been run yet.

  • string hostname = 2

    The hostname of the sandbox.

  • string port = 3

    The port of the sandbox.

  • repeated string paths = 4

    The list of sandbox file paths. TODO: distinguish files and directories in the sandbox

  • string mesosMasterHostname = 5

    Mesos Master hostname and port.

  • string mesosMasterPort = 6

• rpc RefreshTasks (RefreshTasksRequest, RefreshTasksResponse)

  task_svc.proto:52

  Debug only method. Allows user to load task runtime state from DB and re-execute the action associated with current state.

  message RefreshTasksRequest

  task_svc.proto:359

  * Request message for TaskService.RefreshTasks method.

  • optional peloton.JobID jobId = 1

    The job ID of the tasks to list.

  • optional InstanceRange range = 2

    The instance ID range of the tasks to refresh.

  message RefreshTasksResponse

  task_svc.proto:374

  * Response message for TaskService.RefreshTasks method. Return errors: NOT_FOUND: if the job or tasks are not found.

  (message has no fields)

• rpc GetTaskCache (GetTaskCacheRequest, GetTaskCacheResponse)

  task_svc.proto:55

  Debug only method. Get the cache of a task stored in Peloton.

  message GetTaskCacheRequest

  task_svc.proto:379

  * Request message for TaskService.GetTaskCache method.

  • optional peloton.JobID jobId = 1

    The job ID to look up the task.

  • uint32 instanceId = 2

    The instance ID of the task to get.

  message GetTaskCacheResponse

  task_svc.proto:394

  * Response message for TaskService.GetTaskCache method. Return errors: NOT_FOUND: if the job or task not found in cache. INTERNAL_ERROR: if fail to read cache due to internal error.

  • optional RuntimeInfo runtime = 1

    The task runtime of the task.

• rpc GetPodEvents (GetPodEventsRequest, GetPodEventsResponse)

  task_svc.proto:59

  GetPodEvents returns pod events (state transition for a pod), in reverse chronological order. pod is singular instance of a Peloton job.

  message GetPodEventsRequest

  task_svc.proto:329

  * Request message for TaskService.GetPodEvents method.

  • optional peloton.JobID jobId = 1

    The job ID of the task

  • uint32 instanceId = 2

    The instance ID of the task

  • uint64 limit = 3

    Limit of events

  message GetPodEventsResponse

  task_svc.proto:346

  * Response message for TaskService.GetPodEvents method. Return errors: INTERNAL: if failed to get pod events for internal errors.

  • repeated PodEvent result = 1

  • optional GetPodEventsResponse.Error error = 2

Used in: GetPodEventsResponse

• string message = 1

* Pod event of a Peloton pod instance.

Used in: GetPodEventsResponse

• optional peloton.TaskID taskId = 1

  The task ID of the task event.

• string actualState = 2

  Actual state of an instance

• string goalState = 3

  Goal State of an instance

• string timestamp = 4

  The time when the event was created. The time is represented in RFC3339 form with UTC timezone.

• uint64 configVersion = 5

  The config version currently used by the runtime.

• uint64 desiredConfigVersion = 6

  The desired config version that should be used by the runtime.

• string agentID = 7

  The agentID for the task

• string hostname = 8

  The host on which the task is running

• string message = 9

  Short human friendly message explaining state.

• string reason = 10

  The short reason for the task event

• optional peloton.TaskID prevTaskId = 11

  The previous task ID of the pod event.

• string healthy = 12

  The health check state of the task

• string message = 1