flytekit.models.core.workflow
Directory
Classes
flytekit.models.core.workflow.Alias
def Alias(
var,
alias,
):
Links a variable to an alias.
Methods
from_flyte_idl()
def from_flyte_idl(
pb2_object,
):
Parameter |
Type |
pb2_object |
|
serialize_to_string()
def serialize_to_string()
short_string()
to_flyte_idl()
verbose_string()
Properties
Property |
Type |
Description |
alias |
|
|
is_empty |
|
|
var |
|
|
flytekit.models.core.workflow.ApproveCondition
def ApproveCondition(
signal_id: str,
):
Represents a dependency on an signal from a user.
Parameter |
Type |
signal_id |
str |
Methods
from_flyte_idl()
def from_flyte_idl(
pb2_object: flyteidl.core.workflow_pb2.ApproveCondition,
):
Parameter |
Type |
pb2_object |
flyteidl.core.workflow_pb2.ApproveCondition |
serialize_to_string()
def serialize_to_string()
short_string()
to_flyte_idl()
verbose_string()
Properties
Property |
Type |
Description |
is_empty |
|
|
signal_id |
|
|
flytekit.models.core.workflow.ArrayNode
def ArrayNode(
node: Node,
parallelism,
min_successes,
min_success_ratio,
execution_mode,
is_original_sub_node_interface,
data_mode,
bound_inputs,
):
TODO: docstring
Parameter |
Type |
node |
Node |
parallelism |
|
min_successes |
|
min_success_ratio |
|
execution_mode |
|
is_original_sub_node_interface |
|
data_mode |
|
bound_inputs |
|
Methods
from_flyte_idl()
def from_flyte_idl(
pb2_object,
):
Parameter |
Type |
pb2_object |
|
serialize_to_string()
def serialize_to_string()
short_string()
to_flyte_idl()
verbose_string()
Properties
Property |
Type |
Description |
is_empty |
|
|
node |
|
|
flytekit.models.core.workflow.BoolValue
A ProtocolMessage
flytekit.models.core.workflow.BranchNode
def BranchNode(
if_else: flytekit.models.core.workflow.IfElseBlock,
):
BranchNode is a special node that alter the flow of the workflow graph. It allows the control flow to branch at
runtime based on a series of conditions that get evaluated on various parameters (e.g. inputs, primitives).
Parameter |
Type |
if_else |
flytekit.models.core.workflow.IfElseBlock |
Methods
from_flyte_idl()
def from_flyte_idl(
pb2_objct,
):
serialize_to_string()
def serialize_to_string()
short_string()
to_flyte_idl()
verbose_string()
Properties
Property |
Type |
Description |
if_else |
|
|
is_empty |
|
|
flytekit.models.core.workflow.GateNode
def GateNode(
signal: typing.Optional[flytekit.models.core.workflow.SignalCondition],
sleep: typing.Optional[flytekit.models.core.workflow.SleepCondition],
approve: typing.Optional[flytekit.models.core.workflow.ApproveCondition],
):
Parameter |
Type |
signal |
typing.Optional[flytekit.models.core.workflow.SignalCondition] |
sleep |
typing.Optional[flytekit.models.core.workflow.SleepCondition] |
approve |
typing.Optional[flytekit.models.core.workflow.ApproveCondition] |
Methods
from_flyte_idl()
def from_flyte_idl(
pb2_object: flyteidl.core.workflow_pb2.GateNode,
):
Parameter |
Type |
pb2_object |
flyteidl.core.workflow_pb2.GateNode |
serialize_to_string()
def serialize_to_string()
short_string()
to_flyte_idl()
verbose_string()
Properties
Property |
Type |
Description |
approve |
|
|
condition |
|
|
is_empty |
|
|
signal |
|
|
sleep |
|
|
flytekit.models.core.workflow.IfBlock
def IfBlock(
condition,
then_node,
):
Defines a condition and the execution unit that should be executed if the condition is satisfied.
Parameter |
Type |
condition |
|
then_node |
|
Methods
from_flyte_idl()
def from_flyte_idl(
pb2_object,
):
Parameter |
Type |
pb2_object |
|
serialize_to_string()
def serialize_to_string()
short_string()
to_flyte_idl()
verbose_string()
Properties
Property |
Type |
Description |
condition |
|
|
is_empty |
|
|
then_node |
|
|
flytekit.models.core.workflow.IfElseBlock
def IfElseBlock(
case,
other,
else_node,
error,
):
Defines a series of if/else blocks. The first branch whose condition evaluates to true is the one to execute.
If no conditions were satisfied, the else_node or the error will execute.
Parameter |
Type |
case |
|
other |
|
else_node |
|
error |
|
Methods
from_flyte_idl()
def from_flyte_idl(
pb2_object,
):
Parameter |
Type |
pb2_object |
|
serialize_to_string()
def serialize_to_string()
short_string()
to_flyte_idl()
verbose_string()
Properties
Property |
Type |
Description |
case |
|
|
else_node |
|
|
error |
|
|
is_empty |
|
|
other |
|
|
def K8sObjectMetadata(
labels: typing.Dict[str, str],
annotations: typing.Dict[str, str],
):
This defines additional metadata for building a kubernetes pod.
Parameter |
Type |
labels |
typing.Dict[str, str] |
annotations |
typing.Dict[str, str] |
Methods
from_flyte_idl()
def from_flyte_idl(
pb2_object: flyteidl.core.tasks_pb2.K8sObjectMetadata,
):
Parameter |
Type |
pb2_object |
flyteidl.core.tasks_pb2.K8sObjectMetadata |
serialize_to_string()
def serialize_to_string()
short_string()
to_flyte_idl()
verbose_string()
Properties
Property |
Type |
Description |
annotations |
|
|
is_empty |
|
|
labels |
|
|
flytekit.models.core.workflow.Node
def Node(
id,
metadata,
inputs,
upstream_node_ids,
output_aliases,
task_node,
workflow_node,
branch_node,
gate_node: typing.Optional[flytekit.models.core.workflow.GateNode],
array_node: typing.Optional[flytekit.models.core.workflow.ArrayNode],
):
A Workflow graph Node. One unit of execution in the graph. Each node can be linked to a Task,
a Workflow or a branch node. One of the nodes must be specified.
Parameter |
Type |
id |
|
metadata |
|
inputs |
|
upstream_node_ids |
|
output_aliases |
|
task_node |
|
workflow_node |
|
branch_node |
|
gate_node |
typing.Optional[flytekit.models.core.workflow.GateNode] |
array_node |
typing.Optional[flytekit.models.core.workflow.ArrayNode] |
Methods
from_flyte_idl()
def from_flyte_idl(
pb2_object,
):
Parameter |
Type |
pb2_object |
|
serialize_to_string()
def serialize_to_string()
short_string()
to_flyte_idl()
verbose_string()
Properties
Property |
Type |
Description |
array_node |
|
|
branch_node |
|
|
gate_node |
|
|
id |
|
|
inputs |
|
|
is_empty |
|
|
metadata |
|
|
output_aliases |
|
|
target |
|
|
task_node |
|
|
upstream_node_ids |
|
|
workflow_node |
|
|
def NodeMetadata(
name,
timeout,
retries,
interruptible: typing.Optional[bool],
cacheable: typing.Optional[bool],
cache_version: typing.Optional[str],
cache_serializable: typing.Optional[bool],
):
Defines extra information about the Node.
Parameter |
Type |
name |
|
timeout |
|
retries |
|
interruptible |
typing.Optional[bool] |
cacheable |
typing.Optional[bool] |
cache_version |
typing.Optional[str] |
cache_serializable |
typing.Optional[bool] |
Methods
from_flyte_idl()
def from_flyte_idl(
pb2_object,
):
Parameter |
Type |
pb2_object |
|
serialize_to_string()
def serialize_to_string()
short_string()
to_flyte_idl()
verbose_string()
Properties
Property |
Type |
Description |
cache_serializable |
|
|
cache_version |
|
|
cacheable |
|
|
interruptible |
|
|
is_empty |
|
|
name |
|
|
retries |
|
|
timeout |
|
|
flytekit.models.core.workflow.PodTemplate
Custom PodTemplate specification for a Task.
def PodTemplate(
pod_spec: typing.Optional[ForwardRef('V1PodSpec')],
primary_container_name: str,
labels: typing.Optional[typing.Dict[str, str]],
annotations: typing.Optional[typing.Dict[str, str]],
):
Parameter |
Type |
pod_spec |
typing.Optional[ForwardRef('V1PodSpec')] |
primary_container_name |
str |
labels |
typing.Optional[typing.Dict[str, str]] |
annotations |
typing.Optional[typing.Dict[str, str]] |
flytekit.models.core.workflow.Resources
def Resources(
requests,
limits,
):
Parameter |
Type |
requests |
|
limits |
|
Methods
from_flyte_idl()
def from_flyte_idl(
pb2_object,
):
Parameter |
Type |
pb2_object |
|
serialize_to_string()
def serialize_to_string()
short_string()
to_flyte_idl()
verbose_string()
Properties
Property |
Type |
Description |
is_empty |
|
|
limits |
|
|
requests |
|
|
flytekit.models.core.workflow.SignalCondition
def SignalCondition(
signal_id: str,
type: flytekit.models.types.LiteralType,
output_variable_name: str,
):
Represents a dependency on an signal from a user.
Parameter |
Type |
signal_id |
str |
type |
flytekit.models.types.LiteralType |
output_variable_name |
str |
Methods
from_flyte_idl()
def from_flyte_idl(
pb2_object: flyteidl.core.workflow_pb2.SignalCondition,
):
Parameter |
Type |
pb2_object |
flyteidl.core.workflow_pb2.SignalCondition |
serialize_to_string()
def serialize_to_string()
short_string()
to_flyte_idl()
verbose_string()
Properties
Property |
Type |
Description |
is_empty |
|
|
output_variable_name |
|
|
signal_id |
|
|
type |
|
|
flytekit.models.core.workflow.SleepCondition
def SleepCondition(
duration: datetime.timedelta,
):
A sleep condition.
Parameter |
Type |
duration |
datetime.timedelta |
Methods
from_flyte_idl()
def from_flyte_idl(
pb2_object: flyteidl.core.workflow_pb2.SignalCondition,
):
Parameter |
Type |
pb2_object |
flyteidl.core.workflow_pb2.SignalCondition |
serialize_to_string()
def serialize_to_string()
short_string()
to_flyte_idl()
verbose_string()
Properties
Property |
Type |
Description |
duration |
|
|
is_empty |
|
|
flytekit.models.core.workflow.TaskNode
def TaskNode(
reference_id,
overrides: typing.Optional[flytekit.models.core.workflow.TaskNodeOverrides],
):
Refers to the task that the Node is to execute.
This is currently a oneof in protobuf, but there’s only one option currently.
This code should be updated when more options are available.
Parameter |
Type |
reference_id |
|
overrides |
typing.Optional[flytekit.models.core.workflow.TaskNodeOverrides] |
Methods
from_flyte_idl()
def from_flyte_idl(
pb2_object,
):
Parameter |
Type |
pb2_object |
|
serialize_to_string()
def serialize_to_string()
short_string()
to_flyte_idl()
verbose_string()
Properties
Property |
Type |
Description |
is_empty |
|
|
overrides |
|
|
reference_id |
|
|
flytekit.models.core.workflow.TaskNodeOverrides
def TaskNodeOverrides(
resources: typing.Optional[flytekit.models.task.Resources],
extended_resources: typing.Optional[flyteidl.core.tasks_pb2.ExtendedResources],
container_image: typing.Optional[str],
pod_template: typing.Optional[flytekit.core.pod_template.PodTemplate],
):
Parameter |
Type |
resources |
typing.Optional[flytekit.models.task.Resources] |
extended_resources |
typing.Optional[flyteidl.core.tasks_pb2.ExtendedResources] |
container_image |
typing.Optional[str] |
pod_template |
typing.Optional[flytekit.core.pod_template.PodTemplate] |
Methods
from_flyte_idl()
def from_flyte_idl(
pb2_object,
):
Parameter |
Type |
pb2_object |
|
serialize_to_string()
def serialize_to_string()
short_string()
to_flyte_idl()
verbose_string()
Properties
Property |
Type |
Description |
container_image |
|
|
extended_resources |
|
|
is_empty |
|
|
pod_template |
|
|
resources |
|
|
def WorkflowMetadata(
on_failure,
):
Metadata for the workflow.
Parameter |
Type |
on_failure |
|
Methods
from_flyte_idl()
def from_flyte_idl(
pb2_object,
):
Parameter |
Type |
pb2_object |
|
serialize_to_string()
def serialize_to_string()
short_string()
to_flyte_idl()
verbose_string()
Properties
Property |
Type |
Description |
is_empty |
|
|
on_failure |
|
|
def WorkflowMetadataDefaults(
interruptible,
):
Metadata Defaults for the workflow.
Parameter |
Type |
interruptible |
|
Methods
from_flyte_idl()
def from_flyte_idl(
pb2_object,
):
Parameter |
Type |
pb2_object |
|
serialize_to_string()
def serialize_to_string()
short_string()
to_flyte_idl()
verbose_string()
Properties
Property |
Type |
Description |
interruptible |
|
|
is_empty |
|
|
flytekit.models.core.workflow.WorkflowNode
def WorkflowNode(
launchplan_ref,
sub_workflow_ref,
):
Refers to a the workflow the node is to execute. One of the references must be supplied.
Parameter |
Type |
launchplan_ref |
|
sub_workflow_ref |
|
Methods
from_flyte_idl()
def from_flyte_idl(
pb2_object,
):
Parameter |
Type |
pb2_object |
|
serialize_to_string()
def serialize_to_string()
short_string()
to_flyte_idl()
verbose_string()
Properties
Property |
Type |
Description |
is_empty |
|
|
launchplan_ref |
|
|
reference |
|
|
sub_workflow_ref |
|
|
flytekit.models.core.workflow.WorkflowTemplate
def WorkflowTemplate(
id,
metadata,
metadata_defaults,
interface,
nodes,
outputs,
failure_node,
):
A workflow template encapsulates all the task, branch, and subworkflow nodes to run a statically analyzable,
directed acyclic graph. It contains also metadata that tells the system how to execute the workflow (i.e.
the AWS IAM role to run with).
Parameter |
Type |
id |
|
metadata |
|
metadata_defaults |
|
interface |
|
nodes |
|
outputs |
|
failure_node |
|
Methods
from_flyte_idl()
def from_flyte_idl(
pb2_object,
):
Parameter |
Type |
pb2_object |
|
serialize_to_string()
def serialize_to_string()
short_string()
to_flyte_idl()
verbose_string()
Properties
Property |
Type |
Description |
failure_node |
|
|
id |
|
|
interface |
|
|
is_empty |
|
|
metadata |
|
|
metadata_defaults |
|
|
nodes |
|
|
outputs |
|
|