execution.proto

flyteidl.admin.ExecutionCreateRequest

[flyteidl.admin.ExecutionCreateRequest proto]

Request to launch an execution with the given project, domain and optionally name.

{
  "project": "...",
  "domain": "...",
  "name": "...",
  "spec": "{...}",
  "inputs": "{...}"
}
project

(string) Name of the project the execution belongs to.

domain

(string) Name of the domain the execution belongs to. A domain can be considered as a subset within a specific project.

name

(string) User provided value for the resource. If none is provided the system will generate a unique string. +optional

spec

(flyteidl.admin.ExecutionSpec) Additional fields necessary to launch the execution.

inputs

(flyteidl.core.LiteralMap) The inputs required to start the execution. All required inputs must be included in this map. If not required and not provided, defaults apply.

flyteidl.admin.ExecutionRelaunchRequest

[flyteidl.admin.ExecutionRelaunchRequest proto]

Request to relaunch the referenced execution.

{
  "id": "{...}",
  "name": "..."
}
id

(flyteidl.core.WorkflowExecutionIdentifier) Identifier of the workflow execution to relaunch.

name

(string) User provided value for the relaunched execution. If none is provided the system will generate a unique string. +optional

flyteidl.admin.ExecutionCreateResponse

[flyteidl.admin.ExecutionCreateResponse proto]

The unique identifier for a successfully created execution. If the name was not specified in the create request, this identifier will include a generated name.

{
  "id": "{...}"
}
id

(flyteidl.core.WorkflowExecutionIdentifier)

flyteidl.admin.WorkflowExecutionGetRequest

[flyteidl.admin.WorkflowExecutionGetRequest proto]

A message used to fetch a single workflow execution entity.

{
  "id": "{...}"
}
id

(flyteidl.core.WorkflowExecutionIdentifier) Uniquely identifies an individual workflow execution.

flyteidl.admin.Execution

[flyteidl.admin.Execution proto]

A workflow execution represents an instantiated workflow, including all inputs and additional metadata as well as computed results included state, outputs, and duration-based attributes. Used as a response object used in Get and List execution requests.

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

(flyteidl.core.WorkflowExecutionIdentifier) Unique identifier of the workflow execution.

spec

(flyteidl.admin.ExecutionSpec) User-provided configuration and inputs for launching the execution.

closure

(flyteidl.admin.ExecutionClosure) Execution results.

flyteidl.admin.ExecutionList

[flyteidl.admin.ExecutionList proto]

Used as a response for request to list executions.

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

(flyteidl.admin.Execution)

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.LiteralMapBlob

[flyteidl.admin.LiteralMapBlob proto]

Input/output data can represented by actual values or a link to where values are stored

{
  "values": "{...}",
  "uri": "..."
}
values

(flyteidl.core.LiteralMap) Data in LiteralMap format

Only one of values, uri may be set.

uri

(string) In the event that the map is too large, we return a uri to the data

Only one of values, uri may be set.

flyteidl.admin.AbortMetadata

[flyteidl.admin.AbortMetadata proto]

{
  "cause": "...",
  "principal": "..."
}
cause

(string) In the case of a user-specified abort, this will pass along the user-supplied cause.

principal

(string) Identifies the entity (if any) responsible for terminating the execution

flyteidl.admin.ExecutionClosure

[flyteidl.admin.ExecutionClosure proto]

Encapsulates the results of the Execution

{
  "outputs": "{...}",
  "error": "{...}",
  "abort_cause": "...",
  "abort_metadata": "{...}",
  "computed_inputs": "{...}",
  "phase": "...",
  "started_at": "{...}",
  "duration": "{...}",
  "created_at": "{...}",
  "updated_at": "{...}",
  "notifications": [],
  "workflow_id": "{...}"
}
outputs

(flyteidl.admin.LiteralMapBlob) A map of outputs in the case of a successful execution.

A result produced by a terminated execution. A pending (non-terminal) execution will not have any output result.

Only one of outputs, error, abort_cause, abort_metadata may be set.

error

(flyteidl.core.ExecutionError) Error information in the case of a failed execution.

A result produced by a terminated execution. A pending (non-terminal) execution will not have any output result.

Only one of outputs, error, abort_cause, abort_metadata may be set.

abort_cause

(string) In the case of a user-specified abort, this will pass along the user-supplied cause.

A result produced by a terminated execution. A pending (non-terminal) execution will not have any output result.

Only one of outputs, error, abort_cause, abort_metadata may be set.

abort_metadata

(flyteidl.admin.AbortMetadata) In the case of a user-specified abort, this will pass along the user and their supplied cause.

A result produced by a terminated execution. A pending (non-terminal) execution will not have any output result.

Only one of outputs, error, abort_cause, abort_metadata may be set.

computed_inputs

(flyteidl.core.LiteralMap) Inputs computed and passed for execution. computed_inputs depends on inputs in ExecutionSpec, fixed and default inputs in launch plan

phase

(flyteidl.core.WorkflowExecution.Phase) Most recent recorded phase for the execution.

started_at

(google.protobuf.Timestamp) Reported ime at which the execution began running.

duration

(google.protobuf.Duration) The amount of time the execution spent running.

created_at

(google.protobuf.Timestamp) Reported time at which the execution was created.

updated_at

(google.protobuf.Timestamp) Reported time at which the execution was last updated.

notifications

(flyteidl.admin.Notification) The notification settings to use after merging the CreateExecutionRequest and the launch plan notification settings. An execution launched with notifications will always prefer that definition to notifications defined statically in a launch plan.

