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.

class openstack.workflow.v2._proxy.Proxy(session)¶

create_workflow(**attrs)¶

Create a new workflow from attributes

Parameters:	attrs (dict) – Keyword arguments which will be used to create a Workflow, comprised of the properties on the Workflow class.
Returns:	The results of workflow creation
Return type:	Workflow

get_workflow(*attrs)¶

Get a workflow

Parameters:	workflow – The value can be the name of a workflow or Workflow instance.
Returns:	One Workflow
Raises:	ResourceNotFound when no workflow matching the name could be found.

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 to True, 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 to True, None will be returned when attempting to find a nonexistent resource.
Returns:	One Extension or None

create_execution(**attrs)¶

Create a new execution from attributes

Parameters:	workflow_name – The name of target workflow to execute. attrs (dict) – Keyword arguments which will be used to create a Execution, comprised of the properties on the Execution class.
Returns:	The results of execution creation
Return type:	Execution

get_execution(*attrs)¶

Get a execution

Parameters:	workflow_name – The name of target workflow to execute. execution – The value can be either the ID of a execution or a Execution instance.
Returns:	One Execution
Raises:	ResourceNotFound when no execution matching the criteria could be found.

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 to True, 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 to True, None will be returned when attempting to find a nonexistent resource.
Returns:	One Execution or None