Class: Twilio::REST::Serverless::V1::ServiceContext::EnvironmentList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Serverless::V1::ServiceContext::EnvironmentList
- Defined in:
- lib/twilio-ruby/rest/serverless/v1/service/environment.rb
Overview
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
Instance Method Summary collapse
-
#create(unique_name: nil, domain_suffix: :unset) ⇒ EnvironmentInstance
Create the EnvironmentInstance.
-
#each ⇒ Object
When passed a block, yields EnvironmentInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of EnvironmentInstance records from the API.
-
#initialize(version, service_sid: nil) ⇒ EnvironmentList
constructor
Initialize the EnvironmentList.
-
#list(limit: nil, page_size: nil) ⇒ Array
Lists EnvironmentInstance records from the API as a list.
-
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of EnvironmentInstance records from the API.
-
#stream(limit: nil, page_size: nil) ⇒ Enumerable
Streams EnvironmentInstance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version, service_sid: nil) ⇒ EnvironmentList
Initialize the EnvironmentList
23 24 25 26 27 28 29 |
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 23 def initialize(version, service_sid: nil) super(version) # Path Solution @solution = {service_sid: service_sid} @uri = "/Services/#{@solution[:service_sid]}/Environments" end |
Instance Method Details
#create(unique_name: nil, domain_suffix: :unset) ⇒ EnvironmentInstance
Create the EnvironmentInstance
119 120 121 122 123 124 125 |
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 119 def create(unique_name: nil, domain_suffix: :unset) data = Twilio::Values.of({'UniqueName' => unique_name, 'DomainSuffix' => domain_suffix, }) payload = @version.create('POST', @uri, data: data) EnvironmentInstance.new(@version, payload, service_sid: @solution[:service_sid], ) end |
#each ⇒ Object
When passed a block, yields EnvironmentInstance 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/environment.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 EnvironmentInstance records from the API. Request is executed immediately.
103 104 105 106 107 108 109 |
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 103 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) EnvironmentPage.new(@version, response, @solution) end |
#list(limit: nil, page_size: nil) ⇒ Array
Lists EnvironmentInstance 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/environment.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 EnvironmentInstance records from the API. Request is executed immediately.
86 87 88 89 90 91 92 93 94 95 96 |
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.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: params) EnvironmentPage.new(@version, response, @solution) end |
#stream(limit: nil, page_size: nil) ⇒ Enumerable
Streams EnvironmentInstance 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/environment.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
129 130 131 |
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 129 def to_s '#<Twilio.Serverless.V1.EnvironmentList>' end |