mistral.api.controllers.v2 package

Submodules

mistral.api.controllers.v2.action module

class mistral.api.controllers.v2.action.ActionsController

Bases: pecan.rest.RestController, pecan.hooks.HookController

delete(*args, **kwargs)

Delete the named action.

get(*args, **kwargs)

Return the named action.

Parameters:identifier – ID or name of the Action to get.

get_all(*args, **kwargs)

Return all actions.

Parameters:

• marker – Optional. Pagination marker for large data sets.
• limit – Optional. Maximum number of resources to return in a single result. Default value is None for backward compatibility.
• sort_keys – Optional. Columns to sort results by. Default: name.
• sort_dirs – Optional. Directions to sort corresponding to sort_keys, “asc” or “desc” can be chosen. Default: asc.
• fields – Optional. A specified list of fields of the resource to be returned. ‘id’ will be included automatically in fields if it’s provided, since it will be used when constructing ‘next’ link.
• name – Optional. Keep only resources with a specific name.
• scope – Optional. Keep only resources with a specific scope.
• definition – Optional. Keep only resources with a specific definition.
• is_system – Optional. Keep only system actions or ad-hoc actions (if False).
• input – Optional. Keep only resources with a specific input.
• description – Optional. Keep only resources with a specific description.
• tags – Optional. Keep only resources containing specific tags.
• created_at – Optional. Keep only resources created at a specific time and date.
• updated_at – Optional. Keep only resources with specific latest update time and date.

Where project_id is the same as the requester or project_id is different but the scope is public.

post(*args, **kwargs)

Create a new action.

NOTE: This text is allowed to have definitions

of multiple actions. In this case they all will be created.

put(*args, **kwargs)

Update one or more actions.

NOTE: This text is allowed to have definitions

of multiple actions. In this case they all will be updated.

mistral.api.controllers.v2.action_execution module

class mistral.api.controllers.v2.action_execution.ActionExecutionsController

Bases: pecan.rest.RestController

delete(*args, **kwargs)

Delete the specified action_execution.

get(*args, **kwargs)

Return the specified action_execution.

get_all(*args, **kwargs)

Return all tasks within the execution.

Where project_id is the same as the requester or project_id is different but the scope is public.

Parameters:

• marker – Optional. Pagination marker for large data sets.
• limit – Optional. Maximum number of resources to return in a single result. Default value is None for backward compatibility.
• sort_keys – Optional. Columns to sort results by. Default: created_at, which is backward compatible.
• sort_dirs – Optional. Directions to sort corresponding to sort_keys, “asc” or “desc” can be chosen. Default: desc. The length of sort_dirs can be equal or less than that of sort_keys.
• fields – Optional. A specified list of fields of the resource to be returned. ‘id’ will be included automatically in fields if it’s provided, since it will be used when constructing ‘next’ link.
• name – Optional. Keep only resources with a specific name.
• workflow_name – Optional. Keep only resources with a specific workflow name.
• task_name – Optional. Keep only resources with a specific task name.
• task_execution_id – Optional. Keep only resources within a specific task execution.
• state – Optional. Keep only resources with a specific state.
• state_info – Optional. Keep only resources with specific state information.
• accepted – Optional. Keep only resources which have been accepted or not.
• input – Optional. Keep only resources with a specific input.
• output – Optional. Keep only resources with a specific output.
• params – Optional. Keep only resources with specific parameters.
• description – Optional. Keep only resources with a specific description.
• tags – Optional. Keep only resources containing specific tags.
• created_at – Optional. Keep only resources created at a specific time and date.
• updated_at – Optional. Keep only resources with specific latest update time and date.

post(*args, **kwargs)

Create new action_execution.

put(*args, **kwargs)

Update the specified action_execution.

class mistral.api.controllers.v2.action_execution.TasksActionExecutionController

Bases: pecan.rest.RestController

get(*args, **kwargs)

Return the specified action_execution.

get_all(*args, **kwargs)

Return all tasks within the execution.

Where project_id is the same as the requester or project_id is different but the scope is public.

Parameters:

