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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

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

  • service_sid (String) (defaults to: nil) —

    The SID of the Service that the Log resource is associated with.

  • environment_sid (String) (defaults to: nil) —

    The SID of the environment in which the log occurred.


26
27
28
29
30
31
32
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/log.rb', line 26

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.


95
96
97
98
99
100
101
102
103
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/log.rb', line 95

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of LogInstance


138
139
140
141
142
143
144
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/log.rb', line 138

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


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

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

#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


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

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,
  })

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

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

#stream(function_sid: :unset, start_date: :unset, end_date: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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


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

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


148
149
150
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/log.rb', line 148

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