org.openstack4j.api.workflow

Interface WorkbookDefinitionService

All Superinterfaces:

RestService

All Known Implementing Classes:

WorkbookDefinitionServiceImpl

public interface WorkbookDefinitionService
extends RestService

Service that provides CRUD operations for workbook definitions.

Author:

Renat Akhmerov

Method Summary

Modifier and Type	Method and Description
WorkbookDefinition	create(InputStream wbText, Scope scope) Create a new workbook definition.
ActionResponse	delete(String identifier) Delete workbook definition by its identifier.
WorkbookDefinition	get(String identifier) Get workbook definition by its identifier.
List<? extends WorkbookDefinition>	list() List all workbook definitions with details.

Method Detail

list

List<? extends WorkbookDefinition> list()

List all workbook definitions with details.

Returns:

List of workbook definitions.

create

WorkbookDefinition create(InputStream wbText,
                          Scope scope)

Create a new workbook definition.

Parameters:

wbText - Text in YAML format (Mistral language) with a workbook definition.

scope - Scope of newly created workbook.

Returns:

Created workbook definition.

get

WorkbookDefinition get(String identifier)

Get workbook definition by its identifier.

Parameters:

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

Returns:

Workbook definition.

delete

ActionResponse delete(String identifier)

Delete workbook definition by its identifier.

Parameters:

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

Returns:

Action response from the server.