package internal.proto.workflow.v2

Get desktop application:
View/edit binary Protocol Buffers messages

WorkflowService is responsible for retrieving workflows to be executed by the agent and publishing events as a workflow executes.

• rpc GetWorkflows (GetWorkflowsRequest, stream GetWorkflowsResponse)

  workflow.proto:12

  GetWorkflows creates a stream that will receive workflows intended for the agent identified by the GetWorkflowsRequest.agent_id.

  message GetWorkflowsRequest

  workflow.proto:18

  • string agent_id = 1

  message GetWorkflowsResponse

  workflow.proto:22

  • oneof cmd

    • GetWorkflowsResponse.StartWorkflow start_workflow = 1

    • GetWorkflowsResponse.StopWorkflow stop_workflow = 2

• rpc PublishEvent (PublishEventRequest, PublishEventResponse)

  workflow.proto:15

  PublishEvent publishes a workflow event.

  message PublishEventRequest

  workflow.proto:37

  • optional Event event = 1

  message PublishEventResponse

  workflow.proto:41

  (message has no fields)

Used in: PublishEventRequest

• string workflow_id = 1

  A unique identifier for a workflow.

• oneof event

  • Event.ActionStarted action_started = 2

  • Event.ActionSucceeded action_succeeded = 3

  • Event.ActionFailed action_failed = 4

  • Event.WorkflowRejected workflow_rejected = 5

Used in: Event

• string action_id = 1

  A unique identifier for an action in the context of a workflow.

• optional string failure_reason = 2

  A UpperCamelCase word or phrase concisly describing why an action failed. It is typically provided by the action itself.

• optional string failure_message = 3

  A free-form human readable string elaborating on the reason for failure. It is typically provided by the action itself.

Used in: Event

• string action_id = 1

  A unique identifier for an action in the context of a workflow.

Used in: Event

• string action_id = 1

  A unique identifier for an action in the context of a workflow.

Used in: Event

• string message = 2

  A message describing why the workflow was rejected.

Used in: GetWorkflowsResponse

• optional Workflow workflow = 1

Used in: GetWorkflowsResponse

• string workflow_id = 1

Used in: GetWorkflowsResponse.StartWorkflow

• string workflow_id = 1

  A unique identifier for a workflow.

• repeated Workflow.Action actions = 2

  The actions that make up the workflow.

Used in: Workflow

• string id = 1

  A unique identifier for an action in the context of a workflow.

• string name = 2

  The name of the action. This can be used to identify actions in logging.

• string image = 3

  The image to run.

• optional string cmd = 4

  The command to execute when launching the image. When using Docker as the action runtime it is used as the entrypoint.

• repeated string args = 5

  Arguments to pass to the container.

• map<string, string> env = 6

  Environment variables to configure when launching the container.

• repeated string volumes = 7

  Volumes to mount when launching the container.

• optional string network_namespace = 8

  The network namespace to launch the container in.