openstack.workflow.v2.execution

The Execution Class

The Execution class inherits from Resource.

class openstack.workflow.v2.execution.Execution(_synchronized=False, connection=None, **attrs)

The base resource

Parameters:
  • _synchronized (bool) – This is not intended to be used directly. See new() and existing().

  • connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of self._connection in Resource code should protect itself with a check for None.

resource_key = 'execution'

Singular form of key for resource.

resources_key = 'executions'

Plural form of key for resource.

base_path = '/executions'

The base part of the URI for this resource.

allow_create = True

Allow create operation for this resource.

allow_list = True

Allow list operation for this resource.

allow_fetch = True

Allow get operation for this resource.

allow_delete = True

Allow delete operation for this resource.

workflow_name

The name of the workflow

workflow_id

The ID of the workflow

description

A description of the workflow execution

task_execution_id

A reference to the parent task execution

status

Status can be one of: IDLE, RUNNING, SUCCESS, ERROR, or PAUSED

status_info

An optional information string about the status

params

An optional JSON structure containing workflow type specific parameters

output

The output of the workflow

created_at

The time at which the Execution was created

updated_at

The time at which the Execution was updated

create(session, prepend_key=True, base_path=None, **kwargs)

Create a remote resource based on this instance.

Parameters:
  • session (Adapter) – The session to use for making this request.

  • prepend_key – A boolean indicating whether the resource_key should be prepended in a resource creation request. Default to True.

  • base_path (str) – Base part of the URI for creating resources, if different from base_path.

  • resource_request_key (str) – Overrides the usage of self.resource_key when prepending a key to the request body. Ignored if prepend_key is false.

  • resource_response_key (str) – Overrides the usage of self.resource_key when processing response bodies. Ignored if prepend_key is false.

  • microversion (str) – API version to override the negotiated one.

  • params (dict) – Additional params to pass.

Returns:

This Resource instance.

Raises:

MethodNotSupported if Resource.allow_create is not set to True.