Spec for an output task port
Attributes
human_name: Optionalis_optional: boolresource_types: Listshort_description: Optionalvalidators: ListFunctions
summary
are compatible with any child class of the provided resource type, defaults to False
and it does not need to create a new resource after the task, defaults to False
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| resource_types | Union | _description_ resourcetypes | |
| is_optional | bool | False | Tell that this output may return none or not being provided, defaults to false , optional |
| sub_class | bool | False | When true, it tells that the resource_types |
| is_constant | bool | False | When true, this tells the system that the output resource was not modified from the input resource |
| 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:
OutputSpec |