flytekit.models.literals

Class	Description
`Binary`
`Binding`
`BindingData`
`BindingDataCollection`
`BindingDataMap`
`Blob`
`BlobMetadata`	This is metadata for the Blob literal.
`Literal`
`LiteralCollection`
`LiteralMap`
`LiteralOffloadedMetadata`
`Primitive`
`RetryStrategy`
`Scalar`
`Schema`
`StructuredDataset`
`StructuredDatasetMetadata`
`Union`
`Void`

flytekit.models.literals.Binary

        
    
class Binary(
    value,
    tag,
)

Parameter	Type	Description
`value`
`tag`

Properties

Property	Type	Description
`is_empty`	`None`
`tag`	`None`	:rtype: Text
`value`	`None`	:rtype: bytes

Methods

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

from_flyte_idl()

        
    
def from_flyte_idl(
    pb2_object,
)

Parameter	Type	Description
`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.literals_pb2.Binary

flytekit.models.literals.Binding

        
    
class Binding(
    var,
    binding,
)

An input/output binding of a variable to either static value or a node output.

Parameter	Type	Description
`var`
`binding`

Properties

Property	Type	Description
`binding`	`None`	Data to use to bind this variable. :rtype: BindingData
`is_empty`	`None`
`var`	`None`	A variable name, must match an input or output variable of the node. :rtype: Text

Methods

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

from_flyte_idl()

        
    
def from_flyte_idl(
    pb2_object,
)

Parameter	Type	Description
`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.literals_pb2.Binding

flytekit.models.literals.BindingData

        
    
class BindingData(
    scalar,
    collection,
    promise,
    map,
)

Specifies either a simple value or a reference to another output. Only one of the input arguments may be specified.

Parameter	Type	Description
`scalar`
`collection`
`promise`
`map`

Properties

Property	Type	Description
`collection`	`None`	[Optional] A collection of binding data. This allows nesting of binding data to any number of levels. :rtype: BindingDataCollection
`is_empty`	`None`
`map`	`None`	[Optional] A map of bindings. The key is always a string. :rtype: BindingDataMap
`promise`	`None`	[Optional] References an output promised by another node. :rtype: flytekit.models.types.OutputReference
`scalar`	`None`	A simple scalar value. :rtype: Scalar
`value`	`None`	Returns whichever value is set :rtype: T

Methods

Method	Description
`from_flyte_idl()`
`serialize_to_string()`
`short_string()`	:rtype: Text.
`to_flyte_idl()`	:rtype: flyteidl.
`to_literal_model()`	Converts current binding data into a Literal asserting that there are no promises in the bindings.

from_flyte_idl()

        
    
def from_flyte_idl(
    pb2_object,
)

Parameter	Type	Description
`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.literals_pb2.BindingData

to_literal_model()

        
    
def to_literal_model()

Converts current binding data into a Literal asserting that there are no promises in the bindings. :rtype: Literal

flytekit.models.literals.BindingDataCollection

        
    
class BindingDataCollection(
    bindings,
)

A list of BindingData items.

Parameter	Type	Description
`bindings`

Properties

Property	Type	Description
`bindings`	`None`	:rtype: list[BindingData]
`is_empty`	`None`

Methods

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

from_flyte_idl()

        
    
def from_flyte_idl(
    pb2_object,
)

Parameter	Type	Description
`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.literals_pb2.BindingDataCollection

flytekit.models.literals.BindingDataMap

        
    
class BindingDataMap(
    bindings,
)

A map of BindingData items. Can be a recursive structure

Parameter	Type	Description
`bindings`

Properties

Property	Type	Description
`bindings`	`None`	Map of strings to Bindings :rtype: dict[string, BindingData]
`is_empty`	`None`

Methods

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

from_flyte_idl()

        
    
def from_flyte_idl(
    pb2_object,
)

Parameter	Type	Description
`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.literals_pb2.BindingDataMap

flytekit.models.literals.Blob

        
    
class Blob(
    metadata,
    uri,
)

This literal model is used to represent binary data offloaded to some storage location which is identifiable with a unique string. See {{< py_class_ref flytekit.FlyteFile >}} as an example.

Parameter	Type	Description
`metadata`
`uri`

Properties

Property	Type	Description
`is_empty`	`None`
`metadata`	`None`	:rtype: BlobMetadata
`uri`	`None`	:rtype: Text

Methods

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

from_flyte_idl()

        
    
def from_flyte_idl(
    proto,
)

Parameter	Type	Description
`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.literals_pb2.Blob