workflow_id

(flyteidl.core.Identifier) Identifies the workflow definition for this execution.

flyteidl.admin.SystemMetadata

[flyteidl.admin.SystemMetadata proto]

Represents system rather than user-facing metadata about an execution.

{
  "execution_cluster": "..."
}
execution_cluster

(string) Which execution cluster this execution ran on.

flyteidl.admin.ExecutionMetadata

[flyteidl.admin.ExecutionMetadata proto]

Represents attributes about an execution which are not required to launch the execution but are useful to record. These attributes are assigned at launch time and do not change.

{
  "mode": "...",
  "principal": "...",
  "nesting": "...",
  "scheduled_at": "{...}",
  "parent_node_execution": "{...}",
  "reference_execution": "{...}",
  "system_metadata": "{...}"
}
mode

(flyteidl.admin.ExecutionMetadata.ExecutionMode)

principal

(string) Identifier of the entity that triggered this execution. For systems using back-end authentication any value set here will be discarded in favor of the authenticated user context.

nesting

(uint32) Indicates the “nestedness” of this execution. If a user launches a workflow execution, the default nesting is 0. If this execution further launches a workflow (child workflow), the nesting level is incremented by 0 => 1 Generally, if workflow at nesting level k launches a workflow then the child workflow will have nesting = k + 1.

scheduled_at

(google.protobuf.Timestamp) For scheduled executions, the requested time for execution for this specific schedule invocation.

parent_node_execution

(flyteidl.core.NodeExecutionIdentifier) Which subworkflow node launched this execution

reference_execution

(flyteidl.core.WorkflowExecutionIdentifier) Optional, a reference workflow execution related to this execution. In the case of a relaunch, this references the original workflow execution.

system_metadata

(flyteidl.admin.SystemMetadata) Optional, platform-specific metadata about the execution. In this the future this may be gated behind an ACL or some sort of authorization.

Enum flyteidl.admin.ExecutionMetadata.ExecutionMode

[flyteidl.admin.ExecutionMetadata.ExecutionMode proto]

The method by which this execution was launched.

MANUAL

(DEFAULT) ⁣The default execution mode, MANUAL implies that an execution was launched by an individual.

SCHEDULED

⁣A schedule triggered this execution launch.

SYSTEM

⁣A system process was responsible for launching this execution rather an individual.

RELAUNCH

⁣This execution was launched with identical inputs as a previous execution.

CHILD_WORKFLOW

⁣This execution was triggered by another execution.

flyteidl.admin.NotificationList

[flyteidl.admin.NotificationList proto]

{
  "notifications": []
}
notifications

(flyteidl.admin.Notification)

flyteidl.admin.ExecutionSpec

[flyteidl.admin.ExecutionSpec proto]

An ExecutionSpec encompasses all data used to launch this execution. The Spec does not change over the lifetime of an execution as it progresses across phase changes..

{
  "launch_plan": "{...}",
  "inputs": "{...}",
  "metadata": "{...}",
  "notifications": "{...}",
  "disable_all": "...",
  "labels": "{...}",
  "annotations": "{...}"
}
launch_plan

(flyteidl.core.Identifier) Launch plan to be executed

inputs

(flyteidl.core.LiteralMap) Input values to be passed for the execution

metadata

(flyteidl.admin.ExecutionMetadata) Metadata for the execution

notifications

(flyteidl.admin.NotificationList) List of notifications based on Execution status transitions When this list is not empty it is used rather than any notifications defined in the referenced launch plan. When this list is empty, the notifications defined for the launch plan will be applied.

Only one of notifications, disable_all may be set.

disable_all

(bool) This should be set to true if all notifications are intended to be disabled for this execution.

Only one of notifications, disable_all may be set.

labels

(flyteidl.admin.Labels) Labels to apply to the execution resource.

annotations

(flyteidl.admin.Annotations) Annotations to apply to the execution resource.

flyteidl.admin.ExecutionTerminateRequest

[flyteidl.admin.ExecutionTerminateRequest proto]

Request to terminate an in-progress execution. This action is irreversible. If an execution is already terminated, this request will simply be a no-op. This request will fail if it references a non-existent execution. If the request succeeds the phase “ABORTED” will be recorded for the termination with the optional cause added to the output_result.

{
  "id": "{...}",
  "cause": "..."
}
id

(flyteidl.core.WorkflowExecutionIdentifier) Uniquely identifies the individual workflow execution to be terminated.

cause

(string) Optional reason for aborting.

flyteidl.admin.ExecutionTerminateResponse

[flyteidl.admin.ExecutionTerminateResponse proto]

{}

flyteidl.admin.WorkflowExecutionGetDataRequest

[flyteidl.admin.WorkflowExecutionGetDataRequest proto]

Request structure to fetch inputs and output urls for an execution.

{
  "id": "{...}"
}
id

(flyteidl.core.WorkflowExecutionIdentifier) The identifier of the execution for which to fetch inputs and outputs.

flyteidl.admin.WorkflowExecutionGetDataResponse

[flyteidl.admin.WorkflowExecutionGetDataResponse proto]

Response structure for WorkflowExecutionGetDataRequest which contains inputs and outputs for an execution.

{
  "outputs": "{...}",
  "inputs": "{...}"
}
outputs

(flyteidl.admin.UrlBlob) Signed url to fetch a core.LiteralMap of execution outputs.

inputs

(flyteidl.admin.UrlBlob) Signed url to fetch a core.LiteralMap of execution inputs.