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

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

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

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

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

    The unique SID identifier of the Service for this Function.

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

    The unique SID identifier of this Function.



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

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, 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

Returns Account Sid.

Returns:

  • (String) —

    Account Sid.



309
310
311
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 309

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:



294
295
296
297
298
299
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 294

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 that this Function was created.

Returns:

  • (Time) —

    The date that this Function was created.



327
328
329
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 327

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this Function was updated.

Returns:

  • (Time) —

    The date that this Function was updated.



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

def date_updated
  @properties['date_updated']
end

#fetch ⇒ FunctionInstance

Fetch a FunctionInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns A human-readable description of this Function.

Returns:

  • (String) —

    A human-readable description of this Function.



321
322
323
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 321

def friendly_name
  @properties['friendly_name']
end

#function_versions ⇒ function_versions

Access the function_versions

Returns:



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

def function_versions
  context.function_versions
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ String

Returns Nested resource URLs.

Returns:

  • (String) —

    Nested resource URLs.



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

def links
  @properties['links']
end

#service_sid ⇒ String

Returns Service Sid.

Returns:

  • (String) —

    Service Sid.



315
316
317
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 315

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns Function Sid.

Returns:

  • (String) —

    Function Sid.



303
304
305
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 303

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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 human-readable description of this Function, fewer than 256 characters. Required.

Returns:



361
362
363
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 361

def update(friendly_name: nil)
  context.update(friendly_name: friendly_name, )
end

#url ⇒ String

Returns The URL of this Function.

Returns:

  • (String) —

    The URL of this Function.



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

def url
  @properties['url']
end