class Twilio::REST::Serverless::V1::ServiceContext::EnvironmentList

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

Public Class Methods

new(version, service_sid: nil) click to toggle source

Initialize the EnvironmentList @param [Version] version Version that contains the resource @param [String] service_sid The SID of the Service that the Environment resource

is associated with.

@return [EnvironmentList] EnvironmentList

Calls superclass method Twilio::REST::ListResource::new
   # File lib/twilio-ruby/rest/serverless/v1/service/environment.rb
23 def initialize(version, service_sid: nil)
24   super(version)
25 
26   # Path Solution
27   @solution = {service_sid: service_sid}
28   @uri = "/Services/#{@solution[:service_sid]}/Environments"
29 end

Public Instance Methods

create(unique_name: nil, domain_suffix: :unset) click to toggle source

Create the EnvironmentInstance @param [String] unique_name A user-defined string that uniquely identifies the

Environment resource. It can be a maximum of 100 characters.

@param [String] domain_suffix A URL-friendly name that represents the

environment and forms part of the domain name. It can be a maximum of 16
characters.

@return [EnvironmentInstance] Created EnvironmentInstance

    # File lib/twilio-ruby/rest/serverless/v1/service/environment.rb
119 def create(unique_name: nil, domain_suffix: :unset)
120   data = Twilio::Values.of({'UniqueName' => unique_name, 'DomainSuffix' => domain_suffix, })
121 
122   payload = @version.create('POST', @uri, data: data)
123 
124   EnvironmentInstance.new(@version, payload, service_sid: @solution[:service_sid], )
125 end
each() { |x| ... } click to toggle source

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

   # File lib/twilio-ruby/rest/serverless/v1/service/environment.rb
69 def each
70   limits = @version.read_limits
71 
72   page = self.page(page_size: limits[:page_size], )
73 
74   @version.stream(page,
75                   limit: limits[:limit],
76                   page_limit: limits[:page_limit]).each {|x| yield x}
77 end
get_page(target_url) click to toggle source

Retrieve a single page of EnvironmentInstance records from the API. Request is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page of EnvironmentInstance

    # File lib/twilio-ruby/rest/serverless/v1/service/environment.rb
103 def get_page(target_url)
104   response = @version.domain.request(
105       'GET',
106       target_url
107   )
108   EnvironmentPage.new(@version, response, @solution)
109 end
list(limit: nil, page_size: nil) click to toggle source

Lists EnvironmentInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @param [Integer] limit Upper limit for the number of records to return. stream()

guarantees to never return more than limit.  Default is no limit

@param [Integer] page_size 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)

@return [Array] Array of up to limit results

   # File lib/twilio-ruby/rest/serverless/v1/service/environment.rb
42 def list(limit: nil, page_size: nil)
43   self.stream(limit: limit, page_size: page_size).entries
44 end
page(page_token: :unset, page_number: :unset, page_size: :unset) click to toggle source

Retrieve a single page of EnvironmentInstance records from the API. Request is executed immediately. @param [String] page_token PageToken provided by the API @param [Integer] page_number Page Number, this value is simply for client state @param [Integer] page_size Number of records to return, defaults to 50 @return [Page] Page of EnvironmentInstance

   # File lib/twilio-ruby/rest/serverless/v1/service/environment.rb
86 def page(page_token: :unset, page_number: :unset, page_size: :unset)
87   params = Twilio::Values.of({
88       'PageToken' => page_token,
89       'Page' => page_number,
90       'PageSize' => page_size,
91   })
92 
93   response = @version.page('GET', @uri, params: params)
94 
95   EnvironmentPage.new(@version, response, @solution)
96 end
stream(limit: nil, page_size: nil) click to toggle source

Streams EnvironmentInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @param [Integer] limit Upper limit for the number of records to return. stream()

guarantees to never return more than limit. Default is no limit.

@param [Integer] page_size 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)

@return [Enumerable] Enumerable that will yield up to limit results

   # File lib/twilio-ruby/rest/serverless/v1/service/environment.rb
57 def stream(limit: nil, page_size: nil)
58   limits = @version.read_limits(limit, page_size)
59 
60   page = self.page(page_size: limits[:page_size], )
61 
62   @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
63 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/serverless/v1/service/environment.rb
129 def to_s
130   '#<Twilio.Serverless.V1.EnvironmentList>'
131 end