Package io.ably.lib.types

Class SummaryClientIdCounts

java.lang.Object
io.ably.lib.types.SummaryClientIdCounts
public class SummaryClientIdCounts extends Object
The per-name value for the multiple.v1 aggregation method.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final Map<String,Integer>
    clientIds
    A list of the clientIds of all clients who have published an annotation with this name, and the count each of them have contributed.
    final boolean
    clipped
    Whether the list of clientIds has been clipped due to exceeding the maximum number of clients.
    final int
    total
    The sum of the counts from all clients who have published an annotation with this name
    final int
    totalClientIds
    The total number of distinct clientIds in the map (equal to length of map if clipped is false).
    final int
    totalUnidentified
    The sum of the counts from all unidentified clients who have published an annotation with this name, and so who are not included in the clientIds list

  • Constructor Summary

    Constructors
    Constructor
    Description
    SummaryClientIdCounts(int total, Map<String,Integer> clientIds, int totalUnidentified, boolean clipped, int totalClientIds)
     

  • Method Summary

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • total

      public final int total
      The sum of the counts from all clients who have published an annotation with this name

    • clientIds

      public final Map<String,Integer> clientIds
      A list of the clientIds of all clients who have published an annotation with this name, and the count each of them have contributed.

    • totalUnidentified

      public final int totalUnidentified
      The sum of the counts from all unidentified clients who have published an annotation with this name, and so who are not included in the clientIds list

    • clipped

      public final boolean clipped
      Whether the list of clientIds has been clipped due to exceeding the maximum number of clients.

    • totalClientIds

      public final int totalClientIds
      The total number of distinct clientIds in the map (equal to length of map if clipped is false).

  • Constructor Details

    • SummaryClientIdCounts

      public SummaryClientIdCounts(int total, Map<String,Integer> clientIds, int totalUnidentified, boolean clipped, int totalClientIds)