ProxyGroupObject (TimoCloud-API 6.7.9 API)

All Superinterfaces:: IdentifiableObject

public interface ProxyGroupObject
extends IdentifiableObject

Method Summary

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

Interface ProxyGroupObject

Method Summary

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

Method Detail

getName

getProxies

getOnlinePlayerCount

getMaxPlayerCount

setMaxPlayerCount

getMaxPlayerCountPerProxy

setMaxPlayerCountPerProxy

getKeepFreeSlots

setKeepFreeSlots

getMinAmount

setMinAmount

getMaxAmount

setMaxAmount

getRam

setRam

getMotd

setMotd

isStatic

setStatic

getPriority

setPriority

getServerGroups

getBase

setBase

getProxyChooseStrategy

setProxyChooseStrategy

getHostNames

setHostNames

delete

getJavaParameters

setJavaParameters

getJrePath