class Twilio::REST::Studio::V2::FlowContext::ExecutionContext::ExecutionStepList

Public Class Methods

new(version, flow_sid: nil, execution_sid: nil) click to toggle source

Initialize the ExecutionStepList @param [Version] version Version that contains the resource @param [String] flow_sid The SID of the Flow. @param [String] execution_sid The SID of the Step's Execution resource. @return [ExecutionStepList] ExecutionStepList

Calls superclass method Twilio::REST::ListResource::new
   # File lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb
22 def initialize(version, flow_sid: nil, execution_sid: nil)
23   super(version)
24 
25   # Path Solution
26   @solution = {flow_sid: flow_sid, execution_sid: execution_sid}
27   @uri = "/Flows/#{@solution[:flow_sid]}/Executions/#{@solution[:execution_sid]}/Steps"
28 end

Public Instance Methods

each() { |x| ... } click to toggle source

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

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

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

    # File lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb
102 def get_page(target_url)
103   response = @version.domain.request(
104       'GET',
105       target_url
106   )
107   ExecutionStepPage.new(@version, response, @solution)
108 end
list(limit: nil, page_size: nil) click to toggle source

Lists ExecutionStepInstance 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/studio/v2/flow/execution/execution_step.rb
41 def list(limit: nil, page_size: nil)
42   self.stream(limit: limit, page_size: page_size).entries
43 end
page(page_token: :unset, page_number: :unset, page_size: :unset) click to toggle source

Retrieve a single page of ExecutionStepInstance 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 ExecutionStepInstance

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

Streams ExecutionStepInstance 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/studio/v2/flow/execution/execution_step.rb
56 def stream(limit: nil, page_size: nil)
57   limits = @version.read_limits(limit, page_size)
58 
59   page = self.page(page_size: limits[:page_size], )
60 
61   @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
62 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb
112 def to_s
113   '#<Twilio.Studio.V2.ExecutionStepList>'
114 end