Class: Twilio::REST::Serverless::V1::ServiceContext::EnvironmentContext::LogList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/serverless/v1/service/environment/log.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil, environment_sid: nil) ⇒ LogList

Initialize the LogList

Parameters:

  • version (Version) —

    Version that contains the resource



29
30
31
32
33
34
35
36
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/log.rb', line 29

def initialize(version, service_sid: nil, environment_sid: nil)
    super(version)
    
    # Path Solution
    @solution = { service_sid: service_sid, environment_sid: environment_sid }
    @uri = "/Services/#{@solution[:service_sid]}/Environments/#{@solution[:environment_sid]}/Logs"
    
end

Instance Method Details

#each ⇒ Object

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



124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/log.rb', line 124

def each
    limits = @version.read_limits

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

    return [].each if page.nil?

    result = @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit])
    return [].each if result.nil?
    result.each {|x| yield x}
end

#get_page(target_url) ⇒ Page

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of LogInstance



171
172
173
174
175
176
177
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/log.rb', line 171

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

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

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

Parameters:

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

    The SID of the function whose invocation produced the Log resources to read.

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

    The date/time (in GMT, ISO 8601) after which the Log resources must have been created. Defaults to 1 day prior to current date/time.

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

    The date/time (in GMT, ISO 8601) before which the Log resources must have been created. Defaults to current date/time.

  • 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



52
53
54
55
56
57
58
59
60
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/log.rb', line 52

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

#list_with_metadata(function_sid: :unset, start_date: :unset, end_date: :unset, limit: nil, page_size: nil) ⇒ Array

Returns Array of up to limit results.

Parameters:

  • 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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/log.rb', line 104

def list_with_metadata(function_sid: :unset, start_date: :unset, end_date: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'FunctionSid' => function_sid,
        'StartDate' =>  Twilio.serialize_iso8601_datetime(start_date),
        'EndDate' =>  Twilio.serialize_iso8601_datetime(end_date),
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

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

    LogPageMetadata.new(@version, response, @solution, limits[:limit])
end

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

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

Parameters:

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

    The SID of the function whose invocation produced the Log resources to read.

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

    The date/time (in GMT, ISO 8601) after which the Log resources must have been created. Defaults to 1 day prior to current date/time.

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

    The date/time (in GMT, ISO 8601) before which the Log resources must have been created. Defaults to current date/time.

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



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/log.rb', line 148

def page(function_sid: :unset, start_date: :unset, end_date: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
    params = Twilio::Values.of({
        'FunctionSid' => function_sid,
        'StartDate' =>  Twilio.serialize_iso8601_datetime(start_date),
        'EndDate' =>  Twilio.serialize_iso8601_datetime(end_date),
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

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

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

#stream(function_sid: :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:

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

    The SID of the function whose invocation produced the Log resources to read.

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

    The date/time (in GMT, ISO 8601) after which the Log resources must have been created. Defaults to 1 day prior to current date/time.

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

    The date/time (in GMT, ISO 8601) before which the Log resources must have been created. Defaults to current date/time.

  • 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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/log.rb', line 76

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

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

    return [].each if page.nil?

    result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
    return [].each if result.nil?
    result
end

#to_s ⇒ Object

Provide a user friendly representation



182
183
184
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/log.rb', line 182

def to_s
    '#<Twilio.Serverless.V1.LogList>'
end