Task Parameters Summary
:numref:task_arguments
summarizes all arguments that can be found in the @task decorator.
Argument |
Value |
|
---|---|---|
Formal parameter name |
(default: empty) |
The parameter is an object or a simple tipe that will be inferred. |
IN |
Read-only parameter, all types. |
|
IN_DELETE |
Read-only parameter, all types. Automatic delete after usage. |
|
INOUT |
Read-write parameter, all types except file and primitives. |
|
OUT |
Write-only parameter, all types except file and primitives (requires default constructor). |
|
CONCURRENT |
Concurrent read-write parameter, all types except file and primitives. |
|
COMMUTATIVE |
Commutative read-write parameter, all types except file and primitives. |
|
FILE(_IN) |
Read-only file parameter. |
|
FILE_INOUT |
Read-write file parameter. |
|
FILE_OUT |
Write-only file parameter. |
|
FILE_CONCURRENT |
Concurrent read-write file parameter. |
|
FILE_COMMUTATIVE |
Commutative read-write file parameter. |
|
DIRECTORY(_IN) |
The parameter is a read-only directory. |
|
DIRECTORY_INOUT |
The parameter is a read-write directory. |
|
DIRECTORY_OUT |
the parameter is a write-only directory. |
|
COLLECTION(_IN) |
Read-only collection parameter ( |
|
COLLECTION_IN_DELETE |
Single usage read-only collection parameter ( |
|
COLLECTION_INOUT |
Read-write collection parameter ( |
|
COLLECTION_OUT |
Read-only collection parameter ( |
|
COLLECTION_FILE(_IN) |
Read-only collection of files parameter ( |
|
COLLECTION_FILE_INOUT |
Read-write collection of files parameter ( |
|
COLLECTION_FILE_OUT |
Read-only collection of files parameter ( |
|
DICTIONARY(_IN) |
Read-only dictionary parameter ( |
|
DICTIONARY_IN_DELETE |
Single usage read-only collection dictionary ( |
|
DICTIONARY_INOUT |
Read-write dictionary parameter ( |
|
STREAM_IN |
The parameter is a read-only stream. |
|
STREAM_OUT |
The parameter is a write-only stream. |
|
STDIN |
The parameter is a file for standard input redirection (only for binaries). |
|
STDOUT |
The parameter is a file for standard output redirection (only for binaries). |
|
STDERR |
The parameter is a file for standard error redirection (only for binaries). |
|
Explicit: |
||
returns |
Return type or number of returned elements |
|
target_direction |
INOUT (default), IN or CONCURRENT |
|
priority |
|
|
is_distributed |
|
|
is_replicated |
|
|
on_failure |
’RETRY’ (default), ’CANCEL_SUCCESSORS’, ’FAIL’ or ’IGNORE’ |
|
time_out |
|
|
cache_returns |
|
|
is_reduce |
|
|
chunk_size |
Reduction chunk size ( |
|
numba |
True or False (default) or mode ( |
|
numba_flags |
Numba flags ( |
|
numba_signature |
Numba signature ( |
|
numba_declaration |
Numba declaration ( |