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 unique SID identifier of the Service for this Variable.

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

    The unique SID identifier of the Environment in which this Variable exists.

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

    The unique SID identifier of this Variable.



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 278

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 Account Sid.

Returns:

  • (String) —

    Account Sid.



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

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:



307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 307

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

Returns:

  • (Time) —

    The date that this Variable was created.



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this Variable was updated.

Returns:

  • (Time) —

    The date that this Variable was updated.



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

def date_updated
  @properties['date_updated']
end

#environment_sid ⇒ String

Returns Environment Sid.

Returns:

  • (String) —

    Environment Sid.



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

def environment_sid
  @properties['environment_sid']
end

#fetch ⇒ VariableInstance

Fetch a VariableInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#key ⇒ String

Returns A string by which this Variable can be referenced.

Returns:

  • (String) —

    A string by which this Variable can be referenced.



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

def key
  @properties['key']
end

#service_sid ⇒ String

Returns Service Sid.

Returns:

  • (String) —

    Service Sid.



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns Variable Sid.

Returns:

  • (String) —

    Variable Sid.



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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 this Variable can be referenced, fewer than 128 characters. Optional.

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

    A string that contains the actual value of this Variable, less than 450 bytes. Optional.

Returns:



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

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

#url ⇒ String

Returns The URL of this Variable.

Returns:

  • (String) —

    The URL of this Variable.



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

def url
  @properties['url']
end

#value ⇒ String

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

Returns:

  • (String) —

    A string that contains the actual value of this Variable.



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

def value
  @properties['value']
end