org.openstack4j.api.heat.EventsService 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.api.heat;

import java.util.List;

import org.openstack4j.model.heat.Event;

/**
 * This interface defines all methods for the manipulation of events
 * 
 * @author Octopus Zhang
 * 
 */
public interface EventsService {
	
	/**
	 * Gets a list of currently existing {@link Event}s  for a specified stack.
	 * 
	 * @param stackId  	   The unique identifier for a stack
	 * @param stackName    The name of a stack
	 * @return the list of {@link Event}s
	 */
	List list(String stackName, String stackId);
	
	/**
	 * Gets a list of currently existing {@link Event}s  for a specified stack resource.
	 * 
	 * @param stackId  	   The unique identifier for a stack
	 * @param stackName    The name of a stack
	 * @param resourceName The name of a resource in the stack
	 * @return the list of {@link Event}s
	 */
	List list(String stackName, String stackId, String resourceName);
	
	
	/**
	 * Shows details for a specified event. 
	 * 
	 * @param stackId  	   The unique identifier for a stack
	 * @param stackName    The name of a stack
	 * @param resourceName The name of a resource in the stack
	 * @param eventId      The unique identifier of an event related to the resource in the stack 
	 * @return event details
	 */
	Event show(String stackName, String stackId, String resourceName, String eventId);
}