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

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, 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

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

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

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

    The SID of the environment in which the variable exists.

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

    The SID of the Variable resource to fetch.



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 285

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

Instance Method Details

#account_sid ⇒ String

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

Returns:

  • (String) —

    The SID of the Account that created the Variable resource



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

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:



314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 314

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 ISO 8601 date and time in GMT when the Variable resource was created.

Returns:

  • (Time) —

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



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

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

Returns:

  • (Time) —

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the VariableInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



401
402
403
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 401

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



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

def environment_sid
  @properties['environment_sid']
end

#fetch ⇒ VariableInstance

Fetch a VariableInstance

Returns:



383
384
385
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 383

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



414
415
416
417
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 414

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



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

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



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that identifies the Variable resource.

Returns:

  • (String) —

    The unique string that identifies the Variable resource



328
329
330
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 328

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



407
408
409
410
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 407

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. Must be less than 128 characters long.

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

    A string that contains the actual value of the variable. Must have less than 450 bytes.

Returns:



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

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



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

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



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

def value
  @properties['value']
end