• task_execution_id – Keep only resources within a specific task execution.
• marker – Optional. Pagination marker for large data sets.
• limit – Optional. Maximum number of resources to return in a single result. Default value is None for backward compatibility.
• sort_keys – Optional. Columns to sort results by. Default: created_at, which is backward compatible.
• sort_dirs – Optional. Directions to sort corresponding to sort_keys, “asc” or “desc” can be chosen. Default: desc. The length of sort_dirs can be equal or less than that of sort_keys.
• fields – Optional. A specified list of fields of the resource to be returned. ‘id’ will be included automatically in fields if it’s provided, since it will be used when constructing ‘next’ link.
• name – Optional. Keep only resources with a specific name.
• workflow_name – Optional. Keep only resources with a specific workflow name.
• task_name – Optional. Keep only resources with a specific task name.
• state – Optional. Keep only resources with a specific state.
• state_info – Optional. Keep only resources with specific state information.
• accepted – Optional. Keep only resources which have been accepted or not.
• input – Optional. Keep only resources with a specific input.
• output – Optional. Keep only resources with a specific output.
• params – Optional. Keep only resources with specific parameters.
• description – Optional. Keep only resources with a specific description.
• tags – Optional. Keep only resources containing specific tags.
• created_at – Optional. Keep only resources created at a specific time and date.
• updated_at – Optional. Keep only resources with specific latest update time and date.

mistral.api.controllers.v2.cron_trigger module

class mistral.api.controllers.v2.cron_trigger.CronTriggersController

Bases: pecan.rest.RestController

delete(*args, **kwargs)

Delete cron trigger.

get(*args, **kwargs)

Returns the named cron_trigger.

get_all(*args, **kwargs)

Return all cron triggers.

Parameters:

• marker – Optional. Pagination marker for large data sets.
• limit – Optional. Maximum number of resources to return in a single result. Default value is None for backward compatibility.
• sort_keys – Optional. Columns to sort results by. Default: created_at, which is backward compatible.
• sort_dirs – Optional. Directions to sort corresponding to sort_keys, “asc” or “desc” can be chosen. Default: desc. The length of sort_dirs can be equal or less than that of sort_keys.
• fields – Optional. A specified list of fields of the resource to be returned. ‘id’ will be included automatically in fields if it’s provided, since it will be used when constructing ‘next’ link.
• name – Optional. Keep only resources with a specific name.
• workflow_name – Optional. Keep only resources with a specific workflow name.
• workflow_id – Optional. Keep only resources with a specific workflow ID.
• workflow_input – Optional. Keep only resources with a specific workflow input.
• workflow_params – Optional. Keep only resources with specific workflow parameters.
• scope – Optional. Keep only resources with a specific scope.
• pattern – Optional. Keep only resources with a specific pattern.
• remaining_executions – Optional. Keep only resources with a specific number of remaining executions.
• first_execution_time – Optional. Keep only resources with a specific time and date of first execution.
• next_execution_time – Optional. Keep only resources with a specific time and date of next execution.
• created_at – Optional. Keep only resources created at a specific time and date.
• updated_at – Optional. Keep only resources with specific latest update time and date.

post(*args, **kwargs)

Creates a new cron trigger.

Parameters:cron_trigger – Required. Cron trigger structure.

mistral.api.controllers.v2.environment module

class mistral.api.controllers.v2.environment.EnvironmentController

Bases: pecan.rest.RestController

delete(*args, **kwargs)

Delete the named environment.

get(*args, **kwargs)

Return the named environment.

get_all(*args, **kwargs)

Return all environments.

Where project_id is the same as the requester or project_id is different but the scope is public.

Parameters:

• marker – Optional. Pagination marker for large data sets.
• limit – Optional. Maximum number of resources to return in a single result. Default value is None for backward compatibility.
• sort_keys – Optional. Columns to sort results by. Default: created_at, which is backward compatible.
• sort_dirs – Optional. Directions to sort corresponding to sort_keys, “asc” or “desc” can be chosen. Default: desc. The length of sort_dirs can be equal or less than that of sort_keys.
• fields – Optional. A specified list of fields of the resource to be returned. ‘id’ will be included automatically in fields if it’s provided, since it will be used when constructing ‘next’ link.
• name – Optional. Keep only resources with a specific name.
• description – Optional. Keep only resources with a specific description.
• variables – Optional. Keep only resources with specific variables.
• scope – Optional. Keep only resources with a specific scope.
• created_at – Optional. Keep only resources created at a specific time and date.
• updated_at – Optional. Keep only resources with specific latest update time and date.

