Interface InterfaceService

  • All Superinterfaces:
    RestService
    All Known Implementing Classes:
    InterfaceServiceImpl

    public interface InterfaceService
    extends RestService
    API to Create, list, get details for, and delete port interfaces on a Server Instance
    Author:
    Jeremy Unruh
    • Method Detail

      • create

        InterfaceAttachment create​(String serverId,
                                   String portId)
        Creates and uses a port interface to attach the port to a server instance.
        Parameters:
        serverId - the server id
        portId - the port id to attach
        Returns:
        the attached interface
      • list

        List<? extends InterfaceAttachment> list​(String serverId)
        List the port interfaces for the specified serverId
        Parameters:
        serverId - the server id
        Returns:
        List of interface attachments
      • get

        InterfaceAttachment get​(String serverId,
                                String attachmentId)
        Shows information about a specified port interface
        Parameters:
        serverId - the server id
        attachmentId - the attachment identifier
        Returns:
        the interface attachment
      • detach

        ActionResponse detach​(String serverId,
                              String attachmentId)
        Detaches a specified port interface
        Parameters:
        serverId - the server id
        attachmentId - the attachment identifier
        Returns:
        the action response indicating success or failure