Workflow API¶
The Workflow Class¶
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.
Workflow Operations¶
- class openstack.workflow.v2._proxy.Proxy(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)
- create_workflow(**attrs)
Create a new workflow from attributes
- get_workflow(*attrs)
Get a workflow
- workflows(**query)
Retrieve a generator of workflows
- Parameters
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.
- Returns
A generator of workflow instances.
- delete_workflow(value, ignore_missing=True)
Delete a workflow
- Parameters
value – The value can be either the name of a workflow or a
Workflow
instance.ignore_missing (bool) – When set to
False
ResourceNotFound
will be raised when the workflow does not exist. When set toTrue
, no exception will be set when attempting to delete a nonexistent workflow.
- Returns
None
- find_workflow(name_or_id, ignore_missing=True)
Find a single workflow
- Parameters
name_or_id – The name or ID of an workflow.
ignore_missing (bool) – When set to
False
ResourceNotFound
will be raised when the resource does not exist. When set toTrue
, None will be returned when attempting to find a nonexistent resource.
- Returns
One
Extension
or None
Execution Operations¶
- class openstack.workflow.v2._proxy.Proxy(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)
- create_execution(**attrs)
Create a new execution from attributes
- get_execution(*attrs)
Get a execution
- executions(**query)
Retrieve a generator of executions
- Parameters
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.
- Returns
A generator of execution instances.
- delete_execution(value, ignore_missing=True)
Delete an execution
- Parameters
value – The value can be either the name of a execution or a
Execution
instance.ignore_missing (bool) – When set to
False
ResourceNotFound
will be raised when the execution does not exist. When set toTrue
, no exception will be set when attempting to delete a nonexistent execution.
- Returns
None
- find_execution(name_or_id, ignore_missing=True)
Find a single execution
- Parameters
name_or_id – The name or ID of an execution.
ignore_missing (bool) – When set to
False
ResourceNotFound
will be raised when the resource does not exist. When set toTrue
, None will be returned when attempting to find a nonexistent resource.
- Returns
One
Execution
or None