flywheel.models.gear_invocation
Provides gear invocation support
GearInvocation
Bases: object
Represents the details necessary to execute a gear as a job
add_tag(tag)
Add a tag to the job
add_tags(tags)
Add multiple tags to the job
propose_batch(containers, optional_input_policy='ignored')
Create a batch run proposal for the given containers
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
containers | list | The list of containers to run the job on | required |
optional_input_policy | str | The optional input policy (default is ignored) | 'ignored' |
run()
Run the invocation as a single job (or analysis).
Requires that required inputs and the destination have been set.
Returns the job id, or the analysis id in the case of an analysis gear.
set_analysis_label(label)
Set the analysis label, if executing an analysis gear
set_destination(dest)
Set the destination container
set_input(key, input)
Add an input
set_priority(priority)
Set the priority of gear job
update_config(*args, **kwargs)
Update configuration values