InputSpec
Spec for an input task port
Attributes
human_name: Optionalis_optional: boolresource_types: Listshort_description: Optionalvalidators: ListFunctions
summary
If the input is connected, the system will wait for the input to be provided before running the task.
Also tells that None value is allowed as input. , defaults to False
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| resource_types | Union | _description_ resourcetypes | |
| is_optional | bool | False | This input might not be connected to another task output and the task will still be executed. , optional |
| is_skippable | bool | False | :param is_skippable deprecated, use is_optional instead. , optional |
| human_name | Optional | _description_, defaults to none [str], optional | |
| short_description | Optional | _description_, defaults to none [str], optional |
return the first default type
Return type:
Type |
Return type:
Tuple |
Return type:
str |
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| in_spec | IOSpec |
Return type:
bool |
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| resource_type | Type |
Return type:
bool |
return True if one of the resource_types is compatible with the this spec
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| resource_types | Iterable |
Return type:
bool |
Return type:
bool |
Return type:
bool |
Return type:
IOSpecDTO |
Validate a resource with the validators
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| resource | Resource |
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| dto | IOSpecDTO |
Return type:
IOSpec |