flytekit.models.literals.BlobMetadata

This is metadata for the Blob literal.

        
    
class BlobMetadata(
    type,
)

Parameter	Type	Description
`type`

Properties

Property	Type	Description
`is_empty`	`None`
`type`	`None`	:rtype: flytekit.models.core.types.BlobType

Methods

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

from_flyte_idl()

        
    
def from_flyte_idl(
    proto,
)

Parameter	Type	Description
`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.literals_pb2.BlobMetadata

flytekit.models.literals.Literal

        
    
class Literal(
    scalar: typing.Optional[flytekit.models.literals.Scalar],
    collection: typing.Optional[flytekit.models.literals.LiteralCollection],
    map: typing.Optional[flytekit.models.literals.LiteralMap],
    hash: typing.Optional[str],
    metadata: typing.Optional[typing.Dict[str, str]],
    offloaded_metadata: typing.Optional[flytekit.models.literals.LiteralOffloadedMetadata],
)

This IDL message represents a literal value in the Flyte ecosystem.

Parameter	Type	Description
`scalar`	`typing.Optional[flytekit.models.literals.Scalar]`
`collection`	`typing.Optional[flytekit.models.literals.LiteralCollection]`
`map`	`typing.Optional[flytekit.models.literals.LiteralMap]`
`hash`	`typing.Optional[str]`
`metadata`	`typing.Optional[typing.Dict[str, str]]`
`offloaded_metadata`	`typing.Optional[flytekit.models.literals.LiteralOffloadedMetadata]`

Properties

Property	Type	Description
`collection`	`None`	If not None, this value holds a collection of Literal values which can be further unpacked. :rtype: LiteralCollection
`hash`	`None`	If not None, this value holds a hash that represents the literal for caching purposes. :rtype: str
`is_empty`	`None`
`map`	`None`	If not None, this value holds a map of Literal values which can be further unpacked. :rtype: LiteralMap
`metadata`	`None`	This value holds metadata about the literal.
`offloaded_metadata`	`None`	This value holds metadata about the offloaded literal.
`scalar`	`None`	If not None, this value holds a scalar value which can be further unpacked. :rtype: Scalar
`value`	`None`	Returns one of the scalar, collection, or map properties based on which one is set. :rtype: T

Methods

Method	Description
`from_flyte_idl()`
`serialize_to_string()`
`set_metadata()`	Note: This is a mutation on the literal.
`short_string()`	:rtype: Text.
`to_flyte_idl()`	:rtype: flyteidl.

from_flyte_idl()

        
    
def from_flyte_idl(
    pb2_object: flyteidl.core.literals_pb2.Literal,
)

Parameter	Type	Description
`pb2_object`	`flyteidl.core.literals_pb2.Literal`

serialize_to_string()

        
    
def serialize_to_string()

set_metadata()

        
    
def set_metadata(
    metadata: typing.Dict[str, str],
)

Note: This is a mutation on the literal

Parameter	Type	Description
`metadata`	`typing.Dict[str, str]`

short_string()

        
    
def short_string()

:rtype: Text

to_flyte_idl()

        
    
def to_flyte_idl()

:rtype: flyteidl.core.literals_pb2.Literal

flytekit.models.literals.LiteralCollection

        
    
class LiteralCollection(
    literals,
)

Parameter	Type	Description
`literals`

Properties

Property	Type	Description
`is_empty`	`None`
`literals`	`None`	:rtype: list[Literal]

Methods

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

from_flyte_idl()

        
    
def from_flyte_idl(
    pb2_object,
)

Parameter	Type	Description
`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.literals_pb2.LiteralCollection

flytekit.models.literals.LiteralMap

        
    
class LiteralMap(
    literals,
)

Parameter	Type	Description
`literals`

Properties

Property	Type	Description
`is_empty`	`None`
`literals`	`None`	A dictionary mapping Text key names to Literal objects. :rtype: dict[Text, Literal]

Methods

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

