0.1.dev2192+g7c539c3.d20250403

flytekit.models.types

Class	Description
`Error`
`LiteralType`
`OutputReference`
`SchemaType`
`SimpleType`
`StructuredDatasetType`
`TypeStructure`	Models _types_pb2.
`UnionType`	Models _types_pb2.

flytekit.models.types.Error

        
    
class Error(
    failed_node_id: str,
    message: str,
)

Parameter	Type
`failed_node_id`	`str`
`message`	`str`

Methods

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

from_flyte_idl()

        
    
def from_flyte_idl(
    pb2_object: flyteidl.core.types_pb2.Error,
) -> e: Error

Parameter	Type
`pb2_object`	`flyteidl.core.types_pb2.Error`

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

:rtype: Text

to_flyte_idl()

def to_flyte_idl()

verbose_string()

def verbose_string()

:rtype: Text

Properties

Property	Type	Description
`failed_node_id`
`is_empty`
`message`

flytekit.models.types.LiteralType

        
    
class LiteralType(
    simple,
    schema,
    collection_type,
    map_value_type,
    blob,
    enum_type,
    union_type,
    structured_dataset_type,
    metadata,
    structure,
    annotation,
)

This is a oneof message, only one of the kwargs may be set, representing one of the Flyte types.

Parameter	Type
`simple`
`schema`
`collection_type`
`map_value_type`
`blob`
`enum_type`
`union_type`
`structured_dataset_type`
`metadata`
`structure`
`annotation`

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(
    proto,
) -> e: LiteralType

Parameter	Type
`proto`

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

:rtype: Text

to_flyte_idl()

def to_flyte_idl()

:rtype: flyteidl.core.types_pb2.LiteralType

verbose_string()

def verbose_string()

:rtype: Text

Properties

Property	Type	Description
`annotation`		:rtype: flytekit.models.annotation.TypeAnnotation
`blob`
`collection_type`		The collection value type
`enum_type`
`is_empty`
`map_value_type`		The Value for a dictionary. Key is always string
`metadata`		:rtype: dict[Text, T]
`schema`
`simple`
`structure`
`structured_dataset_type`
`union_type`

flytekit.models.types.OutputReference

        
    
class OutputReference(
    node_id,
    var,
    attr_path: typing.List[typing.Union[str, int]],
)

A reference to an output produced by a node. The type can be retrieved -and validated- from the underlying interface of the node.

Parameter	Type
`node_id`
`var`
`attr_path`	`typing.List[typing.Union[str, int]]`

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: OutputReference

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.core.types.OutputReference

verbose_string()

def verbose_string()

:rtype: Text

Properties

Property	Type	Description
`attr_path`		The attribute path the promise will be resolved with. :rtype: list[union[str, int]]
`is_empty`
`node_id`		Node id must exist at the graph layer. :rtype: Text
`var`		Variable name must refer to an output variable for the node. :rtype: Text

flytekit.models.types.SchemaType

        
    
class SchemaType(
    columns,
)

Parameter	Type
`columns`

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(
    proto,
) -> e: SchemaType

Parameter	Type
`proto`

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

:rtype: Text

to_flyte_idl()

def to_flyte_idl()

:rtype: flyteidl.core.types_pb2.SchemaType

verbose_string()

def verbose_string()

:rtype: Text

Properties

Property	Type	Description
`columns`		A list of columns defining the underlying data frame. :rtype: list[SchemaType.SchemaColumn]
`is_empty`

flytekit.models.types.SimpleType

flytekit.models.types.StructuredDatasetType

        
    
class StructuredDatasetType(
    columns: typing.List[flytekit.models.types.StructuredDatasetType.DatasetColumn],
    format: str,
    external_schema_type: str,
    external_schema_bytes: bytes,
)

Parameter	Type
`columns`	`typing.List[flytekit.models.types.StructuredDatasetType.DatasetColumn]`
`format`	`str`
`external_schema_type`	`str`
`external_schema_bytes`	`bytes`

Methods

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

from_flyte_idl()

        
    
def from_flyte_idl(
    proto: flyteidl.core.types_pb2.StructuredDatasetType,
) -> flyteidl.core.types_pb2.StructuredDatasetType

Parameter	Type
`proto`	`flyteidl.core.types_pb2.StructuredDatasetType`

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

:rtype: Text

to_flyte_idl()

def to_flyte_idl()

verbose_string()

def verbose_string()

:rtype: Text

Properties

Property	Type	Description
`columns`
`external_schema_bytes`
`external_schema_type`
`format`
`is_empty`

flytekit.models.types.TypeStructure

Models _types_pb2.TypeStructure

        
    
class TypeStructure(
    tag: str,
    dataclass_type: typing.Dict[str, ForwardRef('LiteralType')],
)

Parameter	Type
`tag`	`str`
`dataclass_type`	`typing.Dict[str, ForwardRef('LiteralType')]`

Methods

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

from_flyte_idl()

        
    
def from_flyte_idl(
    proto: flyteidl.core.types_pb2.TypeStructure,
)

Parameter	Type
`proto`	`flyteidl.core.types_pb2.TypeStructure`

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

:rtype: Text

to_flyte_idl()

def to_flyte_idl()

verbose_string()

def verbose_string()

:rtype: Text

Properties

Property	Type	Description
`dataclass_type`
`is_empty`
`tag`

flytekit.models.types.UnionType

Models _types_pb2.UnionType

        
    
class UnionType(
    variants: typing.List[ForwardRef('LiteralType')],
)

Parameter	Type
`variants`	`typing.List[ForwardRef('LiteralType')]`

Methods

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

from_flyte_idl()

        
    
def from_flyte_idl(
    proto: flyteidl.core.types_pb2.UnionType,
)

Parameter	Type
`proto`	`flyteidl.core.types_pb2.UnionType`

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

:rtype: Text

to_flyte_idl()

def to_flyte_idl()

verbose_string()

def verbose_string()

:rtype: Text

Properties

Property	Type	Description
`is_empty`
`variants`