post(*args, **kwargs)

Create a new environment.

put(*args, **kwargs)

Update an environment.

mistral.api.controllers.v2.event_trigger module

class mistral.api.controllers.v2.event_trigger.EventTriggersController

Bases: pecan.rest.RestController

delete(*args, **kwargs)

Delete event trigger.

get(*args, **kwargs)

Returns the specified event_trigger.

get_all(*args, **kwargs)

Return all event triggers.

post(*args, **kwargs)

Creates a new event trigger.

put(*args, **kwargs)

Updates an existing event trigger.

The exchange, topic and event can not be updated. The right way to change them is to delete the event trigger first, then create a new event trigger with new params.

mistral.api.controllers.v2.execution module

class mistral.api.controllers.v2.execution.ExecutionsController

Bases: pecan.rest.RestController

delete(*args, **kwargs)

Delete the specified Execution.

get(*args, **kwargs)

Return the specified Execution.

get_all(*args, **kwargs)

Return all Executions.

Parameters:

• marker – Optional. Pagination marker for large data sets.
• limit – Optional. Maximum number of resources to return in a single result. Default value is None for backward compatibility.
• sort_keys – Optional. Columns to sort results by. Default: created_at, which is backward compatible.
• sort_dirs – Optional. Directions to sort corresponding to sort_keys, “asc” or “desc” can be chosen. Default: desc. The length of sort_dirs can be equal or less than that of sort_keys.
• fields – Optional. A specified list of fields of the resource to be returned. ‘id’ will be included automatically in fields if it’s provided, since it will be used when constructing ‘next’ link.
• workflow_name – Optional. Keep only resources with a specific workflow name.
• workflow_id – Optional. Keep only resources with a specific workflow ID.
• description – Optional. Keep only resources with a specific description.
• params – Optional. Keep only resources with specific parameters.
• task_execution_id – Optional. Keep only resources with a specific task execution ID.
• state – Optional. Keep only resources with a specific state.
• state_info – Optional. Keep only resources with specific state information.
• input – Optional. Keep only resources with a specific input.
• output – Optional. Keep only resources with a specific output.
• created_at – Optional. Keep only resources created at a specific time and date.
• updated_at – Optional. Keep only resources with specific latest update time and date.
• include_output – Optional. Include the output for all executions in the list

post(*args, **kwargs)

Create a new Execution.

Parameters:wf_ex – Execution object with input content.

put(*args, **kwargs)

Update the specified workflow execution.

Parameters:

• id – execution ID.
• wf_ex – Execution object.

mistral.api.controllers.v2.member module

class mistral.api.controllers.v2.member.MembersController(type, resource_id)

Bases: pecan.rest.RestController

delete(*args, **kwargs)

Deletes a member from the member list of a resource.

get(*args, **kwargs)

Shows resource member details.

get_all(*args, **kwargs)

Return all members with whom the resource has been shared.

post(*args, **kwargs)

Shares the resource to a new member.

put(*args, **kwargs)

Sets the status for a resource member.

mistral.api.controllers.v2.resources module

class mistral.api.controllers.v2.resources.Action(**kw)

Bases: mistral.api.controllers.resource.Resource

Action resource.

NOTE: name is immutable. Note that name and description get inferred from action definition when Mistral service receives a POST request. So they can’t be changed in another way.

classmethod sample()

class mistral.api.controllers.v2.resources.ActionExecution(**kw)

Bases: mistral.api.controllers.resource.Resource

ActionExecution resource.

classmethod sample()

class mistral.api.controllers.v2.resources.ActionExecutions(**kwargs)

Bases: mistral.api.controllers.resource.ResourceList

A collection of action_executions.

classmethod sample()

class mistral.api.controllers.v2.resources.Actions(**kwargs)

Bases: mistral.api.controllers.resource.ResourceList

A collection of Actions.

classmethod sample()

class mistral.api.controllers.v2.resources.CronTrigger(**kw)

Bases: mistral.api.controllers.resource.Resource

CronTrigger resource.

classmethod sample()

