Index
All Classes and Interfaces|All Packages|Serialized Form
A
- acceptJoins(boolean) - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
Opens or closes this server's own door.
- age() - Method in record class cloud.spawnery.agent.api.InstanceStatus
-
Returns the value of the
agerecord component. - alreadyRunning() - Method in record class cloud.spawnery.agent.api.StartedServer
-
Returns the value of the
alreadyRunningrecord component. - alreadyThere() - Method in record class cloud.spawnery.agent.api.ConnectResult
-
Returns the value of the
alreadyThererecord component. - announce(String, Map<String, String>) - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
Publishes what this server is doing, for every other server to read.
- api() - Static method in class cloud.spawnery.agent.api.Spawnery
-
The API this server's agent installed.
- arrivedByTransfer(UUID) - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
Whether this player's connection to this proxy is a transfer from another proxy of the network, carrying a cookie this agent verified.
- attributes() - Method in record class cloud.spawnery.agent.api.Group
-
Returns the value of the
attributesrecord component. - attributes() - Method in record class cloud.spawnery.agent.api.ServerInfo
-
Returns the value of the
attributesrecord component.
B
- boost(String, int, Duration) - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
Deprecated.
- BoostResult - Record Class in cloud.spawnery.agent.api
-
The extra capacity a
SpawneryApi.boost(java.lang.String, int, java.time.Duration)call created. - BoostResult(int, Instant) - Constructor for record class cloud.spawnery.agent.api.BoostResult
-
Creates an instance of a
BoostResultrecord class. - build() - Method in class cloud.spawnery.agent.api.StartOptions.Builder
- builder() - Static method in class cloud.spawnery.agent.api.StartOptions
C
- close() - Method in interface cloud.spawnery.agent.api.ReadinessHold
- cloud.spawnery.agent.api - package cloud.spawnery.agent.api
- CloudEventInfo - Record Class in cloud.spawnery.agent.api
-
One thing that happened in the cloud.
- CloudEventInfo(String, String, String, String, boolean) - Constructor for record class cloud.spawnery.agent.api.CloudEventInfo
-
Creates an instance of a
CloudEventInforecord class. - CloudPlayer - Record Class in cloud.spawnery.agent.api
-
A player, and which backend they are on.
- CloudPlayer(UUID, String, Optional<String>) - Constructor for record class cloud.spawnery.agent.api.CloudPlayer
-
Creates an instance of a
CloudPlayerrecord class. - complete() - Method in record class cloud.spawnery.agent.api.ResourceUsage
-
Whether every pod in the set was measured.
- connect(UUID, Target) - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
Asks the operator to move a player.
- ConnectResult - Record Class in cloud.spawnery.agent.api
-
What the operator did with a
SpawneryApi.connect(java.util.UUID, cloud.spawnery.agent.api.Target)call. - ConnectResult(boolean, boolean, String) - Constructor for record class cloud.spawnery.agent.api.ConnectResult
-
Creates an instance of a
ConnectResultrecord class. - cpuLimit() - Method in record class cloud.spawnery.agent.api.ServerResources
-
Returns the value of the
cpuLimitrecord component. - cpuLimit(String) - Method in class cloud.spawnery.agent.api.StartOptions.Builder
-
The CPU limit of the server's pod.
- cpuLimitMillicores() - Method in record class cloud.spawnery.agent.api.ResourceUsage
-
Returns the value of the
cpuLimitMillicoresrecord component. - cpuRequest() - Method in record class cloud.spawnery.agent.api.ServerResources
-
Returns the value of the
cpuRequestrecord component. - cpuRequest(String) - Method in class cloud.spawnery.agent.api.StartOptions.Builder
-
The CPU the server's pod requests.
- cpuRequestedMillicores() - Method in record class cloud.spawnery.agent.api.ResourceUsage
-
Returns the value of the
cpuRequestedMillicoresrecord component. - cpuUnlimited() - Method in record class cloud.spawnery.agent.api.ResourceUsage
-
Returns the value of the
cpuUnlimitedrecord component. - cpuUsedMillicores() - Method in record class cloud.spawnery.agent.api.ResourceUsage
-
Returns the value of the
cpuUsedMillicoresrecord component. - current() - Method in record class cloud.spawnery.agent.api.RestorePoint
-
Returns the value of the
currentrecord component.
D
- deleteServer(String, String) - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
Deletes one private server for good: stops it if it is running, as
SpawneryApi.stopServer(java.lang.String)does, and deletes its world. - displayName() - Method in record class cloud.spawnery.agent.api.Group
-
Returns the value of the
displayNamerecord component. - draining() - Method in record class cloud.spawnery.agent.api.InstanceStatus
-
Returns the value of the
drainingrecord component. - draining() - Method in record class cloud.spawnery.agent.api.ProxyInfo
-
Returns the value of the
drainingrecord component. - DRAINING - Enum constant in enum class cloud.spawnery.agent.api.ServerPhase
E
- endRound() - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
Says this server's round is over.
- EPHEMERAL - Enum constant in enum class cloud.spawnery.agent.api.Group.Kind
-
Sized by free player slots; servers are interchangeable.
- equals(Object) - Method in record class cloud.spawnery.agent.api.BoostResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class cloud.spawnery.agent.api.CloudEventInfo
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class cloud.spawnery.agent.api.CloudPlayer
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class cloud.spawnery.agent.api.ConnectResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class cloud.spawnery.agent.api.Group
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class cloud.spawnery.agent.api.GroupStatus
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class cloud.spawnery.agent.api.InstanceStatus
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class cloud.spawnery.agent.api.NetworkStatus
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class cloud.spawnery.agent.api.ProxyInfo
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class cloud.spawnery.agent.api.ResourceUsage
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class cloud.spawnery.agent.api.RestoredWorld
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class cloud.spawnery.agent.api.RestorePoint
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class cloud.spawnery.agent.api.RestorePoints
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class cloud.spawnery.agent.api.ScaleResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class cloud.spawnery.agent.api.ServerInfo
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class cloud.spawnery.agent.api.ServerResources
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class cloud.spawnery.agent.api.StartedServer
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class cloud.spawnery.agent.api.Target.Group
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class cloud.spawnery.agent.api.Target.Server
-
Indicates whether some other object is "equal to" this one.
- EventBus - Interface in cloud.spawnery.agent.api
-
Where a plugin hears about things happening in the cloud.
- events() - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
Where to hear about things happening in the cloud.
- expiresAt() - Method in record class cloud.spawnery.agent.api.BoostResult
-
Returns the value of the
expiresAtrecord component. - expiresAt() - Method in record class cloud.spawnery.agent.api.ScaleResult
-
Returns the value of the
expiresAtrecord component.
F
- FAILED - Enum constant in enum class cloud.spawnery.agent.api.ServerPhase
- FINISHED - Enum constant in enum class cloud.spawnery.agent.api.ServerPhase
-
The round is over: the server said so with
SpawneryApi.endRound()and its pod then stopped. - freeSlots() - Method in record class cloud.spawnery.agent.api.Group
-
Returns the value of the
freeSlotsrecord component. - freeSlots() - Method in record class cloud.spawnery.agent.api.ServerInfo
-
How many more players this server would accept, never negative: a report can show more players than slots while a lowered
maxPlayersreaches the running pods. - fromWire(String) - Static method in enum class cloud.spawnery.agent.api.ServerPhase
-
Maps the operator's spelling onto this enum, never throwing.
G
- generation() - Method in record class cloud.spawnery.agent.api.RestoredWorld
-
Returns the value of the
generationrecord component. - generation() - Method in record class cloud.spawnery.agent.api.RestorePoint
-
Returns the value of the
generationrecord component. - group() - Method in record class cloud.spawnery.agent.api.CloudEventInfo
-
Returns the value of the
grouprecord component. - group() - Method in record class cloud.spawnery.agent.api.InstanceStatus
-
Returns the value of the
grouprecord component. - group() - Method in record class cloud.spawnery.agent.api.ProxyInfo
-
Returns the value of the
grouprecord component. - group() - Method in interface cloud.spawnery.agent.api.Self
-
The
ServerGrouporProxyGroupthis belongs to. - group() - Method in record class cloud.spawnery.agent.api.ServerInfo
-
Returns the value of the
grouprecord component. - group(String) - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
One group by name, empty if this network has none.
- group(String) - Static method in interface cloud.spawnery.agent.api.Target
-
Wherever that group has the most room, chosen by the operator.
- Group - Record Class in cloud.spawnery.agent.api
-
A group of servers, as the operator last described it.
- Group(String) - Constructor for record class cloud.spawnery.agent.api.Target.Group
-
Creates an instance of a
Grouprecord class. - Group(String, Group.Kind, int, int, int, int, Map<String, String>, String) - Constructor for record class cloud.spawnery.agent.api.Group
-
The 0.18 shape: no pin.
- Group(String, Group.Kind, int, int, int, int, Map<String, String>, String, boolean, int, Instant) - Constructor for record class cloud.spawnery.agent.api.Group
-
Creates an instance of a
Grouprecord class. - Group.Kind - Enum Class in cloud.spawnery.agent.api
-
Which sizing rule this group answers to.
- groups() - Method in record class cloud.spawnery.agent.api.NetworkStatus
-
Returns the value of the
groupsrecord component. - groups() - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
Every group in this network, in no particular order.
- GroupStatus - Record Class in cloud.spawnery.agent.api
-
One group in a
NetworkStatus. - GroupStatus(String, Group.Kind, String, int, int, int, OptionalDouble, ResourceUsage) - Constructor for record class cloud.spawnery.agent.api.GroupStatus
-
Creates an instance of a
GroupStatusrecord class.
H
- hashCode() - Method in record class cloud.spawnery.agent.api.BoostResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class cloud.spawnery.agent.api.CloudEventInfo
-
Returns a hash code value for this object.
- hashCode() - Method in record class cloud.spawnery.agent.api.CloudPlayer
-
Returns a hash code value for this object.
- hashCode() - Method in record class cloud.spawnery.agent.api.ConnectResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class cloud.spawnery.agent.api.Group
-
Returns a hash code value for this object.
- hashCode() - Method in record class cloud.spawnery.agent.api.GroupStatus
-
Returns a hash code value for this object.
- hashCode() - Method in record class cloud.spawnery.agent.api.InstanceStatus
-
Returns a hash code value for this object.
- hashCode() - Method in record class cloud.spawnery.agent.api.NetworkStatus
-
Returns a hash code value for this object.
- hashCode() - Method in record class cloud.spawnery.agent.api.ProxyInfo
-
Returns a hash code value for this object.
- hashCode() - Method in record class cloud.spawnery.agent.api.ResourceUsage
-
Returns a hash code value for this object.
- hashCode() - Method in record class cloud.spawnery.agent.api.RestoredWorld
-
Returns a hash code value for this object.
- hashCode() - Method in record class cloud.spawnery.agent.api.RestorePoint
-
Returns a hash code value for this object.
- hashCode() - Method in record class cloud.spawnery.agent.api.RestorePoints
-
Returns a hash code value for this object.
- hashCode() - Method in record class cloud.spawnery.agent.api.ScaleResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class cloud.spawnery.agent.api.ServerInfo
-
Returns a hash code value for this object.
- hashCode() - Method in record class cloud.spawnery.agent.api.ServerResources
-
Returns a hash code value for this object.
- hashCode() - Method in record class cloud.spawnery.agent.api.StartedServer
-
Returns a hash code value for this object.
- hashCode() - Method in record class cloud.spawnery.agent.api.Target.Group
-
Returns a hash code value for this object.
- hashCode() - Method in record class cloud.spawnery.agent.api.Target.Server
-
Returns a hash code value for this object.
- heap() - Method in record class cloud.spawnery.agent.api.ServerResources
-
Returns the value of the
heaprecord component. - heap(String) - Method in class cloud.spawnery.agent.api.StartOptions.Builder
-
The JVM's maximum heap.
- held() - Method in record class cloud.spawnery.agent.api.InstanceStatus
-
Returns the value of the
heldrecord component. - held() - Method in record class cloud.spawnery.agent.api.ServerInfo
-
Returns the value of the
heldrecord component. - holdReadiness(String) - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
Holds this server back from readiness until the returned hold is closed.
I
- id() - Method in record class cloud.spawnery.agent.api.CloudPlayer
-
Returns the value of the
idrecord component. - incarnation() - Method in record class cloud.spawnery.agent.api.ServerInfo
-
Returns the value of the
incarnationrecord component. - install(SpawneryApi) - Static method in class cloud.spawnery.agent.api.Spawnery
-
Installs the implementation.
- instances() - Method in record class cloud.spawnery.agent.api.NetworkStatus
-
Returns the value of the
instancesrecord component. - InstanceStatus - Record Class in cloud.spawnery.agent.api
-
One server or proxy in a
NetworkStatus. - InstanceStatus(String, String, boolean, String, boolean, int, int, OptionalDouble, OptionalDouble, Duration, boolean, boolean, boolean, ResourceUsage) - Constructor for record class cloud.spawnery.agent.api.InstanceStatus
-
The record as it was before
node, which it reads as not scheduled. - InstanceStatus(String, String, boolean, String, boolean, int, int, OptionalDouble, OptionalDouble, Duration, boolean, boolean, boolean, ResourceUsage, String) - Constructor for record class cloud.spawnery.agent.api.InstanceStatus
-
The record as it was before
playableSlots, which it reads as every seat. - InstanceStatus(String, String, boolean, String, boolean, int, int, OptionalDouble, OptionalDouble, Duration, boolean, boolean, boolean, ResourceUsage, String, int) - Constructor for record class cloud.spawnery.agent.api.InstanceStatus
-
Creates an instance of a
InstanceStatusrecord class. - isAvailable() - Static method in class cloud.spawnery.agent.api.Spawnery
-
Whether
Spawnery.api()would return rather than throw.
K
- kind() - Method in record class cloud.spawnery.agent.api.CloudEventInfo
-
Returns the value of the
kindrecord component. - kind() - Method in record class cloud.spawnery.agent.api.Group
-
Returns the value of the
kindrecord component. - kind() - Method in record class cloud.spawnery.agent.api.GroupStatus
-
Returns the value of the
kindrecord component.
L
- leavingByTransfer(UUID) - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
Whether this proxy has sent this player to another proxy of the network, because this proxy is leaving.
- listRestorePoints(String, String) - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
The points of
SpawneryApi.restorePoints(java.lang.String, java.lang.String), without whether the world is settling. - lowestTps() - Method in record class cloud.spawnery.agent.api.GroupStatus
-
Returns the value of the
lowestTpsrecord component.
M
- measured() - Method in record class cloud.spawnery.agent.api.ResourceUsage
-
Whether any pod in the set was measured.
- memoryLimit() - Method in record class cloud.spawnery.agent.api.ServerResources
-
Returns the value of the
memoryLimitrecord component. - memoryLimit(String) - Method in class cloud.spawnery.agent.api.StartOptions.Builder
-
The memory limit of the server's pod.
- memoryLimitBytes() - Method in record class cloud.spawnery.agent.api.ResourceUsage
-
Returns the value of the
memoryLimitBytesrecord component. - memoryRequest() - Method in record class cloud.spawnery.agent.api.ServerResources
-
Returns the value of the
memoryRequestrecord component. - memoryRequest(String) - Method in class cloud.spawnery.agent.api.StartOptions.Builder
-
The memory the server's pod requests.
- memoryRequestedBytes() - Method in record class cloud.spawnery.agent.api.ResourceUsage
-
Returns the value of the
memoryRequestedBytesrecord component. - memoryUnlimited() - Method in record class cloud.spawnery.agent.api.ResourceUsage
-
Returns the value of the
memoryUnlimitedrecord component. - memoryUsedBytes() - Method in record class cloud.spawnery.agent.api.ResourceUsage
-
Returns the value of the
memoryUsedBytesrecord component. - message() - Method in record class cloud.spawnery.agent.api.CloudEventInfo
-
Returns the value of the
messagerecord component. - metricsAvailable() - Method in record class cloud.spawnery.agent.api.NetworkStatus
-
Returns the value of the
metricsAvailablerecord component. - mspt() - Method in record class cloud.spawnery.agent.api.InstanceStatus
-
Returns the value of the
msptrecord component.
N
- name() - Method in record class cloud.spawnery.agent.api.CloudPlayer
-
Returns the value of the
namerecord component. - name() - Method in record class cloud.spawnery.agent.api.Group
-
Returns the value of the
namerecord component. - name() - Method in record class cloud.spawnery.agent.api.GroupStatus
-
Returns the value of the
namerecord component. - name() - Method in record class cloud.spawnery.agent.api.InstanceStatus
-
Returns the value of the
namerecord component. - name() - Method in record class cloud.spawnery.agent.api.ProxyInfo
-
Returns the value of the
namerecord component. - name() - Method in interface cloud.spawnery.agent.api.Self
-
The name of this pod's own
Serveror proxy pod. - name() - Method in record class cloud.spawnery.agent.api.ServerInfo
-
Returns the value of the
namerecord component. - name() - Method in record class cloud.spawnery.agent.api.StartedServer
-
Returns the value of the
namerecord component. - name() - Method in record class cloud.spawnery.agent.api.Target.Group
-
Returns the value of the
namerecord component. - name() - Method in record class cloud.spawnery.agent.api.Target.Server
-
Returns the value of the
namerecord component. - network() - Method in interface cloud.spawnery.agent.api.Self
-
The
Networkthis belongs to, which is also the boundary of everything this API can see. - NetworkStatus - Record Class in cloud.spawnery.agent.api
-
The answer to
SpawneryApi.status(): this network's usage and tick rates, never anything outside its namespace. - NetworkStatus(ResourceUsage, List<GroupStatus>, List<InstanceStatus>, ResourceUsage, boolean, int, int, int) - Constructor for record class cloud.spawnery.agent.api.NetworkStatus
-
Creates an instance of a
NetworkStatusrecord class. - node() - Method in record class cloud.spawnery.agent.api.InstanceStatus
-
Returns the value of the
noderecord component. - node() - Method in record class cloud.spawnery.agent.api.ProxyInfo
-
Returns the value of the
noderecord component. - node() - Method in record class cloud.spawnery.agent.api.ServerInfo
-
Returns the value of the
noderecord component. - NONE - Static variable in record class cloud.spawnery.agent.api.ServerResources
-
No component set.
- number() - Method in record class cloud.spawnery.agent.api.ServerInfo
-
Returns the value of the
numberrecord component.
O
- ON_DEMAND - Enum constant in enum class cloud.spawnery.agent.api.Group.Kind
-
Servers asked for by name, one key each; see
SpawneryApi.startServer(java.lang.String, java.lang.String). - onlinePlayers() - Method in record class cloud.spawnery.agent.api.Group
-
Returns the value of the
onlinePlayersrecord component. - ordered() - Method in record class cloud.spawnery.agent.api.ConnectResult
-
Returns the value of the
orderedrecord component. - other() - Method in record class cloud.spawnery.agent.api.NetworkStatus
-
Returns the value of the
otherrecord component.
P
- PENDING - Enum constant in enum class cloud.spawnery.agent.api.ServerPhase
- PERSISTENT - Enum constant in enum class cloud.spawnery.agent.api.Group.Kind
-
Sized by a number a person wrote down; servers own their worlds.
- phase() - Method in record class cloud.spawnery.agent.api.GroupStatus
-
Returns the value of the
phaserecord component. - phase() - Method in record class cloud.spawnery.agent.api.InstanceStatus
-
Returns the value of the
phaserecord component. - phase() - Method in record class cloud.spawnery.agent.api.ServerInfo
-
Returns the value of the
phaserecord component. - pinned() - Method in record class cloud.spawnery.agent.api.Group
-
Returns the value of the
pinnedrecord component. - pinnedReplicas() - Method in record class cloud.spawnery.agent.api.Group
-
Returns the value of the
pinnedReplicasrecord component. - pinnedUntil() - Method in record class cloud.spawnery.agent.api.Group
-
Returns the value of the
pinnedUntilrecord component. - playableSlots() - Method in record class cloud.spawnery.agent.api.InstanceStatus
-
Returns the value of the
playableSlotsrecord component. - playableSlots() - Method in record class cloud.spawnery.agent.api.ServerInfo
-
Returns the value of the
playableSlotsrecord component. - playableSlots(int) - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
Sets how many of this server's seats count as capacity, from now until changed: what its group's spare slots, free slots and a connect to the group measure.
- player(UUID) - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
One player by UUID, empty if they are not on this network.
- players() - Method in record class cloud.spawnery.agent.api.GroupStatus
-
Returns the value of the
playersrecord component. - players() - Method in record class cloud.spawnery.agent.api.InstanceStatus
-
Returns the value of the
playersrecord component. - players() - Method in record class cloud.spawnery.agent.api.NetworkStatus
-
Returns the value of the
playersrecord component. - players() - Method in record class cloud.spawnery.agent.api.ProxyInfo
-
Returns the value of the
playersrecord component. - players() - Method in record class cloud.spawnery.agent.api.ServerInfo
-
Returns the value of the
playersrecord component. - players() - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
Every player on this network, whichever backend they are on.
- pods() - Method in record class cloud.spawnery.agent.api.ResourceUsage
-
Returns the value of the
podsrecord component. - podsMeasured() - Method in record class cloud.spawnery.agent.api.ResourceUsage
-
Returns the value of the
podsMeasuredrecord component. - points() - Method in record class cloud.spawnery.agent.api.RestorePoints
-
Returns the value of the
pointsrecord component. - proxies() - Method in record class cloud.spawnery.agent.api.NetworkStatus
-
Returns the value of the
proxiesrecord component. - proxies() - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
Every proxy in this network, in no particular order.
- proxy() - Method in record class cloud.spawnery.agent.api.InstanceStatus
-
Returns the value of the
proxyrecord component. - proxy(String) - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
One proxy by name, empty if this network has none.
- PROXY - Enum constant in enum class cloud.spawnery.agent.api.Group.Kind
-
A group of proxies.
- ProxyInfo - Record Class in cloud.spawnery.agent.api
-
One proxy of this network, as the operator last described it.
- ProxyInfo(String, String, boolean, boolean, int) - Constructor for record class cloud.spawnery.agent.api.ProxyInfo
-
The record as it was before
node, which it reads as not scheduled. - ProxyInfo(String, String, boolean, boolean, int, String) - Constructor for record class cloud.spawnery.agent.api.ProxyInfo
-
Creates an instance of a
ProxyInforecord class. - ProxySelf - Interface in cloud.spawnery.agent.api
-
A Velocity proxy's view of itself.
R
- ReadinessHold - Interface in cloud.spawnery.agent.api
-
A hold that keeps this server out of readiness until it is released.
- ready() - Method in record class cloud.spawnery.agent.api.InstanceStatus
-
Returns the value of the
readyrecord component. - ready() - Method in record class cloud.spawnery.agent.api.ProxyInfo
-
Returns the value of the
readyrecord component. - READY - Enum constant in enum class cloud.spawnery.agent.api.ServerPhase
- readyReplicas() - Method in record class cloud.spawnery.agent.api.Group
-
Returns the value of the
readyReplicasrecord component. - readyReplicas() - Method in record class cloud.spawnery.agent.api.GroupStatus
-
Returns the value of the
readyReplicasrecord component. - registered() - Method in record class cloud.spawnery.agent.api.ServerInfo
-
Returns the value of the
registeredrecord component. - replicas() - Method in record class cloud.spawnery.agent.api.BoostResult
-
Returns the value of the
replicasrecord component. - replicas() - Method in record class cloud.spawnery.agent.api.Group
-
Returns the value of the
replicasrecord component. - replicas() - Method in record class cloud.spawnery.agent.api.GroupStatus
-
Returns the value of the
replicasrecord component. - replicas() - Method in record class cloud.spawnery.agent.api.ScaleResult
-
Returns the value of the
replicasrecord component. - resetScale(String) - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
Ends every pin and every boost on a group and reports how many there were.
- resources() - Method in record class cloud.spawnery.agent.api.ServerInfo
-
Returns the value of the
resourcesrecord component. - resources() - Method in record class cloud.spawnery.agent.api.StartedServer
-
Returns the value of the
resourcesrecord component. - resources() - Method in class cloud.spawnery.agent.api.StartOptions
-
The resources chosen,
ServerResources.NONEwhen none were. - ResourceUsage - Record Class in cloud.spawnery.agent.api
-
What a set of pods uses right now, and what they asked for.
- ResourceUsage(long, long, long, boolean, long, long, long, boolean, int, int) - Constructor for record class cloud.spawnery.agent.api.ResourceUsage
-
Creates an instance of a
ResourceUsagerecord class. - restoredFrom() - Method in record class cloud.spawnery.agent.api.RestoredWorld
-
Returns the value of the
restoredFromrecord component. - RestoredWorld - Record Class in cloud.spawnery.agent.api
- RestoredWorld(long, long) - Constructor for record class cloud.spawnery.agent.api.RestoredWorld
-
Creates an instance of a
RestoredWorldrecord class. - RestorePoint - Record Class in cloud.spawnery.agent.api
-
One generation of a private server's world that
SpawneryApi.restoreWorld(java.lang.String, java.lang.String, long)can go back to. - RestorePoint(long, Instant, boolean) - Constructor for record class cloud.spawnery.agent.api.RestorePoint
-
Creates an instance of a
RestorePointrecord class. - restorePoints(String, String) - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
Lists the generations of a private server's world that
SpawneryApi.restoreWorld(java.lang.String, java.lang.String, long)can go back to, newest first. - RestorePoints - Record Class in cloud.spawnery.agent.api
- RestorePoints(List<RestorePoint>, boolean) - Constructor for record class cloud.spawnery.agent.api.RestorePoints
-
Creates an instance of a
RestorePointsrecord class. - restoreWorld(String, String, long) - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
Makes an older generation of a private server's world its current world, as a new generation.
- retire(String) - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
Asks that one server stop taking joins and empty out.
- retiring() - Method in record class cloud.spawnery.agent.api.InstanceStatus
-
Returns the value of the
retiringrecord component. - RETIRING - Enum constant in enum class cloud.spawnery.agent.api.ServerPhase
S
- scale(String, int, Duration) - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
Holds an ephemeral group at exactly this many servers for a while.
- ScaleResult - Record Class in cloud.spawnery.agent.api
-
The pin a
SpawneryApi.scale(java.lang.String, int, java.time.Duration)call created. - ScaleResult(int, Instant) - Constructor for record class cloud.spawnery.agent.api.ScaleResult
-
Creates an instance of a
ScaleResultrecord class. - self() - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
What this process is.
- Self - Interface in cloud.spawnery.agent.api
-
What this process is, in the network's own vocabulary.
- server() - Method in record class cloud.spawnery.agent.api.CloudPlayer
-
Returns the value of the
serverrecord component. - server(String) - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
One server by name, empty if this network has none.
- server(String) - Static method in interface cloud.spawnery.agent.api.Target
-
That exact server, by the name
ServerInfo.name()carries. - Server(String) - Constructor for record class cloud.spawnery.agent.api.Target.Server
-
Creates an instance of a
Serverrecord class. - ServerInfo - Record Class in cloud.spawnery.agent.api
-
One backend, as the operator last described it.
- ServerInfo(String, String, ServerPhase, int, int, boolean, String, Map<String, String>, String, int) - Constructor for record class cloud.spawnery.agent.api.ServerInfo
-
The record as it was before
held, which it reads as false. - ServerInfo(String, String, ServerPhase, int, int, boolean, String, Map<String, String>, String, int, boolean) - Constructor for record class cloud.spawnery.agent.api.ServerInfo
-
The record as it was before
node, which it reads as not scheduled. - ServerInfo(String, String, ServerPhase, int, int, boolean, String, Map<String, String>, String, int, boolean, String) - Constructor for record class cloud.spawnery.agent.api.ServerInfo
-
The record as it was before
playableSlots, which it reads as every seat. - ServerInfo(String, String, ServerPhase, int, int, boolean, String, Map<String, String>, String, int, boolean, String, int) - Constructor for record class cloud.spawnery.agent.api.ServerInfo
-
The record as it was before
resources, which it reads as none. - ServerInfo(String, String, ServerPhase, int, int, boolean, String, Map<String, String>, String, int, boolean, String, int, ServerResources) - Constructor for record class cloud.spawnery.agent.api.ServerInfo
-
The record as it was before
unschedulable, which it reads as false. - ServerInfo(String, String, ServerPhase, int, int, boolean, String, Map<String, String>, String, int, boolean, String, int, ServerResources, boolean) - Constructor for record class cloud.spawnery.agent.api.ServerInfo
-
Creates an instance of a
ServerInforecord class. - ServerPhase - Enum Class in cloud.spawnery.agent.api
-
Where a server is in its life, in the operator's own vocabulary.
- ServerResources - Record Class in cloud.spawnery.agent.api
-
The resources of one private server, as quantities in Kubernetes notation.
- ServerResources(Optional<String>, Optional<String>, Optional<String>, Optional<String>, Optional<String>) - Constructor for record class cloud.spawnery.agent.api.ServerResources
-
Creates an instance of a
ServerResourcesrecord class. - servers() - Method in record class cloud.spawnery.agent.api.NetworkStatus
-
Returns the value of the
serversrecord component. - servers() - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
Every server in this network, in no particular order.
- ServerSelf - Interface in cloud.spawnery.agent.api
-
A Paper backend's view of itself.
- settling() - Method in record class cloud.spawnery.agent.api.RestorePoints
-
Returns the value of the
settlingrecord component. - slots() - Method in record class cloud.spawnery.agent.api.InstanceStatus
-
Returns the value of the
slotsrecord component. - slots() - Method in record class cloud.spawnery.agent.api.ServerInfo
-
Returns the value of the
slotsrecord component. - slots() - Method in interface cloud.spawnery.agent.api.ServerSelf
-
The player capacity this server was configured with -- the group's
spec.maxPlayers, which is also what the agent reports upward. - Spawnery - Class in cloud.spawnery.agent.api
-
How a plugin gets a
SpawneryApi, in one line and the same line on both platforms. - SpawneryApi - Interface in cloud.spawnery.agent.api
-
What a plugin can ask the cloud, from either side of the proxy.
- SpawneryUnavailableException - Exception Class in cloud.spawnery.agent.api
-
Thrown by
Spawnery.api()when no agent has installed one. - SpawneryUnavailableException(String) - Constructor for exception class cloud.spawnery.agent.api.SpawneryUnavailableException
- StartedServer - Record Class in cloud.spawnery.agent.api
-
The private server a
SpawneryApi.startServer(java.lang.String, java.lang.String)produced. - StartedServer(String, boolean) - Constructor for record class cloud.spawnery.agent.api.StartedServer
-
The record as it was before
resources, which it reads as none. - StartedServer(String, boolean, ServerResources) - Constructor for record class cloud.spawnery.agent.api.StartedServer
-
Creates an instance of a
StartedServerrecord class. - STARTING - Enum constant in enum class cloud.spawnery.agent.api.ServerPhase
- StartOptions - Class in cloud.spawnery.agent.api
-
What a plugin chooses for one private server it starts; see
SpawneryApi.startServer(String, String, StartOptions). - StartOptions.Builder - Class in cloud.spawnery.agent.api
- startServer(String, String) - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
Asks for the private server that carries this key.
- startServer(String, String, StartOptions) - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
Asks for the private server that carries this key, with resources of your choosing for it.
- state() - Method in record class cloud.spawnery.agent.api.ServerInfo
-
Returns the value of the
staterecord component. - status() - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
How this network is doing: CPU and memory of its pods against what they asked for, per group, and each server's tick rate.
- status(String) - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
SpawneryApi.status()for one server group, proxy group, server or proxy, looked up in that order. - stopBoosts(String) - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
Deprecated.use
SpawneryApi.resetScale(java.lang.String); this keeps working. - stopServer(String) - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
Stops one private server and leaves its world where it is.
- subject() - Method in record class cloud.spawnery.agent.api.CloudEventInfo
-
Returns the value of the
subjectrecord component. - subscribe(Consumer<CloudEventInfo>) - Method in interface cloud.spawnery.agent.api.EventBus
-
Calls
listenerfor every cloud event this agent receives, until the returned handle is closed.
T
- taken() - Method in record class cloud.spawnery.agent.api.RestorePoint
-
Returns the value of the
takenrecord component. - target() - Method in record class cloud.spawnery.agent.api.ConnectResult
-
Returns the value of the
targetrecord component. - Target - Interface in cloud.spawnery.agent.api
-
Where a player is to be sent.
- Target.Group - Record Class in cloud.spawnery.agent.api
- Target.Server - Record Class in cloud.spawnery.agent.api
- TERMINATING - Enum constant in enum class cloud.spawnery.agent.api.ServerPhase
- toString() - Method in record class cloud.spawnery.agent.api.BoostResult
-
Returns a string representation of this record class.
- toString() - Method in record class cloud.spawnery.agent.api.CloudEventInfo
-
Returns a string representation of this record class.
- toString() - Method in record class cloud.spawnery.agent.api.CloudPlayer
-
Returns a string representation of this record class.
- toString() - Method in record class cloud.spawnery.agent.api.ConnectResult
-
Returns a string representation of this record class.
- toString() - Method in record class cloud.spawnery.agent.api.Group
-
Returns a string representation of this record class.
- toString() - Method in record class cloud.spawnery.agent.api.GroupStatus
-
Returns a string representation of this record class.
- toString() - Method in record class cloud.spawnery.agent.api.InstanceStatus
-
Returns a string representation of this record class.
- toString() - Method in record class cloud.spawnery.agent.api.NetworkStatus
-
Returns a string representation of this record class.
- toString() - Method in record class cloud.spawnery.agent.api.ProxyInfo
-
Returns a string representation of this record class.
- toString() - Method in record class cloud.spawnery.agent.api.ResourceUsage
-
Returns a string representation of this record class.
- toString() - Method in record class cloud.spawnery.agent.api.RestoredWorld
-
Returns a string representation of this record class.
- toString() - Method in record class cloud.spawnery.agent.api.RestorePoint
-
Returns a string representation of this record class.
- toString() - Method in record class cloud.spawnery.agent.api.RestorePoints
-
Returns a string representation of this record class.
- toString() - Method in record class cloud.spawnery.agent.api.ScaleResult
-
Returns a string representation of this record class.
- toString() - Method in record class cloud.spawnery.agent.api.ServerInfo
-
Returns a string representation of this record class.
- toString() - Method in record class cloud.spawnery.agent.api.ServerResources
-
Returns a string representation of this record class.
- toString() - Method in record class cloud.spawnery.agent.api.StartedServer
-
Returns a string representation of this record class.
- toString() - Method in record class cloud.spawnery.agent.api.Target.Group
-
Returns a string representation of this record class.
- toString() - Method in record class cloud.spawnery.agent.api.Target.Server
-
Returns a string representation of this record class.
- total() - Method in record class cloud.spawnery.agent.api.NetworkStatus
-
Returns the value of the
totalrecord component. - tps() - Method in record class cloud.spawnery.agent.api.InstanceStatus
-
Returns the value of the
tpsrecord component.
U
- uninstall() - Static method in class cloud.spawnery.agent.api.Spawnery
-
Removes the installed API.
- UNKNOWN - Enum constant in enum class cloud.spawnery.agent.api.Group.Kind
-
A kind this jar predates.
- UNKNOWN - Enum constant in enum class cloud.spawnery.agent.api.ServerPhase
- unretire(String) - Method in interface cloud.spawnery.agent.api.SpawneryApi
-
Takes a server's retirement back.
- unschedulable() - Method in record class cloud.spawnery.agent.api.ServerInfo
-
Returns the value of the
unschedulablerecord component. - usage() - Method in record class cloud.spawnery.agent.api.GroupStatus
-
Returns the value of the
usagerecord component. - usage() - Method in record class cloud.spawnery.agent.api.InstanceStatus
-
Returns the value of the
usagerecord component.
V
- valueOf(String) - Static method in enum class cloud.spawnery.agent.api.Group.Kind
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class cloud.spawnery.agent.api.ServerPhase
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class cloud.spawnery.agent.api.Group.Kind
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class cloud.spawnery.agent.api.ServerPhase
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- warning() - Method in record class cloud.spawnery.agent.api.CloudEventInfo
-
Returns the value of the
warningrecord component.
All Classes and Interfaces|All Packages|Serialized Form
SpawneryApi.scale(java.lang.String, int, java.time.Duration), which sets the size rather than adding to it; this keeps working.