Class: Twilio::REST::Insights::V3::QueryJobList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/insights/v3/query_job.rb

Defined Under Namespace

Classes: InsightsQueryRequest, QueryDefinition, QueryDefinitionFilters, QueryDefinitionFiltersExpressions, QueryDefinitionOrderBy

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ QueryJobList

Initialize the QueryJobList

Parameters:

  • version (Version) —

    Version that contains the resource



116
117
118
119
120
121
122
123
124
 
# File 'lib/twilio-ruby/rest/insights/v3/query_job.rb', line 116

def initialize(version)
    
    apiV1Version = ApiV1Version.new version.domain, version
    super(apiV1Version)
    # Path Solution
    @solution = {  }
    @uri = "/InsightsDomains/Conversations/QueryJobs"
    
end

Instance Method Details

#create(idempotency_key: :unset, insights_query_request: nil) ⇒ QueryJobInstance

Create the QueryJobInstance

Parameters:

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

    A client-generated UUIDv7 key that ensures idempotent behavior. Submitting the same key with an identical request returns the same operation without re-execution. Scoped to Account + Region. Retained for 24 hours.

  • insights_query_request (InsightsQueryRequest) (defaults to: nil)

Returns:



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/twilio-ruby/rest/insights/v3/query_job.rb', line 130

def create(
  idempotency_key: :unset,
  insights_query_request: nil
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Idempotency-Key' => idempotency_key, })
    headers['Content-Type'] = 'application/json'
    
    
    
    
    payload = @version.create('POST', @uri, headers: headers, data: insights_query_request.to_json)
    QueryJobInstance.new(
        @version,
        payload,
    )
end

#create_with_metadata(idempotency_key: :unset, insights_query_request: nil) ⇒ QueryJobInstance

Create the QueryJobInstanceMetadata

Parameters:

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

    A client-generated UUIDv7 key that ensures idempotent behavior. Submitting the same key with an identical request returns the same operation without re-execution. Scoped to Account + Region. Retained for 24 hours.

  • insights_query_request (InsightsQueryRequest) (defaults to: nil)

Returns:



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/twilio-ruby/rest/insights/v3/query_job.rb', line 153

def create_with_metadata(
  idempotency_key: :unset,
insights_query_request: nil
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Idempotency-Key' => idempotency_key, })
    headers['Content-Type'] = 'application/json'
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, headers: headers, data: insights_query_request.to_json)
    query_job_instance = QueryJobInstance.new(
        @version,
        response.body,
    )
    QueryJobInstanceMetadata.new(
        @version,
        query_job_instance,
        response.headers,
        response.status_code
    )
end

#each ⇒ Object

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



258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/twilio-ruby/rest/insights/v3/query_job.rb', line 258

def each
    limits = @version.read_limits

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

    return [].each if page.nil?

    result = @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit])
    return [].each if result.nil?
    result.each {|x| yield x}
end

#get_page(target_url) ⇒ Page

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of QueryJobInstance



299
300
301
302
303
304
305
 
# File 'lib/twilio-ruby/rest/insights/v3/query_job.rb', line 299

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

#list(page_token: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Array

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

Parameters:

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

    Token for pagination

  • status (LongRunningOperationStatus) (defaults to: :unset) —

    The operation status to filter results by.

  • 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:

  • (Array) —

    Array of up to limit results



191
192
193
194
195
196
197
198
 
# File 'lib/twilio-ruby/rest/insights/v3/query_job.rb', line 191

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

#list_with_metadata(page_token: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Array

Returns Array of up to limit results.

Parameters:

  • 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:

  • (Array) —

    Array of up to limit results



239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/twilio-ruby/rest/insights/v3/query_job.rb', line 239

def list_with_metadata(page_token: :unset, status: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'pageToken' => page_token,
        'status' => status,
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

    response = @version.page('GET', @uri, params: params, headers: headers)

    QueryJobPageMetadata.new(@version, response, @solution, limits[:limit])
end

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

Returns Page of QueryJobInstance.

Returns:

  • (Page) —

    Page of QueryJobInstance



279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/twilio-ruby/rest/insights/v3/query_job.rb', line 279

def page(page_token: :unset, status: :unset, page_size: :unset)
    params = Twilio::Values.of({
        'pageToken' => page_token,
        'status' => status,
                                    'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

    response = @version.page('GET', @uri, params: params, headers: headers)

    QueryJobPage.new(@version, response, @solution)
end

#stream(page_token: :unset, status: :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:

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

    Token for pagination

  • status (LongRunningOperationStatus) (defaults to: :unset) —

    The operation status to filter results by.

  • 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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/twilio-ruby/rest/insights/v3/query_job.rb', line 213

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

    page = self.page(
        page_token: page_token,
        status: status,
        page_size: limits[:page_size], )

    return [].each if page.nil?

    result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
    return [].each if result.nil?
    result
end

#to_s ⇒ Object

Provide a user friendly representation



310
311
312
 
# File 'lib/twilio-ruby/rest/insights/v3/query_job.rb', line 310

def to_s
    '#<Twilio.Insights.V3.QueryJobList>'
end