flytekit.models.types
Directory
Classes
flytekit.models.types.Error
def Error(
failed_node_id: str,
message: str,
):
Parameter |
Type |
failed_node_id |
str |
message |
str |
Methods
from_flyte_idl()
def from_flyte_idl(
pb2_object: flyteidl.core.types_pb2.Error,
):
Parameter |
Type |
pb2_object |
flyteidl.core.types_pb2.Error |
serialize_to_string()
def serialize_to_string()
short_string()
to_flyte_idl()
verbose_string()
Properties
Property |
Type |
Description |
failed_node_id |
|
|
is_empty |
|
|
message |
|
|
flytekit.models.types.LiteralType
def 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
from_flyte_idl()
def from_flyte_idl(
proto,
):
serialize_to_string()
def serialize_to_string()
short_string()
to_flyte_idl()
verbose_string()
Properties
Property |
Type |
Description |
annotation |
|
|
blob |
|
|
collection_type |
|
|
enum_type |
|
|
is_empty |
|
|
map_value_type |
|
|
metadata |
|
|
schema |
|
|
simple |
|
|
structure |
|
|
structured_dataset_type |
|
|
union_type |
|
|
flytekit.models.types.OutputReference
def 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
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 |
attr_path |
|
|
is_empty |
|
|
node_id |
|
|
var |
|
|
flytekit.models.types.SchemaType
def SchemaType(
columns,
):
Methods
from_flyte_idl()
def from_flyte_idl(
proto,
):
serialize_to_string()
def serialize_to_string()
short_string()
to_flyte_idl()
verbose_string()
Properties
Property |
Type |
Description |
columns |
|
|
is_empty |
|
|
flytekit.models.types.SimpleType
flytekit.models.types.StructuredDatasetType
def 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
from_flyte_idl()
def from_flyte_idl(
proto: flyteidl.core.types_pb2.StructuredDatasetType,
):
Parameter |
Type |
proto |
flyteidl.core.types_pb2.StructuredDatasetType |
serialize_to_string()
def serialize_to_string()
short_string()
to_flyte_idl()
verbose_string()
Properties
Property |
Type |
Description |
columns |
|
|
external_schema_bytes |
|
|
external_schema_type |
|
|
format |
|
|
is_empty |
|
|
flytekit.models.types.TypeAnnotationModel
Python class representation of the flyteidl TypeAnnotation message.
def TypeAnnotationModel(
annotations: typing.Dict[str, typing.Any],
):
Parameter |
Type |
annotations |
typing.Dict[str, typing.Any] |
Methods
from_flyte_idl()
def from_flyte_idl(
proto,
):
merge_annotations()
def merge_annotations(
annotation: TypeAnnotation,
other_annotation: TypeAnnotation,
):
Merges two annotations together. If the same key exists in both annotations, the value in the other annotation
will be used.
Parameter |
Type |
annotation |
TypeAnnotation |
other_annotation |
TypeAnnotation |
to_flyte_idl()
Properties
Property |
Type |
Description |
annotations |
|
|
flytekit.models.types.TypeStructure
Models _types_pb2.TypeStructure
def TypeStructure(
tag: str,
dataclass_type: typing.Dict[str, ForwardRef('LiteralType')],
):
Parameter |
Type |
tag |
str |
dataclass_type |
typing.Dict[str, ForwardRef('LiteralType')] |
Methods
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()
to_flyte_idl()
verbose_string()
Properties
Property |
Type |
Description |
dataclass_type |
|
|
is_empty |
|
|
tag |
|
|
flytekit.models.types.UnionType
Models _types_pb2.UnionType
def UnionType(
variants: typing.List[ForwardRef('LiteralType')],
):
Parameter |
Type |
variants |
typing.List[ForwardRef('LiteralType')] |
Methods
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()
to_flyte_idl()
verbose_string()
Properties
Property |
Type |
Description |
is_empty |
|
|
variants |
|
|