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 beta products that are subject to change. Use them with caution.

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 SID of the Service that the Function resource is associated with.

  • sid (String) (defaults to: nil)

    The SID of the Function resource to fetch.


260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 260

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_sidString

Returns The SID of the Account that created the Function resource.

Returns:

  • (String)

    The SID of the Account that created the Function resource


299
300
301
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 299

def 
  @properties['account_sid']
end

#contextFunctionContext

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

Returns:


284
285
286
287
288
289
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 284

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

#date_createdTime

Returns The ISO 8601 date and time in GMT when the Function resource was created.

Returns:

  • (Time)

    The ISO 8601 date and time in GMT when the Function resource was created


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

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The ISO 8601 date and time in GMT when the Function resource was last updated.

Returns:

  • (Time)

    The ISO 8601 date and time in GMT when the Function resource was last updated


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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the FunctionInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


349
350
351
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 349

def delete
  context.delete
end

#fetchFunctionInstance

Fetch the FunctionInstance

Returns:


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

def fetch
  context.fetch
end

#friendly_nameString

Returns The string that you assigned to describe the Function resource.

Returns:

  • (String)

    The string that you assigned to describe the Function resource


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

def friendly_name
  @properties['friendly_name']
end

#function_versionsfunction_versions

Access the function_versions

Returns:


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

def function_versions
  context.function_versions
end

#inspectObject

Provide a detailed, user friendly representation


378
379
380
381
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 378

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

Returns The URLs of nested resources of the Function resource.

Returns:

  • (String)

    The URLs of nested resources of the Function resource


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

def links
  @properties['links']
end

#service_sidString

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


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

def service_sid
  @properties['service_sid']
end

#sidString

Returns The unique string that identifies the Function resource.

Returns:

  • (String)

    The unique string that identifies the Function resource


293
294
295
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 293

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


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

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:


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

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

#urlString

Returns The absolute URL of the Function resource.

Returns:

  • (String)

    The absolute URL of the Function resource


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

def url
  @properties['url']
end