com.github.narcissujsk.openstackjsk.api.senlin.SenlinReceiverService Maven / Gradle / Ivy
The newest version!
package com.github.narcissujsk.openstackjsk.api.senlin;
import com.github.narcissujsk.openstackjsk.model.common.ActionResponse;
import com.github.narcissujsk.openstackjsk.model.senlin.Receiver;
import com.github.narcissujsk.openstackjsk.model.senlin.ReceiverCreate;
import java.util.List;
/**
* This interface defines all methods for the manipulation of Receiver
*
* @author lion
*
*/
public interface SenlinReceiverService {
/**
* Gets a list of currently existing {@link Receiver}s.
*
* @return the list of {@link Receiver}s
*/
List list();
/**
* POST /v1/receivers
*
* Creates a new {@link Receiver} out of a {@link ReceiverCreate} object
*
* @param newReceiver
* {@link ReceiverCreate} object out of which Receiver is to be created
* @return new {@link Receiver} as returned from the server
*/
Receiver create(ReceiverCreate newReceiver);
/**
* returns details of a {@link Receiver}.
*
* @param receiverID
* Id of {@link Receiver}
* @return
*/
Receiver get(String receiverID);
/**
* Deletes the specified {@link Receiver} from the server.
*
* @param receiverID
* Id of {@link Receiver}
* @return the action response
*/
ActionResponse delete(String receiverID);
}