Package org.openstack4j.api.senlin

Interface SenlinNodeService

  • All Known Implementing Classes:
    SenlinNodeServiceImpl
    public interface SenlinNodeService
    This interface defines all methods for the manipulation of Node
    Author:
    lion

    • Method Detail

      • list

        List<? extends Node> list()
        Gets a list of currently existing Nodes.
        Returns:
        the list of Nodes

      • create

        Node create​(NodeCreate newNode)
        POST /v1/nodes

        Creates a new Node out of a NodeCreate object

        Parameters:
        newNode - NodeCreate object out of which node is to be created
        Returns:
        new Node as returned from the server

      • get

        Node get​(String nodeID)
        returns details of a Node.
        Parameters:
        nodeID - Id of Node
        Returns:
        Node

      • get

        Node get​(String nodeID,
         boolean showDetails)
        returns details of a Node
        Parameters:
        nodeID - Id of Node
        showDetails - true to retrieve the properties about the physical object that backs the node
        Returns:
        Node

      • delete

        ActionResponse delete​(String nodeID)
        Deletes the specified Node from the server.
        Parameters:
        nodeID - Id of Node
        Returns:
        the action response

      • update

        Node update​(String nodeID,
            NodeCreate newNode)
        PATCH /v1/nodes/​{node_id}​

        Update a Node out of a NodeCreate object

        Parameters:
        nodeID - Id of Node
        newNode - NodeCreate object out of which stack is to be update
        Returns:
        new Node as returned from the server

      • action

        ActionID action​(String nodeID,
                NodeActionCreate newNodeAction)
        Service implementation which provides methods for manipulation of action
        Returns:
        Action