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<Server>	all() Get all servers.
List<Server>	all(Options options) Get all servers.
Msg	delete(long serverId) Delete a specific server.
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.
Server	insert(ServerInsert serverInsert) Insert a new server.

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