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



25
26
27
28
29
30
31
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 25

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.



99
100
101
102
103
104
105
106
107
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.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 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



145
146
147
148
149
150
151
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 145

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 [Event Type](www.twilio.com/docs/usage/monitor-events#event-types).

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

    Only include events that refer 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 include events that occurred on or after this date. Specify the date in GMT and [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

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

    Only include events that occurred on or before this date. Specify the date in GMT and [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

  • 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



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

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 [Event Type](www.twilio.com/docs/usage/monitor-events#event-types).

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

    Only include events that refer 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 include events that occurred on or after this date. Specify the date in GMT and [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

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

    Only include events that occurred on or before this date. Specify the date in GMT and [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

  • 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



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 122

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 Instance 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 [Event Type](www.twilio.com/docs/usage/monitor-events#event-types).

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

    Only include events that refer 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 include events that occurred on or after this date. Specify the date in GMT and [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

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

    Only include events that occurred on or before this date. Specify the date in GMT and [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

  • 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



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

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



156
157
158
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 156

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