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



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.



120
121
122
123
124
125
126
127
128
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/log.rb', line 120

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



163
164
165
166
167
168
169
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/log.rb', line 163

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.



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 



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/log.rb', line 100

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.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/log.rb', line 140

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.



76
77
78
79
80
81
82
83
84
85
86
 
# 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], )

    @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



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

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