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

Parameters:

  • version (Version) —

    Version that contains the resource



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

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.



79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 79

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of AlertInstance



123
124
125
126
127
128
129
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 123

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.

Parameters:

  • log_level (String) (defaults to: :unset) —

    The log_level

  • start_date (Date) (defaults to: :unset) —

    The start_date

  • end_date (Date) (defaults to: :unset) —

    The end_date

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



38
39
40
41
42
43
44
45
46
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 38

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.

Parameters:

  • log_level (String) (defaults to: :unset) —

    The log_level

  • start_date (Date) (defaults to: :unset) —

    The start_date

  • end_date (Date) (defaults to: :unset) —

    The end_date

  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of AlertInstance



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 101

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.

Parameters:

  • log_level (String) (defaults to: :unset) —

    The log_level

  • start_date (Date) (defaults to: :unset) —

    The start_date

  • end_date (Date) (defaults to: :unset) —

    The end_date

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 62

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



133
134
135
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 133

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