0.1.dev2184+g1e0cbe7.d20250401

flytekit.core.reference_entity

Directory

Classes

Class Description
LaunchPlanReference A reference object containing metadata that points to a remote launch plan.
Reference
ReferenceEntity
ReferenceSpec
ReferenceTemplate
TaskReference A reference object containing metadata that points to a remote task.
WorkflowReference A reference object containing metadata that points to a remote workflow.

flytekit.core.reference_entity.LaunchPlanReference

A reference object containing metadata that points to a remote launch plan.

class LaunchPlanReference(
    project: str,
    domain: str,
    name: str,
    version: str,
)
Parameter Type
project str
domain str
name str
version str

Properties

Property Type Description
id
resource_type

flytekit.core.reference_entity.Reference

class Reference(
    project: str,
    domain: str,
    name: str,
    version: str,
)
Parameter Type
project str
domain str
name str
version str

Properties

Property Type Description
id
resource_type

flytekit.core.reference_entity.ReferenceEntity

class ReferenceEntity(
    reference: typing.Union[flytekit.core.reference_entity.WorkflowReference, flytekit.core.reference_entity.TaskReference, flytekit.core.reference_entity.LaunchPlanReference],
    inputs: typing.Dict[str, typing.Type],
    outputs: typing.Dict[str, typing.Type],
)
Parameter Type
reference typing.Union[flytekit.core.reference_entity.WorkflowReference, flytekit.core.reference_entity.TaskReference, flytekit.core.reference_entity.LaunchPlanReference]
inputs typing.Dict[str, typing.Type]
outputs typing.Dict[str, typing.Type]

Methods

Method Description
compile()
construct_node_metadata()
execute()
local_execute() Please see the local_execute comments in the main task.
local_execution_mode()
unwrap_literal_map_and_execute() Please see the implementation of the dispatch_execute function in the real task.

compile()

def compile(
    ctx: flytekit.core.context_manager.FlyteContext,
    args,
    kwargs,
)
Parameter Type
ctx flytekit.core.context_manager.FlyteContext
args *args
kwargs **kwargs

construct_node_metadata()

def construct_node_metadata()

execute()

def execute(
    kwargs,
) -> typing.Any
Parameter Type
kwargs **kwargs

local_execute()

def local_execute(
    ctx: flytekit.core.context_manager.FlyteContext,
    kwargs,
) -> typing.Union[typing.Tuple[flytekit.core.promise.Promise], flytekit.core.promise.Promise, flytekit.core.promise.VoidPromise, NoneType]

Please see the local_execute comments in the main task.

Parameter Type
ctx flytekit.core.context_manager.FlyteContext
kwargs **kwargs

local_execution_mode()

def local_execution_mode()

unwrap_literal_map_and_execute()

def unwrap_literal_map_and_execute(
    ctx: flytekit.core.context_manager.FlyteContext,
    input_literal_map: flytekit.models.literals.LiteralMap,
) -> flytekit.models.literals.LiteralMap

Please see the implementation of the dispatch_execute function in the real task.

Parameter Type
ctx flytekit.core.context_manager.FlyteContext
input_literal_map flytekit.models.literals.LiteralMap

Properties

Property Type Description
id
interface
name
python_interface
reference

flytekit.core.reference_entity.ReferenceSpec

class ReferenceSpec(
    template: flytekit.core.reference_entity.ReferenceTemplate,
)
Parameter Type
template flytekit.core.reference_entity.ReferenceTemplate

Properties

Property Type Description
template
:rtype: ReferenceTemplate

flytekit.core.reference_entity.ReferenceTemplate

class ReferenceTemplate(
    id: flytekit.models.core.identifier.Identifier,
    resource_type: int,
)

A reference template encapsulates all the information necessary to use reference entities within other workflows or dynamic tasks.

Parameter Type
id flytekit.models.core.identifier.Identifier
resource_type int

Properties

Property Type Description
id
User-specified information that uniquely identifies this reference.
:rtype: flytekit.models.core.identifier.Identifier
resource_type
The type of reference.
:rtype: flytekit.models.core.identifier.ResourceType

flytekit.core.reference_entity.TaskReference

A reference object containing metadata that points to a remote task.

class TaskReference(
    project: str,
    domain: str,
    name: str,
    version: str,
)
Parameter Type
project str
domain str
name str
version str

Properties

Property Type Description
id
resource_type

flytekit.core.reference_entity.WorkflowReference

A reference object containing metadata that points to a remote workflow.

class WorkflowReference(
    project: str,
    domain: str,
    name: str,
    version: str,
)
Parameter Type
project str
domain str
name str
version str

Properties

Property Type Description
id
resource_type