com.huawei.openstack4j.model.heat.builder.StackCreateBuilder 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.model.heat.builder;

import java.util.Map;

import com.huawei.openstack4j.common.Buildable;
import com.huawei.openstack4j.model.heat.StackCreate;

/**
 * This interface describes a builder for {@link StackCreate} objects
 *
 * @author Matthias Reisser
 */
public interface StackCreateBuilder extends Buildable.Builder {

    StackCreateBuilder name(String name);

    /**
     * Sets the template in YAML/JSON format.  If the template begins with a "{" then JSON is assumed
     *
     * @param template the template
     * @return StackCreateBuilder
     */
    StackCreateBuilder template(String template);

    /**
     * Sets the template URL
     *
     * @param templateURL the template URL
     * @return StackCreateBuilder
     */
    StackCreateBuilder templateURL(String templateURL);

    /**
     * Sets the parameters which are passed to the server. It might contain Information about flavor, image, etc.
     *
     * @param parameters Map of parameters. Key is name, value is the value of the parameters
     * @return the modified StackCreateBuilder
     */
    StackCreateBuilder parameters(Map parameters);

    /**
     * Sets the stack creation timeout in minutes
     *
     * @param timeoutMins timeout in minutes
     * @return the modified StackCreateBuilder
     */
    StackCreateBuilder timeoutMins(Long timeoutMins);

    /**
     * sets the boolean for whether or not rollback is enabled or not
     *
     * @param disableRollback boolean value for disabling rollback
     * @return the modified StackCreateBuilder
     */
    StackCreateBuilder disableRollback(boolean disableRollback);

    /**
     * Sets the environment in YAML/JSON format.
     *
     * @param environment the environment
     * @return StackCreateBuilder
     */
    StackCreateBuilder environment(String environment);

    /**
     * Sets the environment in YAML/JSON format.
     *
     * @param environment file location
     * @return StackCreateBuilder
     */
    StackCreateBuilder environmentFromFile(String envFile);

    /**
     * Sets the template in YAML/JSON format.
     *
     * @param tplFile file location
     * @return StackCreateBuilder
     */
    StackCreateBuilder templateFromFile(String tplFile);

    /**
     * Sets the files parameter
     *
     * @param files map
     * @return StackCreateBuilder
     */
    StackCreateBuilder files(Map files);

    /**
     * Set the tags for the stack, separated by a comma.
     *
     * @param tags
     * @return StackCreateBuilder
     */
    StackCreateBuilder tags(String tags);

}