The workflow high-level interface is available through the workflow
member of a Connection
object.
The workflow
member will only be added if the service is detected.
Create a new workflow from attributes
Update workflow from attributes
Get a workflow
workflow – The value can be the name of a workflow or
Workflow
instance.
One Workflow
NotFoundException
when no
workflow matching the name could be found.
Retrieve a generator of workflows
query (kwargs) –
Optional query parameters to be sent to restrict the workflows to be returned. Available parameters include:
limit: Requests at most the specified number of items be returned from the query.
marker: Specifies the ID of the last-seen workflow. Use the limit parameter to make an initial limited request and use the ID of the last-seen workflow from the response as the marker parameter value in a subsequent limited request.
A generator of workflow instances.
Delete a workflow
value – The value can be either the name of a workflow or a
Workflow
instance.
ignore_missing (bool) – When set to False
NotFoundException
will
be raised when the workflow does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent workflow.
None
Find a single workflow
name_or_id – The name or ID of an workflow.
ignore_missing (bool) – When set to False
NotFoundException
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
One Extension
or
None
Create a new execution from attributes
Get a execution
workflow_name – The name of target workflow to execute.
execution – The value can be either the ID of a execution or a
Execution
instance.
One Execution
NotFoundException
when no
execution matching the criteria could be found.
Retrieve a generator of executions
query (kwargs) –
Optional query parameters to be sent to restrict the executions to be returned. Available parameters include:
limit: Requests at most the specified number of items be returned from the query.
marker: Specifies the ID of the last-seen execution. Use the limit parameter to make an initial limited request and use the ID of the last-seen execution from the response as the marker parameter value in a subsequent limited request.
A generator of execution instances.
Delete an execution
value – The value can be either the name of a execution or a
Execution
instance.
ignore_missing (bool) – When set to False
NotFoundException
will be
raised when the execution does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent execution.
None
Find a single execution
name_or_id – The name or ID of an execution.
ignore_missing (bool) – When set to False
NotFoundException
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
One Execution
or
None
Create a new cron trigger from attributes
attrs (dict) – Keyword arguments which will be used to create
a CronTrigger
,
comprised of the properties on the CronTrigger class.
The results of cron trigger creation
Get a cron trigger
cron_trigger – The value can be the name of a cron_trigger or
CronTrigger
instance.
One CronTrigger
NotFoundException
when no
cron triggers matching the criteria could be found.
Retrieve a generator of cron triggers
all_projects (bool) – When set to True
, list cron triggers from
all projects. Admin-only by default.
query (kwargs) –
Optional query parameters to be sent to restrict the cron triggers to be returned. Available parameters include:
limit: Requests at most the specified number of items be returned from the query.
marker: Specifies the ID of the last-seen cron trigger. Use the limit parameter to make an initial limited request and use the ID of the last-seen cron trigger from the response as the marker parameter value in a subsequent limited request.
A generator of CronTrigger instances.
Delete a cron trigger
value – The value can be either the name of a cron trigger or a
CronTrigger
instance.
ignore_missing (bool) – When set to False
NotFoundException
will be
raised when the cron trigger does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent cron trigger.
None
Find a single cron trigger
name_or_id – The name or ID of a cron trigger.
ignore_missing (bool) – When set to False
NotFoundException
will be raised when
the resource does not exist. When set to True
, None will be
returned when attempting to find a nonexistent resource.
all_projects (bool) – When set to True
, search for cron
triggers by name across all projects. Note that this will likely
result in a higher chance of duplicates.
query (kwargs) – Optional query parameters to be sent to limit the cron triggers being returned.
One CronTrigger
or None
NotFoundException
when no
resource can be found.
DuplicateResource
when multiple
resources are found.
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.