Class: Twilio::REST::Serverless::V1::ServiceContext::FunctionInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, sid: nil) ⇒ FunctionInstance

Initialize the FunctionInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Function resource.

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

    The SID of the Call resource to fetch.



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 307

def initialize(version, payload , service_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'service_sid' => payload['service_sid'],
        'friendly_name' => payload['friendly_name'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'url' => payload['url'],
        'links' => payload['links'],
    }

    # Context
    @instance_context = nil
    @params = { 'service_sid' => service_sid  || @properties['service_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Function resource.

Returns:



346
347
348
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 346

def 
    @properties['account_sid']
end

#context ⇒ FunctionContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



331
332
333
334
335
336
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 331

def context
    unless @instance_context
        @instance_context = FunctionContext.new(@version , @params['service_sid'], @params['sid'])
    end
    @instance_context
end

#date_created ⇒ Time

Returns The date and time in GMT when the Function resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



364
365
366
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 364

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the Function resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



370
371
372
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 370

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the FunctionInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



389
390
391
392
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 389

def delete

    context.delete
end

#fetch ⇒ FunctionInstance

Fetch the FunctionInstance

Returns:



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

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the Function resource. It can be a maximum of 255 characters.

Returns:

  • (String) —

    The string that you assigned to describe the Function resource. It can be a maximum of 255 characters.



358
359
360
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 358

def friendly_name
    @properties['friendly_name']
end

#function_versions ⇒ function_versions

Access the function_versions

Returns:



418
419
420
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 418

def function_versions
    context.function_versions
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



431
432
433
434
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 431

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Serverless.V1.FunctionInstance #{values}>"
end

#links ⇒ Hash

Returns The URLs of nested resources of the Function resource.

Returns:

  • (Hash) —

    The URLs of nested resources of the Function resource.



382
383
384
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 382

def links
    @properties['links']
end

#service_sid ⇒ String

Returns The SID of the Service that the Function resource is associated with.

Returns:

  • (String) —

    The SID of the Service that the Function resource is associated with.



352
353
354
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 352

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that we created to identify the Function resource.

Returns:

  • (String) —

    The unique string that we created to identify the Function resource.



340
341
342
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 340

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



424
425
426
427
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 424

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Serverless.V1.FunctionInstance #{values}>"
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:



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

def update(
    friendly_name: nil
)

    context.update(
        friendly_name: friendly_name, 
    )
end

#url ⇒ String

Returns The absolute URL of the Function resource.

Returns:

  • (String) —

    The absolute URL of the Function resource.



376
377
378
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 376

def url
    @properties['url']
end