io.ably.lib.types

Class Stats

java.lang.Object

io.ably.lib.types.Stats

public class Stats
extends java.lang.Object

A class encapsulating a Stats datapoint. Ably usage information, across an account or an individual app, is available as Stats records on a timeline with different granularities. This class defines the Stats type and its subtypes, giving a structured representation of service usage for a specific scope and time interval. This class also contains utility methods to convert from the different formats used for REST responses.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Stats.ConnectionTypes A breakdown of summary stats data for different (tls vs non-tls) connection types.
static class	Stats.Granularity
static class	Stats.MessageCategory
static class	Stats.MessageCount A datapoint for message volume (number of messages plus aggregate data size)
static class	Stats.MessageTraffic A breakdown of summary stats data for traffic over various transport types.
static class	Stats.MessageTypes A breakdown of summary stats data for different (message vs presence) message types.
static class	Stats.ProcessedCount
static class	Stats.ProcessedMessages
static class	Stats.RequestCount Aggregate data for numbers of requests in a specific scope.
static class	Stats.ResourceCount Aggregate data for usage of a resource in a specific scope.

Field Summary

Fields

Modifier and Type	Field and Description
Stats.MessageTypes	all
Stats.RequestCount	apiRequests
Stats.ResourceCount	channels
Stats.ConnectionTypes	connections
Stats.MessageTraffic	inbound
java.lang.String	intervalId
Stats.MessageTraffic	outbound
Stats.MessageTypes	persisted
Stats.ProcessedMessages	processed
Stats.RequestCount	tokenRequests
java.lang.String	unit

Constructor Summary

Constructors

Constructor and Description
Stats()

Method Summary

Modifier and Type	Method and Description
static long	fromIntervalId(java.lang.String intervalId)
static java.lang.String	toIntervalId(long timestamp, Stats.Granularity granularity)

Methods inherited from class java.lang.Object

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

Field Detail

intervalId

public java.lang.String intervalId

unit

public java.lang.String unit

all

public Stats.MessageTypes all

inbound

public Stats.MessageTraffic inbound

outbound

public Stats.MessageTraffic outbound

persisted

public Stats.MessageTypes persisted

connections

public Stats.ConnectionTypes connections

channels

public Stats.ResourceCount channels

apiRequests

public Stats.RequestCount apiRequests

tokenRequests

public Stats.RequestCount tokenRequests

processed

public Stats.ProcessedMessages processed

Constructor Detail

Stats

public Stats()

Method Detail

toIntervalId

public static java.lang.String toIntervalId(long timestamp,
                                            Stats.Granularity granularity)

fromIntervalId

public static long fromIntervalId(java.lang.String intervalId)