com.huawei.openstack4j.api.murano.v1.MuranoActionService Maven / Gradle / Ivy

/*******************************************************************************
 * 	Copyright 2016 ContainX and OpenStack4j                                          
 * 	                                                                                 
 * 	Licensed under the Apache License, Version 2.0 (the "License"); you may not      
 * 	use this file except in compliance with the License. You may obtain a copy of    
 * 	the License at                                                                   
 * 	                                                                                 
 * 	    http://www.apache.org/licenses/LICENSE-2.0                                   
 * 	                                                                                 
 * 	Unless required by applicable law or agreed to in writing, software              
 * 	distributed under the License is distributed on an "AS IS" BASIS, WITHOUT        
 * 	WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the         
 * 	License for the specific language governing permissions and limitations under    
 * 	the License.                                                                     
 *******************************************************************************/
package com.huawei.openstack4j.api.murano.v1;

import java.util.List;
import java.util.Map;

import com.huawei.openstack4j.common.RestService;
import com.huawei.openstack4j.model.murano.v1.domain.ActionInfo;
import com.huawei.openstack4j.model.murano.v1.domain.ActionResult;

/**
 * @author Nikolay Mahotkin.
 */
public interface MuranoActionService extends RestService {
    /**
     * List all actions in current environment
     *
     * @param envId the environment identifier
     * @param serviceId the service identifier
     * @return list of actions or null.
     */
    List list(String envId, String serviceId);
    List list(String envId);

    /**
     * List action in current environment by its ID.
     *
     * @param envId the environment identifier
     * @param actionId the action identifier
     * @return Action instance or null
     */
    ActionInfo get(String envId, String actionId);

    /**
     * Tries to find action with specific name.
     * Returns the first occurrence of given action name.
     *
     * @param envId the environment identifier
     * @param actionName the name of action
     * @return Action instance
     */
    ActionInfo find(String envId, String actionName);

    /**
     * Tries to find all actions with given name.
     *
     * @param envId the environment identifier
     * @param actionName the name of action
     * @return Action list or empty list in case of not found
     */
    List findAll(String envId, String actionName);

    /**
     * Send signal to run the action and return the taskId
     *
     * @param envId environment identifier
     * @param actionId action identifier
     * @return String with taskId
     */
    String cast(String envId, String actionId);
    String cast(String envId, String actionId, String jsonString);
    String cast(String envId, String actionId, Map arguments);

    /**
     * Gets the result of running action.
     *
     * @param envId environment identifier
     * @param taskId task id
     * @return Action result instance
     */
    ActionResult getResult(String envId, String taskId);

    /**
     * It is a simple wrapper for a pair:
     * cast() -> getResult()
     * Starts an action and wait for the result.
     *
     * @param envId environment identifier
     * @param actionId action identifier
     * @return Action result instance
     */
    ActionResult run(String envId, String actionId);
    ActionResult run(String envId, String actionId, String jsonString);
    ActionResult run(String envId, String actionId, Map arguments);
}