Class: Twilio::REST::Monitor::V1::EventList

Inherits:
ListResource show all
Defined in:
lib/twilio-ruby/rest/monitor/v1/event.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ EventList

Initialize the EventList



18
19
20
21
22
23
24
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 18

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/Events"
end

Instance Method Details

#each ⇒ Object

When passed a block, yields EventInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



111
112
113
114
115
116
117
118
119
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 111

def each
  limits = @version.read_limits

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page,
                  limit: limits[:limit],
                  page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of EventInstance records from the API. Request is executed immediately.



166
167
168
169
170
171
172
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 166

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  EventPage.new(@version, response, @solution)
end

#list(actor_sid: :unset, event_type: :unset, resource_sid: :unset, source_ip_address: :unset, start_date: :unset, end_date: :unset, limit: nil, page_size: nil) ⇒ Array

Lists EventInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.



52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 52

def list(actor_sid: :unset, event_type: :unset, resource_sid: :unset, source_ip_address: :unset, start_date: :unset, end_date: :unset, limit: nil, page_size: nil)
  self.stream(
      actor_sid: actor_sid,
      event_type: event_type,
      resource_sid: resource_sid,
      source_ip_address: source_ip_address,
      start_date: start_date,
      end_date: end_date,
      limit: limit,
      page_size: page_size
  ).entries
end

#page(actor_sid: :unset, event_type: :unset, resource_sid: :unset, source_ip_address: :unset, start_date: :unset, end_date: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of EventInstance records from the API. Request is executed immediately.



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 143

def page(actor_sid: :unset, event_type: :unset, resource_sid: :unset, source_ip_address: :unset, start_date: :unset, end_date: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'ActorSid' => actor_sid,
      'EventType' => event_type,
      'ResourceSid' => resource_sid,
      'SourceIpAddress' => source_ip_address,
      'StartDate' => Twilio.serialize_iso8601_datetime(start_date),
      'EndDate' => Twilio.serialize_iso8601_datetime(end_date),
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

  response = @version.page('GET', @uri, params: params)

  EventPage.new(@version, response, @solution)
end

#stream(actor_sid: :unset, event_type: :unset, resource_sid: :unset, source_ip_address: :unset, start_date: :unset, end_date: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams EventInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 91

def stream(actor_sid: :unset, event_type: :unset, resource_sid: :unset, source_ip_address: :unset, start_date: :unset, end_date: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      actor_sid: actor_sid,
      event_type: event_type,
      resource_sid: resource_sid,
      source_ip_address: source_ip_address,
      start_date: start_date,
      end_date: end_date,
      page_size: limits[:page_size],
  )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



176
177
178
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 176

def to_s
  '#<Twilio.Monitor.V1.EventList>'
end