Class: Ably::Models::Stats::ResourceCount

Inherits:

StatsStruct

• Object
• StatsStruct
• Ably::Models::Stats::ResourceCount

Defined in:

lib/submodules/ably-ruby/lib/ably/models/stats_types.rb

Overview

ResourceCount contains aggregate data for usage of a resource in a specific scope

Instance Attribute Summary

• #mean ⇒ Integer readonly

  Average resources of this type used for this period.

• #min ⇒ Integer readonly

  Minimum total resources of this type used for this period.

• #opened ⇒ Integer readonly

  Total resources of this type opened.

• #peak ⇒ Integer readonly

  Peak resources of this type used for this period.

• #refused ⇒ Integer readonly

  Resource requests refused within this period.

Attributes inherited from StatsStruct

#hash

Method Summary

Methods inherited from StatsStruct

coerce_attributes, #initialize, type_klass

Constructor Details

This class inherits a constructor from Ably::Models::Stats::StatsStruct

Instance Attribute Details

#mean ⇒ Integer (readonly)

Returns average resources of this type used for this period.

Returns:

• (Integer) —

  average resources of this type used for this period

# File 'lib/submodules/ably-ruby/lib/ably/models/stats_types.rb', line 92

class ResourceCount < StatsStruct
  coerce_attributes :opened, :peak, :mean, :min, :refused, into: IntegerDefaultZero
end

#min ⇒ Integer (readonly)

Returns minimum total resources of this type used for this period.

Returns:

• (Integer) —

  minimum total resources of this type used for this period

# File 'lib/submodules/ably-ruby/lib/ably/models/stats_types.rb', line 92

class ResourceCount < StatsStruct
  coerce_attributes :opened, :peak, :mean, :min, :refused, into: IntegerDefaultZero
end

#opened ⇒ Integer (readonly)

Returns total resources of this type opened.

Returns:

• (Integer) —

  total resources of this type opened

# File 'lib/submodules/ably-ruby/lib/ably/models/stats_types.rb', line 92

class ResourceCount < StatsStruct
  coerce_attributes :opened, :peak, :mean, :min, :refused, into: IntegerDefaultZero
end

#peak ⇒ Integer (readonly)

Returns peak resources of this type used for this period.

Returns:

• (Integer) —

  peak resources of this type used for this period

# File 'lib/submodules/ably-ruby/lib/ably/models/stats_types.rb', line 92

class ResourceCount < StatsStruct
  coerce_attributes :opened, :peak, :mean, :min, :refused, into: IntegerDefaultZero
end

#refused ⇒ Integer (readonly)

Returns resource requests refused within this period.

Returns:

• (Integer) —

  resource requests refused within this period

# File 'lib/submodules/ably-ruby/lib/ably/models/stats_types.rb', line 92

class ResourceCount < StatsStruct
  coerce_attributes :opened, :peak, :mean, :min, :refused, into: IntegerDefaultZero
end