0.1.dev2184+g1e0cbe7.d20250401

flytekit.models.admin.workflow

Directory

Classes

Class Description
Workflow
WorkflowClosure
WorkflowSpec

flytekit.models.admin.workflow.Workflow

class Workflow(
    id,
    closure,
)
Parameter Type
id
closure

Methods

Method Description
from_flyte_idl() .
serialize_to_string()
short_string() :rtype: Text.
to_flyte_idl() :rtype: flyteidl.
verbose_string() :rtype: Text.

from_flyte_idl()

def from_flyte_idl(
    pb2_object,
) -> n: Workflow
Parameter Type
pb2_object

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

:rtype: Text

to_flyte_idl()

def to_flyte_idl()

:rtype: flyteidl.admin.workflow_pb2.Workflow

verbose_string()

def verbose_string()

:rtype: Text

Properties

Property Type Description
closure
:rtype: WorkflowClosure
id
:rtype: flytekit.models.core.identifier.Identifier
is_empty

flytekit.models.admin.workflow.WorkflowClosure

class WorkflowClosure(
    compiled_workflow,
)
Parameter Type
compiled_workflow

Methods

Method Description
from_flyte_idl() .
serialize_to_string()
short_string() :rtype: Text.
to_flyte_idl() :rtype: flyteidl.
verbose_string() :rtype: Text.

from_flyte_idl()

def from_flyte_idl(
    p,
) -> e: WorkflowClosure
Parameter Type
p

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

:rtype: Text

to_flyte_idl()

def to_flyte_idl()

:rtype: flyteidl.admin.workflow_pb2.WorkflowClosure

verbose_string()

def verbose_string()

:rtype: Text

Properties

Property Type Description
compiled_workflow
:rtype: flytekit.models.core.compiler.CompiledWorkflowClosure
is_empty

flytekit.models.admin.workflow.WorkflowSpec

class WorkflowSpec(
    template: flytekit.models.core.workflow.WorkflowTemplate,
    sub_workflows: typing.List[flytekit.models.core.workflow.WorkflowTemplate],
    docs: typing.Optional[flytekit.models.documentation.Documentation],
)

This object fully encapsulates the specification of a workflow

Parameter Type
template flytekit.models.core.workflow.WorkflowTemplate
sub_workflows typing.List[flytekit.models.core.workflow.WorkflowTemplate]
docs typing.Optional[flytekit.models.documentation.Documentation]

Methods

Method Description
from_flyte_idl() .
serialize_to_string()
short_string() :rtype: Text.
to_flyte_idl() :rtype: flyteidl.
verbose_string() :rtype: Text.

from_flyte_idl()

def from_flyte_idl(
    pb2_object,
) -> e: WorkflowSpec
Parameter Type
pb2_object

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

:rtype: Text

to_flyte_idl()

def to_flyte_idl()

:rtype: flyteidl.admin.workflow_pb2.WorkflowSpec

verbose_string()

def verbose_string()

:rtype: Text

Properties

Property Type Description
docs
:rtype: Description entity for the workflow
is_empty
sub_workflows
:rtype: list[flytekit.models.core.workflow.WorkflowTemplate]
template
:rtype: flytekit.models.core.workflow.WorkflowTemplate