org.openstack4j.model.heat.builder.SoftwareConfigBuilder Maven / Gradle / Ivy

package org.openstack4j.model.heat.builder;

import java.util.Map;

import org.openstack4j.common.Buildable;
import org.openstack4j.model.heat.SoftwareConfig;

/**
 * A builder which produces a SoftwareConfig object
 * 
 * @author Jeremy Unruh
 */
public interface SoftwareConfigBuilder extends Buildable.Builder {

    /**
     * The name of this configuration
     * 
     * @param name the config name
     * @return SoftwareConfigBuilder
     */
    SoftwareConfigBuilder name(String name);

    /**
     * Namespace that groups this software configuration by when it is delivered to a server. 
     * This setting might imply which configuration tool performs the configuration.
     * 
     * @param group the group namespace
     * @return SoftwareConfigBuilder
     */
    SoftwareConfigBuilder group(String group);

    /**
     * Adds an input that this software configuration expects
     * 
     * @param name the input name
     * @return SoftwareConfigBuilder
     */
    SoftwareConfigBuilder input(String name);

    /**
     * Adds an input that this software configuration expects
     * 
     * @param name the input name
     * @param type the input type (ex. String)
     * @return SoftwareConfigBuilder
     */
    SoftwareConfigBuilder input(String name, String type);

    /**
     * Adds an input that this software configuration expects
     * 
     * @param name the input name
     * @param type the input type (ex. String)
     * @param description a description about this input
     * @param defaultValue the initial value
     * @return SoftwareConfigBuilder
     */
    SoftwareConfigBuilder input(String name, String type, String description, String defaultValue);

    /**
     * Adds an output this software configuration produces
     * 
     * @param name the name of the output
     * @return SoftwareConfigBuilder
     */
    SoftwareConfigBuilder output(String name);

    /**
     * Adds an output this software configuration produces
     * 
     * @param name the name of the output
     * @param type the output type (ex. String)
     * @return SoftwareConfigBuilder
     */
    SoftwareConfigBuilder output(String name, String type);

    /**
     * Adds an output this software configuration produces
     * 
     * @param name the name of the output
     * @param type the output type (ex. String)
     * @param description the description of this output
     * @param isErrorOutput true if this is an error related output
     * @return SoftwareConfigBuilder
     */
    SoftwareConfigBuilder output(String name, String type, String description, boolean isErrorOutput);

    /**
     * Adds a map containing options specific to the configuration management tool used by this resource
     * 
     * @param options map of options
     * @return SoftwareConfigBuilder
     */
    SoftwareConfigBuilder options(Map options);

    /**
     * Configuration script or manifest that defines which configuration is performed
     * 
     * @param config the configuration script or manifest to add
     * @return SoftwareConfigBuilder
     */
    SoftwareConfigBuilder config(String config);

}