Class: Orb::Models::Events::EventVolumes::Data

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/orb/models/events/event_volumes.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(data: ) ⇒ Object

Parameters:



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/orb/models/events/event_volumes.rb', line 16

class Data < Orb::Internal::Type::BaseModel
  # @!attribute count
  #   The number of events ingested with a timestamp between the timeframe
  #
  #   @return [Integer]
  required :count, Integer

  # @!attribute timeframe_end
  #
  #   @return [Time]
  required :timeframe_end, Time

  # @!attribute timeframe_start
  #
  #   @return [Time]
  required :timeframe_start, Time

  # @!method initialize(count:, timeframe_end:, timeframe_start:)
  #   An EventVolume contains the event volume ingested in an hourly window. The
  #   timestamp used for the aggregation is the `timestamp` datetime field on events.
  #
  #   @param count [Integer] The number of events ingested with a timestamp between the timeframe
  #
  #   @param timeframe_end [Time]
  #
  #   @param timeframe_start [Time]
end

Instance Attribute Details

#count ⇒ Integer

The number of events ingested with a timestamp between the timeframe

Returns:

  • (Integer) 


21
 
# File 'lib/orb/models/events/event_volumes.rb', line 21

required :count, Integer

#timeframe_end ⇒ Time

Returns:

  • (Time) 


26
 
# File 'lib/orb/models/events/event_volumes.rb', line 26

required :timeframe_end, Time

#timeframe_start ⇒ Time

Returns:

  • (Time) 


31
 
# File 'lib/orb/models/events/event_volumes.rb', line 31

required :timeframe_start, Time