org.openstack4j.api.workflow

Interface WorkflowDefinitionService

All Superinterfaces:

RestService

All Known Implementing Classes:

WorkflowDefinitionServiceImpl

public interface WorkflowDefinitionService
extends RestService

Service that provides CRUD operations for workflow definitions.

Author:

Renat Akhmerov

Method Summary

Modifier and Type	Method and Description
List<? extends WorkflowDefinition>	create(InputStream wfText, Scope scope) Create one or more workflow definitions.
ActionResponse	delete(String identifier) Delete workflow definition by its identifier.
WorkflowDefinition	get(String identifier) Get workflow definition by its identifier.
List<? extends WorkflowDefinition>	list() List all workflow definitions with details.

Method Detail

list

List<? extends WorkflowDefinition> list()

List all workflow definitions with details.

Returns:

List of workflow definitions.

create

List<? extends WorkflowDefinition> create(InputStream wfText,
                                          Scope scope)

Create one or more workflow definitions.

Parameters:

wfText - Text in YAML format (Mistral language) with one or more workflow definitions.

scope - Scope of newly created workflows.

Returns:

Created workflow definitions.

get

WorkflowDefinition get(String identifier)

Get workflow definition by its identifier.

Parameters:

identifier - Workflow definition identifier (either ID or name).

Returns:

Workflow definition.

delete

ActionResponse delete(String identifier)

Delete workflow definition by its identifier.

Parameters:

identifier - Workflow definition identifier (either ID or name).

Returns:

Action response from the server.