com.coscale.sdk.client.servers

Class ServersApi

java.lang.Object

com.coscale.sdk.client.servers.ServersApi

public class ServersApi
extends Object

ServersApi is used to make API requests for servers endpoints.

Author:

cristi

Constructor Summary

Constructors

Constructor and Description
ServersApi(ApiClient api) ServersApi constructor.

Method Summary

Methods

Modifier and Type	Method and Description
List<ServerGroup>	addGroupToGroup(long childId, long parentId) Add an existing server group to another server group.
List<Server>	addServerToGroup(long serverId, long groupId) Add an existing server to a server group.
List<Server>	all() Get all servers.
List<Server>	all(Options options) Get all servers.
Msg	delete(long serverId) Delete a specific server.
Msg	deleteGroupFromGroup(long childId, long parentId) Delete a server group from another server group.
Msg	deleteServerFromGroup(long serverId, long groupId) Delete a server from a server group.
Msg	deleteServerGroup(long id) Delete a specific server group.
List<ServerGroup>	getAllServerGroups() Get all server groups.
List<ServerGroup>	getAllServerGroups(Options options) Get all server groups.
List<Server>	getGroupServers(long groupId) * Get all servers in the server group.
List<ServerGroup>	getGroupsFromGroup(long groupId) Get all child server groups for a server group.
Server	getServer(long serverId) Get the a specific server by his id.
Server	getServer(long serverId, Options options) Get the a specific server by his id.
ServerGroup	getServerGroup(long id) Get a specific server group.
Server	insert(ServerInsert serverInsert) Insert a new server.
ServerGroup	insertServerGroup(ServerGroupInsert serverGroup) Insert a new server group.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServersApi

public ServersApi(ApiClient api)

ServersApi constructor.

Parameters:

api - ApiClient.

Method Detail

all

public List<Server> all()
                 throws IOException

Get all servers.

Returns:

List of all Servers.

Throws:

IOException

all

public List<Server> all(Options options)
                 throws IOException

Get all servers.

Parameters:

options - which contain query parameters

Returns:

List of all Servers.

Throws:

IOException

getServer

public Server getServer(long serverId)
                 throws IOException

Get the a specific server by his id.

Parameters:

serverId - the id of the server.

Returns:

Server.

Throws:

IOException

getServer

public Server getServer(long serverId,
               Options options)
                 throws IOException

Get the a specific server by his id.

Parameters:

serverId - the id of the server.

options - which contain query parameters

Returns:

Server.

Throws:

IOException

insert

public Server insert(ServerInsert serverInsert)
              throws IOException

Insert a new server. Optionally set which other server will be its parent.

Parameters:

serverInsert - the server to be added.

Returns:

Server.

Throws:

IOException

delete

public Msg delete(long serverId)
           throws IOException

Delete a specific server.

Parameters:

serverId - the id of the server to be deleted.

Returns:

Msg.

Throws:

IOException

getAllServerGroups

public List<ServerGroup> getAllServerGroups()
                                     throws IOException

Get all server groups.

Returns:

List of all ServerGroups

Throws:

IOException

getAllServerGroups

public List<ServerGroup> getAllServerGroups(Options options)
                                     throws IOException

Get all server groups.

Parameters:

options - filter the ServerGroups. e.g. filter by server name.

Returns:

List of all ServerGroups

Throws:

IOException

getServerGroup

public ServerGroup getServerGroup(long id)
                           throws IOException

Get a specific server group.

Parameters:

id - the id of the server group.

Returns:

ServerGroup

Throws:

IOException

insertServerGroup

public ServerGroup insertServerGroup(ServerGroupInsert serverGroup)
                              throws IOException

Insert a new server group. Optionally set which ServerGroup will be its parent (this is set in ServerGroupInsert object).

Parameters:

serverGroup - the server group to insert.

Returns:

ServerGroup

Throws:

IOException

deleteServerGroup

public Msg deleteServerGroup(long id)
                      throws IOException

Delete a specific server group.

Parameters:

id - the id of the server group.

Returns:

Msg

Throws:

IOException

addGroupToGroup

public List<ServerGroup> addGroupToGroup(long childId,
                                long parentId)
                                  throws IOException

Add an existing server group to another server group.

Parameters:

childId -

parentId -

Returns:

List of groups contained by the parent group.

Throws:

IOException

addServerToGroup

public List<Server> addServerToGroup(long serverId,
                            long groupId)
                              throws IOException

Add an existing server to a server group.

Parameters:

serverId -

groupId -

Returns:

List of Server contained by the group.

Throws:

IOException

getGroupServers

public List<Server> getGroupServers(long groupId)
                             throws IOException

* Get all servers in the server group.

Parameters:

groupId - the id of the server group.

Returns:

List of Server.

Throws:

IOException

deleteServerFromGroup

public Msg deleteServerFromGroup(long serverId,
                        long groupId)
                          throws IOException

Delete a server from a server group.

Parameters:

serverId - the id of the server.

groupId - the id of the group.

Returns:

Msg.

Throws:

IOException

getGroupsFromGroup

public List<ServerGroup> getGroupsFromGroup(long groupId)
                                     throws IOException

Get all child server groups for a server group.

Parameters:

groupId - the if of the group.

Returns:

List of ServerGroup.

Throws:

IOException

deleteGroupFromGroup

public Msg deleteGroupFromGroup(long childId,
                       long parentId)
                         throws IOException

Delete a server group from another server group.

Parameters:

childId - the id of the group that will be removed.

parentId - the id of the group from which the child group will be removed.

Returns:

Msg.

Throws:

IOException