class mistral.api.controllers.v2.resources.CronTriggers(**kwargs)

Bases: mistral.api.controllers.resource.ResourceList

A collection of cron triggers.

classmethod sample()

class mistral.api.controllers.v2.resources.Environment(**kw)

Bases: mistral.api.controllers.resource.Resource

Environment resource.

classmethod sample()

class mistral.api.controllers.v2.resources.Environments(**kwargs)

Bases: mistral.api.controllers.resource.ResourceList

A collection of Environment resources.

classmethod sample()

class mistral.api.controllers.v2.resources.EventTrigger(**kw)

Bases: mistral.api.controllers.resource.Resource

EventTrigger resource.

classmethod sample()

class mistral.api.controllers.v2.resources.EventTriggers(**kwargs)

Bases: mistral.api.controllers.resource.ResourceList

A collection of event triggers.

classmethod sample()

class mistral.api.controllers.v2.resources.Execution(**kw)

Bases: mistral.api.controllers.resource.Resource

Execution resource.

classmethod sample()

class mistral.api.controllers.v2.resources.Executions(**kwargs)

Bases: mistral.api.controllers.resource.ResourceList

A collection of Execution resources.

classmethod sample()

class mistral.api.controllers.v2.resources.Member(**kw)

Bases: mistral.api.controllers.resource.Resource

classmethod sample()

class mistral.api.controllers.v2.resources.Members(**kw)

Bases: mistral.api.controllers.resource.ResourceList

classmethod sample()

class mistral.api.controllers.v2.resources.Service(**kw)

Bases: mistral.api.controllers.resource.Resource

Service resource.

classmethod sample()

class mistral.api.controllers.v2.resources.Services(**kw)

Bases: mistral.api.controllers.resource.Resource

A collection of Services.

classmethod sample()

class mistral.api.controllers.v2.resources.Task(**kw)

Bases: mistral.api.controllers.resource.Resource

Task resource.

classmethod sample()

class mistral.api.controllers.v2.resources.Tasks(**kwargs)

Bases: mistral.api.controllers.resource.ResourceList

A collection of tasks.

classmethod sample()

class mistral.api.controllers.v2.resources.Workbook(**kw)

Bases: mistral.api.controllers.resource.Resource

Workbook resource.

classmethod sample()

class mistral.api.controllers.v2.resources.Workbooks(**kwargs)

Bases: mistral.api.controllers.resource.ResourceList

A collection of Workbooks.

classmethod sample()

class mistral.api.controllers.v2.resources.Workflow(**kw)

Bases: mistral.api.controllers.resource.Resource

Workflow resource.

classmethod from_dict(d)

classmethod sample()

class mistral.api.controllers.v2.resources.Workflows(**kwargs)

Bases: mistral.api.controllers.resource.ResourceList

A collection of workflows.

classmethod sample()

mistral.api.controllers.v2.root module

class mistral.api.controllers.v2.root.Controller

Bases: object

API root controller for version 2.

index(*args, **kwargs)

class mistral.api.controllers.v2.root.RootResource(**kw)

Bases: mistral.api.controllers.resource.Resource

Root resource for API version 2.

It references all other resources belonging to the API.

mistral.api.controllers.v2.service module

class mistral.api.controllers.v2.service.ServicesController

Bases: pecan.rest.RestController

get_all(*args, **kwargs)

Return all services.

mistral.api.controllers.v2.task module

class mistral.api.controllers.v2.task.ExecutionTasksController

Bases: pecan.rest.RestController

get_all(*args, **kwargs)

Return all tasks within the execution.

Where project_id is the same as the requester or project_id is different but the scope is public.

Parameters:

