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

Parameters:

  • version (Version) —

    Version that contains the resource



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.



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

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of EventInstance



171
172
173
174
175
176
177
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 171

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.

Parameters:

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

    Only include Events initiated by this Actor. Useful for auditing actions taken by specific users or API credentials.

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

    Only include Events of this EventType.

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

    Only include Events referring to this resource. Useful for discovering the history of a specific resource.

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

    Only include Events that originated from this IP address. Useful for tracking suspicious activity originating from the API or the Twilio Console.

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

    Only show events on or after this date. Useful in combination with ‘EndDate` to define a date-range of events. Input is a [UTC ISO 8601 Timestamp](en.wikipedia.org/wiki/ISO_8601#UTC), but time of day is ignored by the filter.

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

    Only show events on or before this date. Useful in combination with ‘StartDate` to define a date-range of events. Input is a [UTC ISO 8601 Timestamp](en.wikipedia.org/wiki/ISO_8601#UTC), but time of day is ignored by the filter.

  • 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



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

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.

Parameters:

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

    Only include Events initiated by this Actor. Useful for auditing actions taken by specific users or API credentials.

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

    Only include Events of this EventType.

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

    Only include Events referring to this resource. Useful for discovering the history of a specific resource.

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

    Only include Events that originated from this IP address. Useful for tracking suspicious activity originating from the API or the Twilio Console.

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

    Only show events on or after this date. Useful in combination with ‘EndDate` to define a date-range of events. Input is a [UTC ISO 8601 Timestamp](en.wikipedia.org/wiki/ISO_8601#UTC), but time of day is ignored by the filter.

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

    Only show events on or before this date. Useful in combination with ‘StartDate` to define a date-range of events. Input is a [UTC ISO 8601 Timestamp](en.wikipedia.org/wiki/ISO_8601#UTC), but time of day is ignored by the filter.

  • 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 EventInstance



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 146

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
  )
  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.

Parameters:

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

    Only include Events initiated by this Actor. Useful for auditing actions taken by specific users or API credentials.

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

    Only include Events of this EventType.

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

    Only include Events referring to this resource. Useful for discovering the history of a specific resource.

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

    Only include Events that originated from this IP address. Useful for tracking suspicious activity originating from the API or the Twilio Console.

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

    Only show events on or after this date. Useful in combination with ‘EndDate` to define a date-range of events. Input is a [UTC ISO 8601 Timestamp](en.wikipedia.org/wiki/ISO_8601#UTC), but time of day is ignored by the filter.

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

    Only show events on or before this date. Useful in combination with ‘StartDate` to define a date-range of events. Input is a [UTC ISO 8601 Timestamp](en.wikipedia.org/wiki/ISO_8601#UTC), but time of day is ignored by the filter.

  • 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



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

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



181
182
183
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 181

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