queenbee.io.outputs.dag module

Queenbee output types for a DAG.

class queenbee.io.outputs.dag.DAGArrayOutput(*, type: ~typing.Literal['DAGArrayOutput'] = 'DAGArrayOutput', annotations: ~typing.Dict[str, ~typing.Any] | None = <factory>, name: str, description: str | None = None, from_: ~queenbee.io.reference.TaskReference | ~queenbee.io.reference.FileReference, alias: ~typing.List[~queenbee.io.outputs.alias.DAGGenericOutputAlias | ~queenbee.io.outputs.alias.DAGStringOutputAlias | ~queenbee.io.outputs.alias.DAGIntegerOutputAlias | ~queenbee.io.outputs.alias.DAGNumberOutputAlias | ~queenbee.io.outputs.alias.DAGBooleanOutputAlias | ~queenbee.io.outputs.alias.DAGFolderOutputAlias | ~queenbee.io.outputs.alias.DAGFileOutputAlias | ~queenbee.io.outputs.alias.DAGPathOutputAlias | ~queenbee.io.outputs.alias.DAGArrayOutputAlias | ~queenbee.io.outputs.alias.DAGJSONObjectOutputAlias | ~queenbee.io.outputs.alias.DAGLinkedOutputAlias] = <factory>, required: bool = True, items_type: ~queenbee.io.common.ItemType = ItemType.String)[source]

Bases: DAGStringOutput

DAG array output.

This output loads the content from a JSON file which must be a JSON Array.

items_type: ItemType
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['DAGArrayOutput']
class queenbee.io.outputs.dag.DAGBooleanOutput(*, type: ~typing.Literal['DAGBooleanOutput'] = 'DAGBooleanOutput', annotations: ~typing.Dict[str, ~typing.Any] | None = <factory>, name: str, description: str | None = None, from_: ~queenbee.io.reference.TaskReference | ~queenbee.io.reference.FileReference, alias: ~typing.List[~queenbee.io.outputs.alias.DAGGenericOutputAlias | ~queenbee.io.outputs.alias.DAGStringOutputAlias | ~queenbee.io.outputs.alias.DAGIntegerOutputAlias | ~queenbee.io.outputs.alias.DAGNumberOutputAlias | ~queenbee.io.outputs.alias.DAGBooleanOutputAlias | ~queenbee.io.outputs.alias.DAGFolderOutputAlias | ~queenbee.io.outputs.alias.DAGFileOutputAlias | ~queenbee.io.outputs.alias.DAGPathOutputAlias | ~queenbee.io.outputs.alias.DAGArrayOutputAlias | ~queenbee.io.outputs.alias.DAGJSONObjectOutputAlias | ~queenbee.io.outputs.alias.DAGLinkedOutputAlias] = <factory>, required: bool = True)[source]

Bases: DAGStringOutput

DAG boolean output.

This output loads the content from a file as a boolean.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['DAGBooleanOutput']
class queenbee.io.outputs.dag.DAGFileOutput(*, type: ~typing.Literal['DAGFileOutput'] = 'DAGFileOutput', annotations: ~typing.Dict[str, ~typing.Any] | None = <factory>, name: str, description: str | None = None, from_: ~queenbee.io.reference.TaskReference | ~queenbee.io.reference.FileReference, alias: ~typing.List[~queenbee.io.outputs.alias.DAGGenericOutputAlias | ~queenbee.io.outputs.alias.DAGStringOutputAlias | ~queenbee.io.outputs.alias.DAGIntegerOutputAlias | ~queenbee.io.outputs.alias.DAGNumberOutputAlias | ~queenbee.io.outputs.alias.DAGBooleanOutputAlias | ~queenbee.io.outputs.alias.DAGFolderOutputAlias | ~queenbee.io.outputs.alias.DAGFileOutputAlias | ~queenbee.io.outputs.alias.DAGPathOutputAlias | ~queenbee.io.outputs.alias.DAGArrayOutputAlias | ~queenbee.io.outputs.alias.DAGJSONObjectOutputAlias | ~queenbee.io.outputs.alias.DAGLinkedOutputAlias] = <factory>, required: bool = True)[source]

Bases: _DAGArtifactOutput

DAG file output.

