cloud.timo.TimoCloud.api.objects

Interface ProxyGroupObject

All Superinterfaces:

IdentifiableObject

public interface ProxyGroupObject
extends IdentifiableObject

Method Summary

Modifier and Type	Method and Description
APIRequestFuture<java.lang.Void>	delete() Attention: This permanently deletes the proxy group from the network
BaseObject	getBase()
java.util.Collection<java.lang.String>	getHostNames() If using multiple proxies and TimoCloudCord, the hostnames specify which hostnames belong to this proxy group
java.util.Collection<java.lang.String>	getJavaParameters()
int	getKeepFreeSlots()
int	getMaxAmount()
int	getMaxPlayerCount()
int	getMaxPlayerCountPerProxy()
int	getMinAmount()
java.lang.String	getMotd()
java.lang.String	getName()
int	getOnlinePlayerCount()
int	getPriority()
java.util.Collection<ProxyObject>	getProxies()
ProxyChooseStrategy	getProxyChooseStrategy() The ProxyChooseStrategy tells TimoCloudCord what proxy it should choose when a player wants to join a proxy group
int	getRam()
java.util.Collection<ServerGroupObject>	getServerGroups()
boolean	isStatic() If a group is static, servers will not be reset after restart.
APIRequestFuture<java.lang.Void>	setBase(BaseObject value) Changes the base proxies of this group shall be started by
APIRequestFuture<java.lang.Void>	setHostNames(java.util.Collection<java.lang.String> value) Changes the group's hostnames
APIRequestFuture<java.lang.Void>	setJavaParameters(java.util.Collection<java.lang.String> value) Changes the java start parameters
APIRequestFuture<java.lang.Void>	setKeepFreeSlots(int value) Changes the group's amount of slots which should be kept free
APIRequestFuture<java.lang.Void>	setMaxAmount(int value) Changes the group's maximum instance amount
APIRequestFuture<java.lang.Void>	setMaxPlayerCount(int value) Changes the group's maximum player count
APIRequestFuture<java.lang.Void>	setMaxPlayerCountPerProxy(int value) Changes the group's maximum player count per proxy
APIRequestFuture<java.lang.Void>	setMinAmount(int value) Changes the group's minimum instance amount
APIRequestFuture<java.lang.Void>	setMotd(java.lang.String value) Changes the group's motd
APIRequestFuture<java.lang.Void>	setPriority(int value) Changes the group's priority
APIRequestFuture<java.lang.Void>	setProxyChooseStrategy(ProxyChooseStrategy value) Changes the group's proxy choose strategy
APIRequestFuture<java.lang.Void>	setRam(int value) Changes the group's ram
APIRequestFuture<java.lang.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

java.lang.String getName()

Specified by:

getName in interface IdentifiableObject

Returns:

The group's name

getProxies

java.util.Collection<ProxyObject> getProxies()

Returns:

All starting/running proxies of the group

getOnlinePlayerCount

int getOnlinePlayerCount()

Returns:

The total amount of players online on all proxies of this group

getMaxPlayerCount

int getMaxPlayerCount()

Returns:

The total maximum amount of players who can be online on proxies of this group

setMaxPlayerCount

APIRequestFuture<java.lang.Void> setMaxPlayerCount(int value)

Changes the group's maximum player count

Returns:

A future being completed when the value was changed

getMaxPlayerCountPerProxy

int getMaxPlayerCountPerProxy()

Returns:

The maximum player amount who can be online on one cord

setMaxPlayerCountPerProxy

APIRequestFuture<java.lang.Void> setMaxPlayerCountPerProxy(int value)

Changes the group's maximum player count per proxy

Returns:

A future being completed when the value was changed

getKeepFreeSlots

int getKeepFreeSlots()

Returns:

The amount of player slots TimoCloud will keep free. If there are not enough free slots, a new proxy will be started.

setKeepFreeSlots

APIRequestFuture<java.lang.Void> setKeepFreeSlots(int value)

Changes the group's amount of slots which should be kept free

Returns:

A future being completed when the value was changed

getMinAmount

int getMinAmount()

Returns:

The minimum amount of proxies of this group that will be online

setMinAmount

APIRequestFuture<java.lang.Void> setMinAmount(int value)

Changes the group's minimum instance amount

Returns:

A future being completed when the value was changed

getMaxAmount

int getMaxAmount()

Returns:

The maximum amount of proxies of this group that may be online

setMaxAmount

APIRequestFuture<java.lang.Void> setMaxAmount(int value)

Changes the group's maximum instance amount

Returns:

A future being completed when the value was changed

getRam

int getRam()

Returns:

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

setRam

APIRequestFuture<java.lang.Void> setRam(int value)

Changes the group's ram

Parameters:

value - The maximum amount of ram a proxy of this group may use

Returns:

A future being completed when the value was changed

getMotd

java.lang.String getMotd()

Returns:

The proxies' motd

setMotd

APIRequestFuture<java.lang.Void> setMotd(java.lang.String value)

Changes the group's motd

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<java.lang.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<java.lang.Void> setPriority(int value)

Changes the group's priority

Returns:

A future being completed when the value was changed

getServerGroups

java.util.Collection<ServerGroupObject> getServerGroups()

Returns:

The server groups connections to which are proxied by this BungeeCord instance.

getBase

BaseObject getBase()

Returns:

The base proxies of this group will be started by. If you let TimoCloud choose a base dynamically, this will return null!

setBase

APIRequestFuture<java.lang.Void> setBase(BaseObject value)

Changes the base proxies of this group shall be started by

Parameters:

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

Returns:

A future being completed when the value was changed

getProxyChooseStrategy

ProxyChooseStrategy getProxyChooseStrategy()

The ProxyChooseStrategy tells TimoCloudCord what proxy it should choose when a player wants to join a proxy group

Returns:

BALANCE, FILL or RANDOM

setProxyChooseStrategy

APIRequestFuture<java.lang.Void> setProxyChooseStrategy(ProxyChooseStrategy value)

Changes the group's proxy choose strategy

Returns:

A future being completed when the value was changed

getHostNames

java.util.Collection<java.lang.String> getHostNames()

If using multiple proxies and TimoCloudCord, the hostnames specify which hostnames belong to this proxy group

setHostNames

APIRequestFuture<java.lang.Void> setHostNames(java.util.Collection<java.lang.String> value)

Changes the group's hostnames

Returns:

A future being completed when the value was changed

delete

APIRequestFuture<java.lang.Void> delete()

Attention: This permanently deletes the proxy group from the network

Returns:

A future being completed when the group was deleted

getJavaParameters

java.util.Collection<java.lang.String> getJavaParameters()

Returns:

A String of all changeable java start parameters

setJavaParameters

APIRequestFuture<java.lang.Void> setJavaParameters(java.util.Collection<java.lang.String> value)

Changes the java start parameters

Returns:

A future being completed when the parameters was changed