workflow.proto

flyteidl.admin.WorkflowCreateRequest

[flyteidl.admin.WorkflowCreateRequest proto]

Represents a request structure to create a revision of a workflow.

{
  "id": "{...}",
  "spec": "{...}"
}
id

(flyteidl.core.Identifier) id represents the unique identifier of the workflow.

spec

(flyteidl.admin.WorkflowSpec) Represents the specification for workflow.

flyteidl.admin.WorkflowCreateResponse

[flyteidl.admin.WorkflowCreateResponse proto]

{}

flyteidl.admin.Workflow

[flyteidl.admin.Workflow proto]

Represents the workflow structure stored in the Admin A workflow is created by ordering tasks and associating outputs to inputs in order to produce a directed-acyclic execution graph.

{
  "id": "{...}",
  "closure": "{...}"
}
id

(flyteidl.core.Identifier) id represents the unique identifier of the workflow.

closure

(flyteidl.admin.WorkflowClosure) closure encapsulates all the fields that maps to a compiled version of the workflow.

flyteidl.admin.WorkflowList

[flyteidl.admin.WorkflowList proto]

Represents a list of workflows returned from the admin.

{
  "workflows": [],
  "token": "..."
}
workflows

(flyteidl.admin.Workflow) A list of workflows returned based on the request.

token

(string) In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty.

flyteidl.admin.WorkflowSpec

[flyteidl.admin.WorkflowSpec proto]

Represents a structure that encapsulates the specification of the workflow.

{
  "template": "{...}",
  "sub_workflows": []
}
template

(flyteidl.core.WorkflowTemplate) Template of the task that encapsulates all the metadata of the workflow.

sub_workflows

(flyteidl.core.WorkflowTemplate) Workflows that are embedded into other workflows need to be passed alongside the parent workflow to the propeller compiler (since the compiler doesn’t have any knowledge of other workflows - ie, it doesn’t reach out to Admin to see other registered workflows). In fact, subworkflows do not even need to be registered.

flyteidl.admin.WorkflowClosure

[flyteidl.admin.WorkflowClosure proto]

A container holding the compiled workflow produced from the WorkflowSpec and additional metadata.

{
  "compiled_workflow": "{...}",
  "created_at": "{...}"
}
compiled_workflow

(flyteidl.core.CompiledWorkflowClosure) Represents the compiled representation of the workflow from the specification provided.

created_at

(google.protobuf.Timestamp) Time at which the workflow was created.