Class: Twilio::REST::Serverless::V1::ServiceContext::FunctionList

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

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil) ⇒ FunctionList

Initialize the FunctionList



23
24
25
26
27
28
29
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 23

def initialize(version, service_sid: nil)
  super(version)

  # Path Solution
  @solution = {service_sid: service_sid}
  @uri = "/Services/#{@solution[:service_sid]}/Functions"
end

Instance Method Details

#create(friendly_name: nil) ⇒ FunctionInstance

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



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

def create(friendly_name: nil)
  data = Twilio::Values.of({'FriendlyName' => friendly_name, })

  payload = @version.create(
      'POST',
      @uri,
      data: data
  )

  FunctionInstance.new(@version, payload, service_sid: @solution[:service_sid], )
end

#each ⇒ Object

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



69
70
71
72
73
74
75
76
77
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 69

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



105
106
107
108
109
110
111
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 105

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

#list(limit: nil, page_size: nil) ⇒ Array

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



42
43
44
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 42

def list(limit: nil, page_size: nil)
  self.stream(limit: limit, page_size: page_size).entries
end

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

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



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 86

def page(page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  FunctionPage.new(@version, response, @solution)
end

#stream(limit: nil, page_size: nil) ⇒ Enumerable

Streams FunctionInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.



57
58
59
60
61
62
63
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 57

def stream(limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(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



133
134
135
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 133

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