org.openstack4j.api.murano.v1

Interface MuranoActionService

All Superinterfaces:

RestService

All Known Implementing Classes:

MuranoActionServiceImpl

public interface MuranoActionService
extends RestService

Author:

Nikolay Mahotkin.

Method Summary

Modifier and Type	Method and Description
String	cast(String envId, String actionId) Send signal to run the action and return the taskId
String	cast(String envId, String actionId, Map<String,Object> arguments)
String	cast(String envId, String actionId, String jsonString)
ActionInfo	find(String envId, String actionName) Tries to find action with specific name.
List<? extends ActionInfo>	findAll(String envId, String actionName) Tries to find all actions with given name.
ActionInfo	get(String envId, String actionId) List action in current environment by its ID.
ActionResult	getResult(String envId, String taskId) Gets the result of running action.
List<? extends ActionInfo>	list(String envId)
List<? extends ActionInfo>	list(String envId, String serviceId) List all actions in current environment
ActionResult	run(String envId, String actionId) It is a simple wrapper for a pair: cast() -> getResult() Starts an action and wait for the result.
ActionResult	run(String envId, String actionId, Map<String,Object> arguments)
ActionResult	run(String envId, String actionId, String jsonString)

Method Detail

list

List<? extends ActionInfo> list(String envId,
                                String serviceId)

List all actions in current environment

Parameters:

envId - the environment identifier

serviceId - the service identifier

Returns:

list of actions or null.

list

List<? extends ActionInfo> list(String envId)

get

ActionInfo get(String envId,
               String actionId)

List action in current environment by its ID.

Parameters:

envId - the environment identifier

actionId - the action identifier

Returns:

Action instance or null

find

ActionInfo find(String envId,
                String actionName)

Tries to find action with specific name. Returns the first occurrence of given action name.

Parameters:

envId - the environment identifier

actionName - the name of action

Returns:

Action instance

findAll

List<? extends ActionInfo> findAll(String envId,
                                   String actionName)

Tries to find all actions with given name.

Parameters:

envId - the environment identifier

actionName - the name of action

Returns:

Action list or empty list in case of not found

cast

String cast(String envId,
            String actionId)

Send signal to run the action and return the taskId

Parameters:

envId - environment identifier

actionId - action identifier

Returns:

String with taskId

cast

String cast(String envId,
            String actionId,
            String jsonString)

cast

String cast(String envId,
            String actionId,
            Map<String,Object> arguments)

getResult

ActionResult getResult(String envId,
                       String taskId)

Gets the result of running action.

Parameters:

envId - environment identifier

taskId - task id

Returns:

Action result instance

run

ActionResult run(String envId,
                 String actionId)

It is a simple wrapper for a pair: cast() -> getResult() Starts an action and wait for the result.

Parameters:

envId - environment identifier

actionId - action identifier

Returns:

Action result instance

run

ActionResult run(String envId,
                 String actionId,
                 String jsonString)

run

ActionResult run(String envId,
                 String actionId,
                 Map<String,Object> arguments)