from_: TaskReference | FileReference
property is_artifact
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['DAGFileOutput']
class queenbee.io.outputs.dag.DAGFolderOutput(*, type: ~typing.Literal['DAGFolderOutput'] = 'DAGFolderOutput', annotations: ~typing.Dict[str, ~typing.Any] | None = <factory>, name: str, description: str | None = None, from_: ~queenbee.io.reference.TaskReference | ~queenbee.io.reference.FolderReference, alias: ~typing.List[~queenbee.io.outputs.alias.DAGGenericOutputAlias | ~queenbee.io.outputs.alias.DAGStringOutputAlias | ~queenbee.io.outputs.alias.DAGIntegerOutputAlias | ~queenbee.io.outputs.alias.DAGNumberOutputAlias | ~queenbee.io.outputs.alias.DAGBooleanOutputAlias | ~queenbee.io.outputs.alias.DAGFolderOutputAlias | ~queenbee.io.outputs.alias.DAGFileOutputAlias | ~queenbee.io.outputs.alias.DAGPathOutputAlias | ~queenbee.io.outputs.alias.DAGArrayOutputAlias | ~queenbee.io.outputs.alias.DAGJSONObjectOutputAlias | ~queenbee.io.outputs.alias.DAGLinkedOutputAlias] = <factory>, required: bool = True)[source]

Bases: _DAGArtifactOutput

DAG folder output.

from_: TaskReference | FolderReference
property is_artifact
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['DAGFolderOutput']
class queenbee.io.outputs.dag.DAGGenericOutput(*, type: ~typing.Literal['DAGGenericOutput'] = 'DAGGenericOutput', annotations: ~typing.Dict[str, ~typing.Any] | None = <factory>, name: str, description: str | None = None, from_: ~typing.Any, alias: ~typing.List[~queenbee.io.outputs.alias.DAGGenericOutputAlias | ~queenbee.io.outputs.alias.DAGStringOutputAlias | ~queenbee.io.outputs.alias.DAGIntegerOutputAlias | ~queenbee.io.outputs.alias.DAGNumberOutputAlias | ~queenbee.io.outputs.alias.DAGBooleanOutputAlias | ~queenbee.io.outputs.alias.DAGFolderOutputAlias | ~queenbee.io.outputs.alias.DAGFileOutputAlias | ~queenbee.io.outputs.alias.DAGPathOutputAlias | ~queenbee.io.outputs.alias.DAGArrayOutputAlias | ~queenbee.io.outputs.alias.DAGJSONObjectOutputAlias | ~queenbee.io.outputs.alias.DAGLinkedOutputAlias] = <factory>)[source]

Bases: FromOutput

DAG generic output.

In most cases, you should not be using the generic output unless you need a dynamic output that changes its type in different platforms because of returning different objects in handler.

alias: List[DAGGenericOutputAlias | DAGStringOutputAlias | DAGIntegerOutputAlias | DAGNumberOutputAlias | DAGBooleanOutputAlias | DAGFolderOutputAlias | DAGFileOutputAlias | DAGPathOutputAlias | DAGArrayOutputAlias | DAGJSONObjectOutputAlias | DAGLinkedOutputAlias]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['DAGGenericOutput']
class queenbee.io.outputs.dag.DAGIntegerOutput(*, type: ~typing.Literal['DAGIntegerOutput'] = 'DAGIntegerOutput', annotations: ~typing.Dict[str, ~typing.Any] | None = <factory>, name: str, description: str | None = None, from_: ~queenbee.io.reference.TaskReference | ~queenbee.io.reference.FileReference, alias: ~typing.List[~queenbee.io.outputs.alias.DAGGenericOutputAlias | ~queenbee.io.outputs.alias.DAGStringOutputAlias | ~queenbee.io.outputs.alias.DAGIntegerOutputAlias | ~queenbee.io.outputs.alias.DAGNumberOutputAlias | ~queenbee.io.outputs.alias.DAGBooleanOutputAlias | ~queenbee.io.outputs.alias.DAGFolderOutputAlias | ~queenbee.io.outputs.alias.DAGFileOutputAlias | ~queenbee.io.outputs.alias.DAGPathOutputAlias | ~queenbee.io.outputs.alias.DAGArrayOutputAlias | ~queenbee.io.outputs.alias.DAGJSONObjectOutputAlias | ~queenbee.io.outputs.alias.DAGLinkedOutputAlias] = <factory>, required: bool = True)[source]

Bases: DAGStringOutput

DAG integer output.

This output loads the content from a file as an integer.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['DAGIntegerOutput']
class queenbee.io.outputs.dag.DAGJSONObjectOutput(*, type: ~typing.Literal['DAGJSONObjectOutput'] = 'DAGJSONObjectOutput', annotations: ~typing.Dict[str, ~typing.Any] | None = <factory>, name: str, description: str | None = None, from_: ~queenbee.io.reference.TaskReference | ~queenbee.io.reference.FileReference, alias: ~typing.List[~queenbee.io.outputs.alias.DAGGenericOutputAlias | ~queenbee.io.outputs.alias.DAGStringOutputAlias | ~queenbee.io.outputs.alias.DAGIntegerOutputAlias | ~queenbee.io.outputs.alias.DAGNumberOutputAlias | ~queenbee.io.outputs.alias.DAGBooleanOutputAlias | ~queenbee.io.outputs.alias.DAGFolderOutputAlias | ~queenbee.io.outputs.alias.DAGFileOutputAlias | ~queenbee.io.outputs.alias.DAGPathOutputAlias | ~queenbee.io.outputs.alias.DAGArrayOutputAlias | ~queenbee.io.outputs.alias.DAGJSONObjectOutputAlias | ~queenbee.io.outputs.alias.DAGLinkedOutputAlias] = <factory>, required: bool = True)[source]