• marker – Optional. Pagination marker for large data sets.
• limit – Optional. Maximum number of resources to return in a single result. Default value is None for backward compatibility.
• sort_keys – Optional. Columns to sort results by. Default: created_at, which is backward compatible.
• sort_dirs – Optional. Directions to sort corresponding to sort_keys, “asc” or “desc” can be chosen. Default: desc. The length of sort_dirs can be equal or less than that of sort_keys.
• fields – Optional. A specified list of fields of the resource to be returned. ‘id’ will be included automatically in fields if it’s provided, since it will be used when constructing ‘next’ link.
• name – Optional. Keep only resources with a specific name.
• workflow_name – Optional. Keep only resources with a specific workflow name.
• workflow_id – Optional. Keep only resources with a specific workflow ID.
• workflow_execution_id – Optional. Keep only resources with a specific workflow execution ID.
• state – Optional. Keep only resources with a specific state.
• state_info – Optional. Keep only resources with specific state information.
• result – Optional. Keep only resources with a specific result.
• published – Optional. Keep only resources with specific published content.
• processed – Optional. Keep only resources which have been processed or not.
• reset – Optional. Keep only resources which have been reset or not.
• env – Optional. Keep only resources with a specific environment.
• created_at – Optional. Keep only resources created at a specific time and date.
• updated_at – Optional. Keep only resources with specific latest update time and date.

class mistral.api.controllers.v2.task.TaskExecutionsController

Bases: pecan.rest.RestController

get_all(*args, **kwargs)

Return all executions that belong to the given task execution.

Parameters:

• task_execution_id – Task task execution ID.
• marker – Optional. Pagination marker for large data sets.
• limit – Optional. Maximum number of resources to return in a single result. Default value is None for backward compatibility.
• sort_keys – Optional. Columns to sort results by. Default: created_at, which is backward compatible.
• sort_dirs – Optional. Directions to sort corresponding to sort_keys, “asc” or “desc” can be chosen. Default: desc. The length of sort_dirs can be equal or less than that of sort_keys.
• fields – Optional. A specified list of fields of the resource to be returned. ‘id’ will be included automatically in fields if it’s provided, since it will be used when constructing ‘next’ link.
• workflow_name – Optional. Keep only resources with a specific workflow name.
• workflow_id – Optional. Keep only resources with a specific workflow ID.
• description – Optional. Keep only resources with a specific description.
• params – Optional. Keep only resources with specific parameters.
• state – Optional. Keep only resources with a specific state.
• state_info – Optional. Keep only resources with specific state information.
• input – Optional. Keep only resources with a specific input.
• output – Optional. Keep only resources with a specific output.
• created_at – Optional. Keep only resources created at a specific time and date.
• updated_at – Optional. Keep only resources with specific latest update time and date.

class mistral.api.controllers.v2.task.TasksController

Bases: pecan.rest.RestController

get(*args, **kwargs)

Return the specified task.

get_all(*args, **kwargs)

Return all tasks.

Where project_id is the same as the requester or project_id is different but the scope is public.

Parameters:

• marker – Optional. Pagination marker for large data sets.
• limit – Optional. Maximum number of resources to return in a single result. Default value is None for backward compatibility.
• sort_keys – Optional. Columns to sort results by. Default: created_at, which is backward compatible.
• sort_dirs – Optional. Directions to sort corresponding to sort_keys, “asc” or “desc” can be chosen. Default: desc. The length of sort_dirs can be equal or less than that of sort_keys.
• fields – Optional. A specified list of fields of the resource to be returned. ‘id’ will be included automatically in fields if it’s provided, since it will be used when constructing ‘next’ link.
• name – Optional. Keep only resources with a specific name.
• workflow_name – Optional. Keep only resources with a specific workflow name.
• workflow_id – Optional. Keep only resources with a specific workflow ID.
• workflow_execution_id – Optional. Keep only resources with a specific workflow execution ID.
• state – Optional. Keep only resources with a specific state.
• state_info – Optional. Keep only resources with specific state information.
• result – Optional. Keep only resources with a specific result.
• published – Optional. Keep only resources with specific published content.
• processed – Optional. Keep only resources which have been processed or not.
• reset – Optional. Keep only resources which have been reset or not.
• env – Optional. Keep only resources with a specific environment.
• created_at – Optional. Keep only resources created at a specific time and date.
• updated_at – Optional. Keep only resources with specific latest update time and date.

put(*args, **kwargs)

Update the specified task execution.

Parameters:

• id – Task execution ID.
• task – Task execution object.

mistral.api.controllers.v2.types module

class mistral.api.controllers.v2.types.JsonType

Bases: wsme.types.UserType

A simple JSON type.

basetype

alias of unicode

frombasetype(value)

tobasetype(value)

validate(value)