from_flyte_idl()

        
    
def from_flyte_idl(
    pb2_object,
)

Parameter	Type	Description
`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.literals_pb2.LiteralMap

flytekit.models.literals.LiteralOffloadedMetadata

        
    
class LiteralOffloadedMetadata(
    uri: typing.Optional[str],
    size_bytes: typing.Optional[int],
    inferred_type: typing.Optional[flytekit.models.types.LiteralType],
)

Parameter	Type	Description
`uri`	`typing.Optional[str]`
`size_bytes`	`typing.Optional[int]`
`inferred_type`	`typing.Optional[flytekit.models.types.LiteralType]`

Properties

Property	Type	Description
`inferred_type`	`None`
`is_empty`	`None`
`size_bytes`	`None`
`uri`	`None`

Methods

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

from_flyte_idl()

        
    
def from_flyte_idl(
    pb2_object,
)

Parameter	Type	Description
`pb2_object`

serialize_to_string()

        
    
def serialize_to_string()

short_string()

        
    
def short_string()

:rtype: Text

to_flyte_idl()

        
    
def to_flyte_idl()

flytekit.models.literals.Primitive

        
    
class Primitive(
    integer: typing.Optional[int],
    float_value: typing.Optional[float],
    string_value: typing.Optional[str],
    boolean: typing.Optional[bool],
    datetime: typing.Optional[datetime.datetime],
    duration: typing.Optional[datetime.timedelta],
)

This object proxies the primitives supported by the Flyte IDL system. Only one value can be set.

Parameter	Type	Description
`integer`	`typing.Optional[int]`
`float_value`	`typing.Optional[float]`
`string_value`	`typing.Optional[str]`
`boolean`	`typing.Optional[bool]`
`datetime`	`typing.Optional[datetime.datetime]`
`duration`	`typing.Optional[datetime.timedelta]`

Properties

Property	Type	Description
`boolean`	`None`	:rtype: bool
`datetime`	`None`	:rtype: datetime.datetime
`duration`	`None`	:rtype: datetime.timedelta
`float_value`	`None`	:rtype: float
`integer`	`None`	:rtype: int
`is_empty`	`None`
`string_value`	`None`	:rtype: Text
`value`	`None`	This returns whichever field is set. :rtype: T

Methods

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

from_flyte_idl()

        
    
def from_flyte_idl(
    proto,
)

Parameter	Type	Description
`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.literals_pb2.Primitive

flytekit.models.literals.RetryStrategy

        
    
class RetryStrategy(
    retries: int,
)

Parameter	Type	Description
`retries`	`int`

Properties

Property	Type	Description
`is_empty`	`None`
`retries`	`None`	Number of retries to attempt on recoverable failures. If retries is 0, then only one attempt will be made. :rtype: int

Methods

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

from_flyte_idl()

        
    
def from_flyte_idl(
    pb2_object,
)

Parameter	Type	Description
`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.literals_pb2.RetryStrategy

flytekit.models.literals.Scalar

        
    
class Scalar(
    primitive: typing.Optional[flytekit.models.literals.Primitive],
    blob: typing.Optional[flytekit.models.literals.Blob],
    binary: typing.Optional[flytekit.models.literals.Binary],
    schema: typing.Optional[flytekit.models.literals.Schema],
    union: typing.Optional[flytekit.models.literals.Union],
    none_type: typing.Optional[flytekit.models.literals.Void],
    error: typing.Optional[flytekit.models.types.Error],
    generic: typing.Optional[google.protobuf.struct_pb2.Struct],
    structured_dataset: typing.Optional[flytekit.models.literals.StructuredDataset],
)

Scalar wrapper around Flyte types. Only one can be specified.

Parameter	Type	Description
`primitive`	`typing.Optional[flytekit.models.literals.Primitive]`
`blob`	`typing.Optional[flytekit.models.literals.Blob]`
`binary`	`typing.Optional[flytekit.models.literals.Binary]`
`schema`	`typing.Optional[flytekit.models.literals.Schema]`
`union`	`typing.Optional[flytekit.models.literals.Union]`
`none_type`	`typing.Optional[flytekit.models.literals.Void]`
`error`	`typing.Optional[flytekit.models.types.Error]`
`generic`	`typing.Optional[google.protobuf.struct_pb2.Struct]`
`structured_dataset`	`typing.Optional[flytekit.models.literals.StructuredDataset]`

Properties

Property	Type	Description
`binary`	`None`	:rtype: Binary
`blob`	`None`	:rtype: Blob
`error`	`None`	:rtype: Error
`generic`	`None`	:rtype: google.protobuf.struct_pb2.Struct
`is_empty`	`None`
`none_type`	`None`	:rtype: Void
`primitive`	`None`	:rtype: Primitive
`schema`	`None`	:rtype: Schema
`structured_dataset`	`None`
`union`	`None`	:rtype: Union
`value`	`None`	Returns whichever value is set :rtype: T

Methods

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

from_flyte_idl()

        
    
def from_flyte_idl(
    pb2_object,
)

Parameter	Type	Description
`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.literals_pb2.Scalar

