org.openstack4j.model.senlin.Action Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openstack4j Show documentation
OpenStack Java API
There is a newer version: 3.12
package org.openstack4j.model.senlin;

import org.openstack4j.model.ResourceEntity;

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

/**
 * This interface describes the getter-methods (and thus components) of a Action.
 * All getters map to the possible return values of
 *  GET /v1/actions/{action_id}
 * 
 * @see http://developer.openstack.org/api-ref-clustering-v1.html
 * 
 * @author lion
 * 
 */
public interface Action extends ResourceEntity {

    /**
     * Returns the action name of the action
     *
     * @return the action name of the action
     */
    String getAction();

    /**
     * Returns the context of the action
     *
     * @return the context of the action
     */
    Map getContext();

    /**
     * Returns the action name of the action
     *
     * @return the action name of the action
     */
    Date getUpdatedAt();

    /**
     * Returns the action name of the action
     *
     * @return the action name of the action
     */
    String getCause();

    /**
     * Returns the action name of the action
     *
     * @return the action name of the action
     */
    Date getCreatedAt();

    /**
     * Returns the depended by of the action
     *
     * @return the depended by of the action
     */
    List getDependedBy();

    /**
     * Returns the depends on of the action
     *
     * @return the depends on of the action
     */
    List getDependedOn();

    /**
     * Returns the end time of the action
     *
     * @return the end time of the action
     */
    Float getEndTime();

    /**
     * Returns the inputs of the action
     *
     * @return the inputs of the action
     */
    Map getInputs();

    /**
     * Returns the interval of the action
     *
     * @return the interval of the action
     */
    Integer getInterval();

    /**
     * Returns the outputs of the action
     *
     * @return the outputs of the action
     */
    Map getOutputs();

    /**
     * Returns the owner of the action
     *
     * @return the owner of the action
     */
    String getOwner();

    /**
     * Returns the start time of the action
     *
     * @return the start time of the action
     */
    Float getStartTime();

    /**
     * Returns the status of the action
     *
     * @return the status of the action
     */
    String getStatus();

    /**
     * Returns the status reason of the action
     *
     * @return the status reason of the action
     */
    String getStatusReason();

    /**
     * Returns the target of the action
     *
     * @return the target name of the action
     */
    String getTarget();

    /**
     * Returns the timeout value of the action
     *
     * @return the timeout value of the action
     */
    Integer getTimeout();
}