Class: Twilio::REST::Monitor::V1::AlertList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ AlertList

Initialize the AlertList



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

def initialize(version)
  super(version)

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

Instance Method Details

#each ⇒ Object

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



99
100
101
102
103
104
105
106
107
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 99

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 AlertInstance records from the API. Request is executed immediately.



150
151
152
153
154
155
156
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 150

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

#list(log_level: :unset, start_date: :unset, end_date: :unset, limit: nil, page_size: nil) ⇒ Array

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



49
50
51
52
53
54
55
56
57
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 49

def list(log_level: :unset, start_date: :unset, end_date: :unset, limit: nil, page_size: nil)
  self.stream(
      log_level: log_level,
      start_date: start_date,
      end_date: end_date,
      limit: limit,
      page_size: page_size
  ).entries
end

#page(log_level: :unset, start_date: :unset, end_date: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 128

def page(log_level: :unset, start_date: :unset, end_date: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'LogLevel' => log_level,
      'StartDate' => Twilio.serialize_iso8601_date(start_date),
      'EndDate' => Twilio.serialize_iso8601_date(end_date),
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  AlertPage.new(@version, response, @solution)
end

#stream(log_level: :unset, start_date: :unset, end_date: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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



82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 82

def stream(log_level: :unset, start_date: :unset, end_date: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      log_level: log_level,
      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



160
161
162
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 160

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