flytekit.Description

class flytekit.Description(value=None, uri=None, icon_link=None, format=DescriptionFormat.RST)

Full user description with formatting preserved. This can be rendered by clients, such as the console or command line tools with in-tact formatting.

Methods

Parameters

• value (Optional[str]) –

• uri (Optional[str]) –

• icon_link (Optional[str]) –

• format (flytekit.models.documentation.Description.DescriptionFormat) –

Return type

None

classmethod from_flyte_idl(pb2_object)

Parameters

pb2_object (flyteidl.admin.description_entity_pb2.Description) –

Return type

flytekit.models.documentation.Description

serialize_to_string()

Return type

str

short_string()

Return type

Text

to_flyte_idl()

verbose_string()

Return type

Text

Attributes

format: flytekit.models.documentation.Description.DescriptionFormat = 3

icon_link: Optional[str] = None

is_empty

uri: Optional[str] = None

value: Optional[str] = None