class mistral.api.controllers.v2.types.ListType

Bases: wsme.types.UserType

A simple list type.

basetype

alias of unicode

static frombasetype(value)

static validate(value)

Validate and convert the input to a ListType.

Parameters:value – A comma separated string of values Returns:A list of values.

class mistral.api.controllers.v2.types.UniqueListType

Bases: mistral.api.controllers.v2.types.ListType

A simple list type with no duplicate items.

static frombasetype(value)

static validate(value)

Validate and convert the input to a UniqueListType.

Parameters:value – A comma separated string of values. Returns:A list with no duplicate items.

class mistral.api.controllers.v2.types.UuidType

Bases: wsme.types.UserType

A simple UUID type.

The builtin UuidType class in wsme.types doesn’t work properly with pecan.

basetype

alias of unicode

static frombasetype(value)

static validate(value)

mistral.api.controllers.v2.validation module

class mistral.api.controllers.v2.validation.SpecValidationController(parser)

Bases: pecan.rest.RestController

post()

Validate a spec.

mistral.api.controllers.v2.workbook module

class mistral.api.controllers.v2.workbook.WorkbooksController

Bases: pecan.rest.RestController, pecan.hooks.HookController

delete(*args, **kwargs)

Delete the named workbook.

get(*args, **kwargs)

Return the named workbook.

get_all(*args, **kwargs)

Return a list of workbooks.

Parameters:

• marker – Optional. Pagination marker for large data sets.
• limit – Optional. Maximum number of resources to return in a single result. Default value is None for backward compatibility.
• sort_keys – Optional. Columns to sort results by. Default: created_at.
• sort_dirs – Optional. Directions to sort corresponding to sort_keys, “asc” or “desc” can be chosen. Default: asc.
• fields – Optional. A specified list of fields of the resource to be returned. ‘id’ will be included automatically in fields if it’s provided, since it will be used when constructing ‘next’ link.
• name – Optional. Keep only resources with a specific name.
• definition – Optional. Keep only resources with a specific definition.
• tags – Optional. Keep only resources containing specific tags.
• scope – Optional. Keep only resources with a specific scope.
• created_at – Optional. Keep only resources created at a specific time and date.
• updated_at – Optional. Keep only resources with specific latest update time and date.

Where project_id is the same as the requester or project_id is different but the scope is public.

post(*args, **kwargs)

Create a new workbook.

put(*args, **kwargs)

Update a workbook.

mistral.api.controllers.v2.workflow module

class mistral.api.controllers.v2.workflow.WorkflowsController

Bases: pecan.rest.RestController, pecan.hooks.HookController

delete(*args, **kwargs)

Delete a workflow.

get(*args, **kwargs)

Return the named workflow.

get_all(*args, **kwargs)

Return a list of workflows.

Parameters:

• marker – Optional. Pagination marker for large data sets.
• limit – Optional. Maximum number of resources to return in a single result. Default value is None for backward compatibility.
• sort_keys – Optional. Columns to sort results by. Default: created_at.
• sort_dirs – Optional. Directions to sort corresponding to sort_keys, “asc” or “desc” can be chosen. Default: asc.
• fields – Optional. A specified list of fields of the resource to be returned. ‘id’ will be included automatically in fields if it’s provided, since it will be used when constructing ‘next’ link.
• name – Optional. Keep only resources with a specific name.
• input – Optional. Keep only resources with a specific input.
• definition – Optional. Keep only resources with a specific definition.
• tags – Optional. Keep only resources containing specific tags.
• scope – Optional. Keep only resources with a specific scope.
• project_id – Optional. The same as the requester project_id or different if the scope is public.
• created_at – Optional. Keep only resources created at a specific time and date.
• updated_at – Optional. Keep only resources with specific latest update time and date.
• all_projects – Optional. Get resources of all projects.

post(*args, **kwargs)

Create a new workflow.

NOTE: The text is allowed to have definitions

of multiple workflows. In this case they all will be created.

put(*args, **kwargs)

Update one or more workflows.

Parameters:identifier – Optional. If provided, it’s UUID of a workflow. Only one workflow can be updated with identifier param.

The text is allowed to have definitions of multiple workflows. In this case they all will be updated.

Module contents