idmtools.entities.iworkflow_item module¶

class idmtools.entities.iworkflow_item.IWorkflowItem(_uid: uuid.UUID = None, platform_id: uuid.UUID = None, _platform: IPlatform = None, parent_id: uuid.UUID = None, _parent: IEntity = None, status: idmtools.core.enums.EntityStatus = None, tags: Dict[str, Any] = <factory>, _platform_object: Any = None, name: str = None, assets: idmtools.assets.asset_collection.AssetCollection = <factory>, item_name: str = 'Idm WorkItem Test', asset_collection_id: uuid.UUID = None, asset_files: idmtools.assets.file_list.FileList = None, user_files: idmtools.assets.file_list.FileList = None, related_experiments: list = None, related_simulations: list = None, related_suites: list = None, related_work_items: list = None, related_asset_collections: list = None, work_item_type: str = None)¶

Bases: idmtools.core.interfaces.iassets_enabled.IAssetsEnabled, idmtools.core.interfaces.inamed_entity.INamedEntity, abc.ABC

Interface of idmtools work item

item_name: str = 'Idm WorkItem Test'¶

tags: Dict[str, Any]¶

asset_collection_id: uuid.UUID = None¶

asset_files: idmtools.assets.file_list.FileList = None¶

user_files: idmtools.assets.file_list.FileList = None¶

related_experiments: list = None¶

related_simulations: list = None¶

related_suites: list = None¶

related_work_items: list = None¶

related_asset_collections: list = None¶

work_item_type: str = None¶

item_type: ItemType = 4¶

gather_assets() → NoReturn¶: Function called at runtime to gather all assets in the collection.

add_file(af)¶

Methods used to add new file :param af: file to add

Returns: None

clear_user_files()¶

Clear all existing user files

Returns: None

pre_creation() → None¶: Called before the actual creation of the entity.

run(wait_on_done: bool = False, wait_on_done_progress: bool = True, platform: IPlatform = None)¶

Run the item on specified platform

Parameters

wait_on_done – Should we wait on item to finish running? Default is false
wait_on_done_progress – When waiting, should we try to show progress
platform – optional platform object

Returns:

wait(wait_on_done_progress: bool = True, platform: IPlatform = None)¶

Wait on item to finish

Parameters

wait_on_done_progress – Should we show progress as we wait?
platform – Optional platform object

Returns:

to_dict() → Dict¶