queenbee.io.outputs.alias module¶

Queenbee alias output types.

Use these alias outputs to create a different IO object for client side UIs.

class queenbee.io.outputs.alias.DAGArrayOutputAlias(*, type: ConstrainedStrValue = 'DAGArrayOutputAlias', annotations: Dict[str, Any] = None, name: str, description: str = None, platform: List[str], handler: List[IOAliasHandler], required: bool = True, items_type: ItemType = ItemType.String, **extra_data: Any)[source]¶

Bases: DAGStringOutputAlias

DAG alias array output.

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

items_type: ItemType¶

type: ConstrainedStrValue¶

class queenbee.io.outputs.alias.DAGBooleanOutputAlias(*, type: ConstrainedStrValue = 'DAGBooleanOutputAlias', annotations: Dict[str, Any] = None, name: str, description: str = None, platform: List[str], handler: List[IOAliasHandler], required: bool = True, **extra_data: Any)[source]¶

Bases: DAGStringOutputAlias

DAG alias boolean output.

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

type: ConstrainedStrValue¶

class queenbee.io.outputs.alias.DAGFileOutputAlias(*, type: ConstrainedStrValue = 'DAGFileOutputAlias', annotations: Dict[str, Any] = None, name: str, description: str = None, platform: List[str], handler: List[IOAliasHandler], required: bool = True, **extra_data: Any)[source]¶

Bases: _DAGArtifactOutputAlias

DAG alias file output.

from_: Union[TaskReference, FileReference]¶

property is_artifact¶

type: ConstrainedStrValue¶

class queenbee.io.outputs.alias.DAGFolderOutputAlias(*, type: ConstrainedStrValue = 'DAGFolderOutputAlias', annotations: Dict[str, Any] = None, name: str, description: str = None, platform: List[str], handler: List[IOAliasHandler], required: bool = True, **extra_data: Any)[source]¶

Bases: _DAGArtifactOutputAlias

DAG alias folder output.

from_: Union[TaskReference, FolderReference]¶

property is_artifact¶

type: ConstrainedStrValue¶

class queenbee.io.outputs.alias.DAGGenericOutputAlias(*, type: ConstrainedStrValue = 'DAGGenericOutputAlias', annotations: Dict[str, Any] = None, name: str, description: str = None, platform: List[str], handler: List[IOAliasHandler])[source]¶

Bases: GenericOutput

DAG generic alias 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.

classmethod check_duplicate_platform_name(v, values)[source]¶

classmethod create_empty_platform_list(v)[source]¶

handler: List[IOAliasHandler]¶

platform: List[str]¶

type: ConstrainedStrValue¶

class queenbee.io.outputs.alias.DAGIntegerOutputAlias(*, type: ConstrainedStrValue = 'DAGIntegerOutputAlias', annotations: Dict[str, Any] = None, name: str, description: str = None, platform: List[str], handler: List[IOAliasHandler], required: bool = True, **extra_data: Any)[source]¶

Bases: DAGStringOutputAlias

DAG alias integer output.

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

type: ConstrainedStrValue¶

class queenbee.io.outputs.alias.DAGJSONObjectOutputAlias(*, type: ConstrainedStrValue = 'DAGJSONObjectOutputAlias', annotations: Dict[str, Any] = None, name: str, description: str = None, platform: List[str], handler: List[IOAliasHandler], required: bool = True, **extra_data: Any)[source]¶

Bases: DAGStringOutputAlias

DAG alias object output.

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

type: ConstrainedStrValue¶

class queenbee.io.outputs.alias.DAGLinkedOutputAlias(*, type: ConstrainedStrValue = 'DAGLinkedOutputAlias', annotations: Dict[str, Any] = None, name: str, description: str = None, platform: List[str], handler: List[IOAliasHandler])[source]¶

Bases: DAGGenericOutputAlias

An Alias for Linked Outputs.

A linked output alias will be translated to an object in the UI and stay linked to it.

type: ConstrainedStrValue¶

class queenbee.io.outputs.alias.DAGNumberOutputAlias(*, type: ConstrainedStrValue = 'DAGNumberOutputAlias', annotations: Dict[str, Any] = None, name: str, description: str = None, platform: List[str], handler: List[IOAliasHandler], required: bool = True, **extra_data: Any)[source]¶

Bases: DAGStringOutputAlias

DAG alias number output.

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

type: ConstrainedStrValue¶

class queenbee.io.outputs.alias.DAGPathOutputAlias(*, type: ConstrainedStrValue = 'DAGPathOutputAlias', annotations: Dict[str, Any] = None, name: str, description: str = None, platform: List[str], handler: List[IOAliasHandler], required: bool = True, **extra_data: Any)[source]¶

Bases: _DAGArtifactOutputAlias

DAG alias path output.

from_: Union[TaskReference, FileReference, FolderReference]¶

property is_artifact¶

type: ConstrainedStrValue¶

class queenbee.io.outputs.alias.DAGStringOutputAlias(*, type: ConstrainedStrValue = 'DAGStringOutputAlias', annotations: Dict[str, Any] = None, name: str, description: str = None, platform: List[str], handler: List[IOAliasHandler], required: bool = True, **extra_data: Any)[source]¶

Bases: DAGFileOutputAlias

DAG alias string output.

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

property is_artifact¶

type: ConstrainedStrValue¶