flytekit.models.literals.Schema

        
    
class Schema(
    uri,
    type,
)

A strongly typed schema that defines the interface of data retrieved from the underlying storage medium.

Parameter	Type	Description
`uri`
`type`

Properties

Property	Type	Description
`is_empty`	`None`
`type`	`None`	:rtype: flytekit.models.types.SchemaType
`uri`	`None`	:rtype: Text

Methods

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

from_flyte_idl()

        
    
def from_flyte_idl(
    pb2_object,
)

Parameter	Type	Description
`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.literals_pb2.Schema

flytekit.models.literals.StructuredDataset

        
    
class StructuredDataset(
    uri: str,
    metadata: typing.Optional[flytekit.models.literals.StructuredDatasetMetadata],
)

A strongly typed schema that defines the interface of data retrieved from the underlying storage medium.

Parameter	Type	Description
`uri`	`str`
`metadata`	`typing.Optional[flytekit.models.literals.StructuredDatasetMetadata]`

Properties

Property	Type	Description
`is_empty`	`None`
`metadata`	`None`
`uri`	`None`

Methods

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

from_flyte_idl()

        
    
def from_flyte_idl(
    pb2_object: flyteidl.core.literals_pb2.StructuredDataset,
) -> StructuredDataset

Parameter	Type	Description
`pb2_object`	`flyteidl.core.literals_pb2.StructuredDataset`

serialize_to_string()

        
    
def serialize_to_string()

short_string()

        
    
def short_string()

:rtype: Text

to_flyte_idl()

        
    
def to_flyte_idl()

flytekit.models.literals.StructuredDatasetMetadata

        
    
class StructuredDatasetMetadata(
    structured_dataset_type: typing.Optional[flytekit.models.types.StructuredDatasetType],
)

Parameter	Type	Description
`structured_dataset_type`	`typing.Optional[flytekit.models.types.StructuredDatasetType]`

Properties

Property	Type	Description
`is_empty`	`None`
`structured_dataset_type`	`None`

Methods

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

from_flyte_idl()

        
    
def from_flyte_idl(
    pb2_object: flyteidl.core.literals_pb2.StructuredDatasetMetadata,
) -> StructuredDatasetMetadata

Parameter	Type	Description
`pb2_object`	`flyteidl.core.literals_pb2.StructuredDatasetMetadata`

serialize_to_string()

        
    
def serialize_to_string()

short_string()

        
    
def short_string()

:rtype: Text

to_flyte_idl()

        
    
def to_flyte_idl()

flytekit.models.literals.Union

        
    
class Union(
    value,
    stored_type,
)

The runtime representation of a tagged union value. See UnionType for more details.

Parameter	Type	Description
`value`
`stored_type`

Properties

Property	Type	Description
`is_empty`	`None`
`stored_type`	`None`	:rtype: flytekit.models.types.LiteralType
`value`	`None`	:rtype: flytekit.models.literals.Literal

Methods

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

from_flyte_idl()

        
    
def from_flyte_idl(
    pb2_object,
)

Parameter	Type	Description
`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.literals_pb2.Union

flytekit.models.literals.Void

Properties

Property	Type	Description
`is_empty`	`None`

Methods

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

from_flyte_idl()

        
    
def from_flyte_idl(
    proto,
)

Parameter	Type	Description
`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.literals_pb2.Void

LLM-optimized This page Full docs index

On this page