Method: Twilio::REST::Intelligence::V2::CustomOperatorList#stream

Defined in:
lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb

#stream(availability: :unset, language_code: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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

Parameters:

  • availability (Availability) (defaults to: :unset) —

    Returns Custom Operators with the provided availability type. Possible values: internal, beta, public, retired.

  • language_code (String) (defaults to: :unset) —

    Returns Custom Operators that support the provided language code.

  • 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



100
101
102
103
104
105
106
107
108
109
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 100

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

    page = self.page(
        availability: availability,
        language_code: language_code,
        page_size: limits[:page_size], )

    @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end