package peloton.api.v1alpha.pod.svc

Get desktop application:
View/edit binary Protocol Buffers messages

Pod service defines the pod related methods.

Methods which mutate the state of the pod.

• rpc StartPod (StartPodRequest, StartPodResponse)

  pod_svc.proto:172

  Start the pod. Will be a no-op for pod that is currently running. The pod is started asynchronously after the API call returns.

  message StartPodRequest

  pod_svc.proto:14

  Request message for PodService.StartPod method

  • optional peloton.PodName pod_name = 1

    The pod name.

  message StartPodResponse

  pod_svc.proto:22

  Response message for PodService.StartPod method Return errors: NOT_FOUND: if the pod is not found.

  (message has no fields)

• rpc StopPod (StopPodRequest, StopPodResponse)

  pod_svc.proto:176

  Stop the pod. Will be no-op for a pod that is currently stopped. The pod is stopped asynchronously after the API call returns.

  message StopPodRequest

  pod_svc.proto:25

  Request message for PodService.StopPod method

  • optional peloton.PodName pod_name = 1

    The pod name.

  message StopPodResponse

  pod_svc.proto:33

  Response message for PodService.StopPod method Return errors: NOT_FOUND: if the pod is not found.

  (message has no fields)

• rpc RestartPod (RestartPodRequest, RestartPodResponse)

  pod_svc.proto:181

  Restart a the pod. Will start a pod that is currently stopped. Will first stop the pod that is currently running and then start it again. This is an asynchronous call.

  message RestartPodRequest

  pod_svc.proto:36

  Request message for PodService.RestartPod method

  • optional peloton.PodName pod_name = 1

    The pod name.

  • bool check_sla = 2

    When set to true, restart would fail with error, if it is going to violate job SLA

  message RestartPodResponse

  pod_svc.proto:49

  Response message for PodService.RestartPod method Return errors: NOT_FOUND: if the pod is not found. ABORTED: if check_sla is set to true, and the pod restart would violate job SLA

  (message has no fields)

• rpc GetPod (GetPodRequest, GetPodResponse)

  pod_svc.proto:187

  Get the info of a pod in a job. Return the current run as well as the terminal state of previous runs.

  message GetPodRequest

  pod_svc.proto:52

  Request message for PodService.GetPod method

  • optional peloton.PodName pod_name = 1

    The pod name.

  • bool status_only = 2

    If set to true, only return the pod status and not the configuration.

  • uint32 limit = 4

    If set to true, only return current run of the pod.

  message GetPodResponse

  pod_svc.proto:66

  Response message for PodService.GetPod method Return errors: NOT_FOUND: if the pod is not found.

  • optional PodInfo current = 1

    Returns the status and configuration (if requested) for the current run of the pod.

  • repeated PodInfo previous = 2

    Returns the status and configuration (if requested) for previous runs of the pod.

• rpc GetPodEvents (GetPodEventsRequest, GetPodEventsResponse)

  pod_svc.proto:191

  Get the state transitions for a pod (pod events) for a given run of the pod.

  message GetPodEventsRequest

  pod_svc.proto:77

  Request message for PodService.GetPodEvents method

  • optional peloton.PodName pod_name = 1

    The pod name.

  • optional peloton.PodID pod_id = 2

    Get the events of a particular pod identified using the pod identifier. If not provided, events for the latest pod are returned.

  message GetPodEventsResponse

  pod_svc.proto:89

  Response message for PodService.GetPodEvents method Return errors: NOT_FOUND: if the pod is not found.

  • repeated PodEvent events = 1

• rpc BrowsePodSandbox (BrowsePodSandboxRequest, BrowsePodSandboxResponse)

  pod_svc.proto:196

  Return the list of file paths inside the sandbox for a given run of a pod. The client can use the Mesos Agent HTTP endpoints to read and download the files. http://mesos.apache.org/documentation/latest/endpoints/

  message BrowsePodSandboxRequest

  pod_svc.proto:94

  Request message for PodService.BrowsePodSandbox method

  • optional peloton.PodName pod_name = 1

    The pod name.

  • optional peloton.PodID pod_id = 2

    Get the sandbox path of a particular pod identified using the pod identifier. If not provided, the sandbox path for the latest pod is returned.

  message BrowsePodSandboxResponse

  pod_svc.proto:107

  Response message for PodService.BrowsePodSandbox method Return errors: NOT_FOUND: if the pod is not found. ABORT: if the pod has not been run.

  • string hostname = 1

    The hostname of the sandbox.

  • string port = 2

    The port of the sandbox.

  • repeated string paths = 3

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

  • string mesos_master_hostname = 4

    Mesos Master hostname and port.

  • string mesos_master_port = 5

• rpc RefreshPod (RefreshPodRequest, RefreshPodResponse)

  pod_svc.proto:203

  Allows user to load pod runtime state from DB and re-execute the action associated with current state.

  message RefreshPodRequest

  pod_svc.proto:124

  Request message for PodService.RefreshPod method

  • optional peloton.PodName pod_name = 1

    The pod name.

  message RefreshPodResponse

  pod_svc.proto:132

  Response message for PodService.RefreshPod method Return errors: NOT_FOUND: if the pod is not found.

  (message has no fields)

• rpc GetPodCache (GetPodCacheRequest, GetPodCacheResponse)

  pod_svc.proto:206

  Get the cache of a pod stored in Peloton.

  message GetPodCacheRequest

  pod_svc.proto:135

  Request message for PodService.GetPodCache method

  • optional peloton.PodName pod_name = 1

    The pod name.

  message GetPodCacheResponse

  pod_svc.proto:143

  Response message for PodService.GetPodCache method Return errors: NOT_FOUND: if the pod is not found.

  • optional PodStatus status = 1

    The runtime status of the pod.

  • repeated peloton.Label labels = 2

    The labels of the pod.

• rpc DeletePodEvents (DeletePodEventsRequest, DeletePodEventsResponse)

  pod_svc.proto:210

  Delete the events of a given run of a pod. This is used to prevent the events for a given pod from growing without bounds.

  message DeletePodEventsRequest

  pod_svc.proto:152

  Request message for PodService.DeletePodEvents method

  • optional peloton.PodName pod_name = 1

    The pod name.

  • optional peloton.PodID pod_id = 2

    Delete the events of a particular pod identified using the pod identifier.

  message DeletePodEventsResponse

  pod_svc.proto:163

  Response message for PodService.DeletePodEvents method Return errors: NOT_FOUND: if the pod is not found.

  (message has no fields)