Class: Twilio::REST::Serverless::V1::ServiceContext::EnvironmentContext::VariableInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the VariableInstance

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 Variable resource.

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

    The SID of the Call resource to fetch.



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 298

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

    # Context
    @instance_context = nil
    @params = { 'service_sid' => service_sid  || @properties['service_sid']  ,'environment_sid' => environment_sid  || @properties['environment_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 Variable resource.

Returns:



338
339
340
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 338

def 
    @properties['account_sid']
end

#context ⇒ VariableContext

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

Returns:



323
324
325
326
327
328
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 323

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

#date_created ⇒ Time

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

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

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

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the VariableInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



387
388
389
390
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 387

def delete

    context.delete
end

#environment_sid ⇒ String

Returns The SID of the Environment in which the Variable exists.

Returns:

  • (String) —

    The SID of the Environment in which the Variable exists.



350
351
352
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 350

def environment_sid
    @properties['environment_sid']
end

#fetch ⇒ VariableInstance

Fetch the VariableInstance

Returns:



395
396
397
398
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 395

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



425
426
427
428
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 425

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

#key ⇒ String

Returns A string by which the Variable resource can be referenced.

Returns:

  • (String) —

    A string by which the Variable resource can be referenced.



356
357
358
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 356

def key
    @properties['key']
end

#service_sid ⇒ String

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

Returns:

  • (String) —

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



344
345
346
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 344

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

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

Returns:

  • (String) —

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



332
333
334
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 332

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#update(key: :unset, value: :unset) ⇒ VariableInstance

Update the VariableInstance

Parameters:

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

    A string by which the Variable resource can be referenced. It can be a maximum of 128 characters.

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

    A string that contains the actual value of the Variable. It can be a maximum of 450 bytes in size.

Returns:



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

def update(
    key: :unset, 
    value: :unset
)

    context.update(
        key: key, 
        value: value, 
    )
end

#url ⇒ String

Returns The absolute URL of the Variable resource.

Returns:

  • (String) —

    The absolute URL of the Variable resource.



380
381
382
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 380

def url
    @properties['url']
end

#value ⇒ String

Returns A string that contains the actual value of the Variable.

Returns:

  • (String) —

    A string that contains the actual value of the Variable.



362
363
364
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 362

def value
    @properties['value']
end