Class: Twilio::REST::Serverless::V1::ServiceContext::FunctionContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/serverless/v1/service/function.rb,
lib/twilio-ruby/rest/serverless/v1/service/function/function_version.rb,
lib/twilio-ruby/rest/serverless/v1/service/function/function_version/function_version_content.rb

Defined Under Namespace

Classes: FunctionVersionContext, FunctionVersionInstance, FunctionVersionInstanceMetadata, FunctionVersionList, FunctionVersionListResponse, FunctionVersionPage, FunctionVersionPageMetadata

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, sid) ⇒ FunctionContext

Initialize the FunctionContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) —

    The SID of the Service to update the Function resource from.

  • sid (String) —

    The SID of the Function resource to update.



228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 228

def initialize(version, service_sid, sid)
    super(version)
    

    # Path Solution
    @solution = { service_sid: service_sid, sid: sid,  }
    @uri = "/Services/#{@solution[:service_sid]}/Functions/#{@solution[:sid]}"

    # Dependents
    @function_versions = nil
end

Instance Method Details

#delete ⇒ Boolean

Delete the FunctionInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



242
243
244
245
246
247
248
249
250
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 242

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    

    @version.delete('DELETE', @uri, headers: headers)
end

#delete_with_metadata ⇒ Boolean

Delete the FunctionInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 255

def delete_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
      response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
      function_instance = FunctionInstance.new(
          @version,
          response.body,
          account_sid: @solution[:account_sid],
          sid: @solution[:sid],
      )
      FunctionInstanceMetadata.new(@version, function_instance, response.headers, response.status_code)
end

#fetch ⇒ FunctionInstance

Fetch the FunctionInstance

Returns:



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 274

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    FunctionInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        sid: @solution[:sid],
    )
end

#fetch_with_metadata ⇒ FunctionInstance

Fetch the FunctionInstanceMetadata

Returns:



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 294

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    function_instance = FunctionInstance.new(
        @version,
        response.body,
        service_sid: @solution[:service_sid],
        sid: @solution[:sid],
    )
    FunctionInstanceMetadata.new(
        @version,
        function_instance,
        response.headers,
        response.status_code
    )
end

#function_versions(sid = :unset) ⇒ FunctionVersionList, FunctionVersionContext

Access the function_versions

Returns:

Raises:

  • (ArgumentError) 


381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 381

def function_versions(sid=:unset)

    raise ArgumentError, 'sid cannot be nil' if sid.nil?

    if sid != :unset
        return FunctionVersionContext.new(@version, @solution[:service_sid], @solution[:sid],sid )
    end

    unless @function_versions
        @function_versions = FunctionVersionList.new(
            @version, service_sid: @solution[:service_sid], function_sid: @solution[:sid], )
    end

 @function_versions
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



406
407
408
409
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 406

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Serverless.V1.FunctionContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



399
400
401
402
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 399

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Serverless.V1.FunctionContext #{context}>"
end

#update(friendly_name: nil) ⇒ FunctionInstance

Update the FunctionInstance

Parameters:

  • friendly_name (String) (defaults to: nil) —

    A descriptive string that you create to describe the Function resource. It can be a maximum of 255 characters.

Returns:



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 321

def update(
  friendly_name: nil
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.update('POST', @uri, data: data, headers: headers)
    FunctionInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        sid: @solution[:sid],
    )
end

#update_with_metadata(friendly_name: nil) ⇒ FunctionInstance

Update the FunctionInstanceMetadata

Parameters:

  • friendly_name (String) (defaults to: nil) —

    A descriptive string that you create to describe the Function resource. It can be a maximum of 255 characters.

Returns:



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 348

def update_with_metadata(
  friendly_name: nil
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
    function_instance = FunctionInstance.new(
        @version,
        response.body,
        service_sid: @solution[:service_sid],
        sid: @solution[:sid],
    )
    FunctionInstanceMetadata.new(
        @version,
        function_instance,
        response.headers,
        response.status_code
    )
end