class Arguments:
workflows = graphene.List(WorkflowID, required=True)
rm = graphene.String(default_value='',
description=sstrip('''
Only clean the specified subdirectories or files in
the run directory, rather than the whole run.
A colon separated list that accepts globs,
e.g. ``.service/db:log:share:work/2020*``.
'''))
local_only = graphene.Boolean(default_value=False,
description=sstrip('''
Only clean on the local filesystem (not remote hosts).
'''))
remote_only = graphene.Boolean(default_value=False,
description=sstrip('''
Only clean on remote hosts (not the local filesystem).
'''))
class Meta:
description = sstrip('''
Start, resume or un-pause a workflow run.
''')
resolver = partial(mutator, command='play')
class Arguments:
workflows = graphene.List(WorkflowID, required=True)
cylc_version = CylcVersion(
description=sstrip('''
Set the Cylc version that the workflow starts with.
''')
)
initial_cycle_point = CyclePoint(
description=sstrip('''
Set the initial cycle point.
Required if not defined in flow.cylc.
''')
)
start_cycle_point = CyclePoint(
description=sstrip('''
Set the start cycle point, which may be after the initial cycle
point.
If the specified start point is not in the sequence, the next
on-sequence point will be used.
(Not to be confused with the initial cycle point).
This replaces the Cylc 7 --warm option.
''')
)
final_cycle_point = CyclePoint(
description=sstrip('''
Set the final cycle point. This command line option overrides
the workflow config option `[scheduling]final cycle point`.
''')
)
stop_cycle_point = CyclePoint(
description=sstrip('''
Set the stop cycle point. Shut down after all tasks have PASSED
this cycle point. (Not to be confused with the final cycle
point.) This command line option overrides the workflow config
option `[scheduling]stop after cycle point`.
''')
)
pause = graphene.Boolean(
description=sstrip('''
Pause workflow immediately on starting.
''')
)
hold_cycle_point = CyclePoint(
description=sstrip('''
Hold all tasks after this cycle point.
''')
)
mode = RunMode()
host = graphene.String(
description=sstrip('''
Specify the host on which to start-up the workflow. If not
specified, a host will be selected using the
`[scheduler]run hosts` global config.
''')
)
main_loop = graphene.List(
graphene.String,
description=sstrip('''
Specify an additional plugin to run in the main loop. These
are used in combination with those specified in
`[scheduler][main loop]plugins`. Can be used multiple times.
''')
)
abort_if_any_task_fails = graphene.Boolean(
default_value=False,
description=sstrip('''
If set workflow will abort with status 1 if any task fails.
''')
)
debug = graphene.Boolean(
default_value=False,
description=sstrip('''
Output developer information and show exception tracebacks.
''')
)
no_timestamp = graphene.Boolean(
default_value=False,
description=sstrip('''
Don't timestamp logged messages.
''')
)
set = graphene.List( # noqa: A003 (graphql field name)
graphene.String,
description=sstrip('''
Set the value of a Jinja2 template variable in the workflow
definition. Values should be valid Python literals so strings
must be quoted e.g. `STR="string"`, `INT=43`, `BOOL=True`.
This option can be used multiple times on the command line.
NOTE: these settings persist across workflow restarts, but can
be set again on the `cylc play` command line if they need to be
overridden.
''')
)
set_file = graphene.String(
description=sstrip('''
Set the value of Jinja2 template variables in the workflow
definition from a file containing NAME=VALUE pairs (one per
line). As with "set" values should be valid Python literals so
strings must be quoted e.g. `STR='string'`. NOTE: these
settings persist across workflow restarts, but can be set again
on the `cylc play` command line if they need to be overridden.
''')
)
class Meta:
description = sstrip('''
Clean a workflow from the run directory.
''')
resolver = partial(mutator, command='clean')
