cloudfoundry/warden

// Stream a job.
//
// A stream request is followed by one or more stream responses.
//
// A job is removed after it has completed and the terminating stream response was sent.
//
// > **TODO** Talk about nomenclature (what is a job).
//
// ### Request
//
// * `handle`: Container handle.
// * `job_id`: Job ID.
//
// ### Response
//
// * `name`: Name of stream (either `stdout` or `stderr`).
// * `data`: A chunk of data from the stream specified in `name`.
// * `exit_status`: Exit status of the job. If set, this is the terminating response for the request.
//
// ### Errors
//
// * When `handle` does not refer to a container.
// * When `job_id` does not refer to a job.
//
// ### Definition
//

package warden;

import "info.proto";

message StreamRequest {
  required string handle = 1;

  required uint32 job_id = 2;
}

message StreamResponse {
  optional string name = 1;
  optional string data = 2;
  optional uint32 exit_status = 3;
  optional InfoResponse info = 4;
}