cloud.timo.TimoCloud.api.objects

Interface ServerGroupObject

All Superinterfaces:

IdentifiableObject

public interface ServerGroupObject
extends IdentifiableObject

Method Summary

Modifier and Type	Method and Description
APIRequestFuture<Void>	delete() Attention: This permanently deletes the server group from the network
BaseObject	getBase() If a base is assigned to the group, this will return its name.
Collection<String>	getJavaParameters()
int	getMaxAmount() The MaxAmount specifies the maximal amount of servers TimoCloud keeps online at the same time - no matter what onlineAmount says
String	getName()
int	getOnlineAmount() The OnlineAmount or Keep-Online-Amount is the amount of servers TimoCloud wants to always be online.
int	getPriority()
int	getRam() Maximum of ram a server of this group may use in megabytes
Collection<ServerObject>	getServers()
Collection<String>	getSortOutStates() If a state of a server is included in the list of sortOut states, TimoCloud does not consider the server as active.
Collection<String>	getSpigotParameters()
boolean	isStatic() If a group is static, servers will not be reset after restart.
APIRequestFuture<Void>	setBase(BaseObject value) Changes the base servers of this group shall be started by
APIRequestFuture<Void>	setJavaParameters(Collection<String> value) Changes the java start parameters
APIRequestFuture<Void>	setMaxAmount(int value) Changes the group's maximum server amount
APIRequestFuture<Void>	setOnlineAmount(int value) Changes the group's maximum player count
APIRequestFuture<Void>	setPriority(int value) Changes the group's priority
APIRequestFuture<Void>	setRam(int value) Changes the group's ram
APIRequestFuture<Void>	setSortOutStates(Collection<String> value) Changes the sort-out states
APIRequestFuture<Void>	setSpigotParameters(Collection<String> value) Changes the spigot start parameters
APIRequestFuture<Void>	setStatic(boolean value) Changes whether the group is static or not.

Methods inherited from interface cloud.timo.TimoCloud.api.objects.IdentifiableObject

getId

Method Detail

getName

String getName()

Specified by:

getName in interface IdentifiableObject

Returns:

The group's name

getServers

Collection<ServerObject> getServers()

Returns:

A list of ServerObject which contains all starting or running servers

getOnlineAmount

int getOnlineAmount()

The OnlineAmount or Keep-Online-Amount is the amount of servers TimoCloud wants to always be online. Called 'onlineAmount' in the groups.yml Attention: This is NOT the amount of online servers, but the minimum amount of servers TimoCloud is keeping online

setOnlineAmount

APIRequestFuture<Void> setOnlineAmount(int value)

Changes the group's maximum player count

Returns:

A future being completed when the value was changed

getMaxAmount

int getMaxAmount()

The MaxAmount specifies the maximal amount of servers TimoCloud keeps online at the same time - no matter what onlineAmount says

setMaxAmount

APIRequestFuture<Void> setMaxAmount(int value)

Changes the group's maximum server amount

Returns:

A future being completed when the value was changed

getRam

int getRam()

Maximum of ram a server of this group may use in megabytes

setRam

APIRequestFuture<Void> setRam(int value)

Changes the group's ram

Returns:

A future being completed when the value was changed

isStatic

boolean isStatic()

If a group is static, servers will not be reset after restart. A static group can only start 1 server.

setStatic

APIRequestFuture<Void> setStatic(boolean value)

Changes whether the group is static or not. Please note that changing this should be done with care. In order to avoid problems, the group should be restarted immediately after doing so. Please note that the template directory is different for static and non-static groups.

Returns:

A future being completed when the value was changed

getPriority

int getPriority()

Returns:

The group's priority. Groups with higher priorities will be started before groups with lower priorities.

setPriority

APIRequestFuture<Void> setPriority(int value)

Changes the group's priority

Returns:

A future being completed when the value was changed

getBase

BaseObject getBase()

If a base is assigned to the group, this will return its name. If the dynamic automatic-base-selection system is used, this will return null.

Returns:

A String if the base has been set statically, else null

setBase

APIRequestFuture<Void> setBase(BaseObject value)

Changes the base servers of this group shall be started by

Parameters:

value - If null, a base will be selected dynamically whenever a new server gets started

Returns:

A future being completed when the value was changed

getSortOutStates

Collection<String> getSortOutStates()

If a state of a server is included in the list of sortOut states, TimoCloud does not consider the server as active. This influences the server starting behavior: When the online amount is 3, for example, TimoCloud will count the group's active servers. If there is just 1 active server, 2 new ones will be started Examples for such states would be STARTING, INGAME, RESTARTING, OFFLINE, ...

setSortOutStates

APIRequestFuture<Void> setSortOutStates(Collection<String> value)

Changes the sort-out states

Returns:

A future being completed when the value was changed

delete

APIRequestFuture<Void> delete()

Attention: This permanently deletes the server group from the network

Returns:

A future being completed when the group was deleted

getJavaParameters

Collection<String> getJavaParameters()

Returns:

A String of all changeable java start parameters

setJavaParameters

APIRequestFuture<Void> setJavaParameters(Collection<String> value)

Changes the java start parameters

Returns:

A future being completed when the parameters was changed

getSpigotParameters

Collection<String> getSpigotParameters()

Returns:

A String of all changeable spigot start parameters

setSpigotParameters

APIRequestFuture<Void> setSpigotParameters(Collection<String> value)

Changes the spigot start parameters

Returns:

A future being completed when the parameters was changed