Package cloud.spawnery.agent.api

Record Class GroupStatus

java.lang.Object
java.lang.Record
cloud.spawnery.agent.api.GroupStatus
public record GroupStatus(String name, Group.Kind kind, String phase, int replicas, int readyReplicas, int players, OptionalDouble lowestTps, ResourceUsage usage) extends Record
One group in a NetworkStatus. lowestTps is empty for a proxy group and for a group none of whose servers reported one.

  • Constructor Details

    • GroupStatus

      public GroupStatus(String name, Group.Kind kind, String phase, int replicas, int readyReplicas, int players, OptionalDouble lowestTps, ResourceUsage usage)
      Creates an instance of a GroupStatus record class.
      Parameters:
      name - the value for the name record component
      kind - the value for the kind record component
      phase - the value for the phase record component
      replicas - the value for the replicas record component
      readyReplicas - the value for the readyReplicas record component
      players - the value for the players record component
      lowestTps - the value for the lowestTps record component
      usage - the value for the usage record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • kind

      public Group.Kind kind()
      Returns the value of the kind record component.
      Returns:
      the value of the kind record component

    • phase

      public String phase()
      Returns the value of the phase record component.
      Returns:
      the value of the phase record component

    • replicas

      public int replicas()
      Returns the value of the replicas record component.
      Returns:
      the value of the replicas record component

    • readyReplicas

      public int readyReplicas()
      Returns the value of the readyReplicas record component.
      Returns:
      the value of the readyReplicas record component

    • players

      public int players()
      Returns the value of the players record component.
      Returns:
      the value of the players record component

    • lowestTps

      public OptionalDouble lowestTps()
      Returns the value of the lowestTps record component.
      Returns:
      the value of the lowestTps record component

    • usage

      public ResourceUsage usage()
      Returns the value of the usage record component.
      Returns:
      the value of the usage record component