public interface ServerGroupObject extends IdentifiableObject
Modifier and Type | Method and Description |
---|---|
APIRequestFuture<java.lang.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.
|
java.util.Collection<java.lang.String> |
getJavaParameters() |
int |
getMaxAmount()
The MaxAmount specifies the maximal amount of servers TimoCloud keeps online at the same time - no matter what onlineAmount says
|
java.lang.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
|
java.util.Collection<ServerObject> |
getServers() |
java.util.Collection<java.lang.String> |
getSortOutStates()
If a state of a server is included in the list of sortOut states, TimoCloud does not consider the server as active.
|
java.util.Collection<java.lang.String> |
getSpigotParameters() |
boolean |
isStatic()
If a group is static, servers will not be reset after restart.
|
APIRequestFuture<java.lang.Void> |
setBase(BaseObject value)
Changes the base servers of this group shall be started by
|
APIRequestFuture<java.lang.Void> |
setJavaParameters(java.util.Collection<java.lang.String> value)
Changes the java start parameters
|
APIRequestFuture<java.lang.Void> |
setMaxAmount(int value)
Changes the group's maximum server amount
|
APIRequestFuture<java.lang.Void> |
setOnlineAmount(int value)
Changes the group's maximum player count
|
APIRequestFuture<java.lang.Void> |
setPriority(int value)
Changes the group's priority
|
APIRequestFuture<java.lang.Void> |
setRam(int value)
Changes the group's ram
|
APIRequestFuture<java.lang.Void> |
setSortOutStates(java.util.Collection<java.lang.String> value)
Changes the sort-out states
|
APIRequestFuture<java.lang.Void> |
setSpigotParameters(java.util.Collection<java.lang.String> value)
Changes the spigot start parameters
|
APIRequestFuture<java.lang.Void> |
setStatic(boolean value)
Changes whether the group is static or not.
|
getId
java.lang.String getName()
getName
in interface IdentifiableObject
java.util.Collection<ServerObject> getServers()
ServerObject
which contains all starting or running serversint getOnlineAmount()
APIRequestFuture<java.lang.Void> setOnlineAmount(int value)
int getMaxAmount()
APIRequestFuture<java.lang.Void> setMaxAmount(int value)
int getRam()
APIRequestFuture<java.lang.Void> setRam(int value)
boolean isStatic()
APIRequestFuture<java.lang.Void> setStatic(boolean value)
int getPriority()
APIRequestFuture<java.lang.Void> setPriority(int value)
BaseObject getBase()
APIRequestFuture<java.lang.Void> setBase(BaseObject value)
value
- If null, a base will be selected dynamically whenever a new server gets startedjava.util.Collection<java.lang.String> getSortOutStates()
APIRequestFuture<java.lang.Void> setSortOutStates(java.util.Collection<java.lang.String> value)
APIRequestFuture<java.lang.Void> delete()
java.util.Collection<java.lang.String> getJavaParameters()
APIRequestFuture<java.lang.Void> setJavaParameters(java.util.Collection<java.lang.String> value)
java.util.Collection<java.lang.String> getSpigotParameters()
APIRequestFuture<java.lang.Void> setSpigotParameters(java.util.Collection<java.lang.String> value)