Bases: DAGStringOutput

DAG object output.

This output loads the content from a file as a JSON object.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['DAGJSONObjectOutput']
class queenbee.io.outputs.dag.DAGNumberOutput(*, type: ~typing.Literal['DAGNumberOutput'] = 'DAGNumberOutput', annotations: ~typing.Dict[str, ~typing.Any] | None = <factory>, name: str, description: str | None = None, from_: ~queenbee.io.reference.TaskReference | ~queenbee.io.reference.FileReference, alias: ~typing.List[~queenbee.io.outputs.alias.DAGGenericOutputAlias | ~queenbee.io.outputs.alias.DAGStringOutputAlias | ~queenbee.io.outputs.alias.DAGIntegerOutputAlias | ~queenbee.io.outputs.alias.DAGNumberOutputAlias | ~queenbee.io.outputs.alias.DAGBooleanOutputAlias | ~queenbee.io.outputs.alias.DAGFolderOutputAlias | ~queenbee.io.outputs.alias.DAGFileOutputAlias | ~queenbee.io.outputs.alias.DAGPathOutputAlias | ~queenbee.io.outputs.alias.DAGArrayOutputAlias | ~queenbee.io.outputs.alias.DAGJSONObjectOutputAlias | ~queenbee.io.outputs.alias.DAGLinkedOutputAlias] = <factory>, required: bool = True)[source]

Bases: DAGStringOutput

DAG number output.

This output loads the content from a file as a floating number.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['DAGNumberOutput']
class queenbee.io.outputs.dag.DAGPathOutput(*, type: ~typing.Literal['DAGPathOutput'] = 'DAGPathOutput', annotations: ~typing.Dict[str, ~typing.Any] | None = <factory>, name: str, description: str | None = None, from_: ~queenbee.io.reference.TaskReference | ~queenbee.io.reference.FileReference | ~queenbee.io.reference.FolderReference, alias: ~typing.List[~queenbee.io.outputs.alias.DAGGenericOutputAlias | ~queenbee.io.outputs.alias.DAGStringOutputAlias | ~queenbee.io.outputs.alias.DAGIntegerOutputAlias | ~queenbee.io.outputs.alias.DAGNumberOutputAlias | ~queenbee.io.outputs.alias.DAGBooleanOutputAlias | ~queenbee.io.outputs.alias.DAGFolderOutputAlias | ~queenbee.io.outputs.alias.DAGFileOutputAlias | ~queenbee.io.outputs.alias.DAGPathOutputAlias | ~queenbee.io.outputs.alias.DAGArrayOutputAlias | ~queenbee.io.outputs.alias.DAGJSONObjectOutputAlias | ~queenbee.io.outputs.alias.DAGLinkedOutputAlias] = <factory>, required: bool = True)[source]

Bases: _DAGArtifactOutput

DAG path output.

from_: TaskReference | FileReference | FolderReference
property is_artifact
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['DAGPathOutput']
class queenbee.io.outputs.dag.DAGStringOutput(*, type: ~typing.Literal['DAGStringOutput'] = 'DAGStringOutput', annotations: ~typing.Dict[str, ~typing.Any] | None = <factory>, name: str, description: str | None = None, from_: ~queenbee.io.reference.TaskReference | ~queenbee.io.reference.FileReference, alias: ~typing.List[~queenbee.io.outputs.alias.DAGGenericOutputAlias | ~queenbee.io.outputs.alias.DAGStringOutputAlias | ~queenbee.io.outputs.alias.DAGIntegerOutputAlias | ~queenbee.io.outputs.alias.DAGNumberOutputAlias | ~queenbee.io.outputs.alias.DAGBooleanOutputAlias | ~queenbee.io.outputs.alias.DAGFolderOutputAlias | ~queenbee.io.outputs.alias.DAGFileOutputAlias | ~queenbee.io.outputs.alias.DAGPathOutputAlias | ~queenbee.io.outputs.alias.DAGArrayOutputAlias | ~queenbee.io.outputs.alias.DAGJSONObjectOutputAlias | ~queenbee.io.outputs.alias.DAGLinkedOutputAlias] = <factory>, required: bool = True)[source]

Bases: DAGFileOutput

DAG string output.

This output loads the content from a file as a string.

property is_artifact
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['DAGStringOutput']