Class: Twilio::REST::Microvisor::V1::DeviceContext::DeviceConfigInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/microvisor/v1/device/device_config.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, device_sid: nil, key: nil) ⇒ DeviceConfigInstance

Initialize the DeviceConfigInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    A 34-character string that uniquely identifies the parent Device.

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

    The config key; up to 100 characters.



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb', line 244

def initialize(version, payload, device_sid: nil, key: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'device_sid' => payload['device_sid'],
      'key' => payload['key'],
      'value' => payload['value'],
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'url' => payload['url'],
  }

  # Context
  @instance_context = nil
  @params = {'device_sid' => device_sid, 'key' => key || @properties['key'], }
end

Instance Method Details

#context ⇒ DeviceConfigContext

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

Returns:



265
266
267
268
269
270
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb', line 265

def context
  unless @instance_context
    @instance_context = DeviceConfigContext.new(@version, @params['device_sid'], @params['key'], )
  end
  @instance_context
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



292
293
294
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb', line 292

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the DeviceConfigInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



320
321
322
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb', line 320

def delete
  context.delete
end

#device_sid ⇒ String

Returns A string that uniquely identifies the parent Device.

Returns:

  • (String) —

    A string that uniquely identifies the parent Device.



274
275
276
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb', line 274

def device_sid
  @properties['device_sid']
end

#fetch ⇒ DeviceConfigInstance

Fetch the DeviceConfigInstance

Returns:



305
306
307
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb', line 305

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



333
334
335
336
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb', line 333

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

#key ⇒ String

Returns The config key.

Returns:

  • (String) —

    The config key.



280
281
282
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb', line 280

def key
  @properties['key']
end

#to_s ⇒ Object

Provide a user friendly representation



326
327
328
329
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb', line 326

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

#update(value: nil) ⇒ DeviceConfigInstance

Update the DeviceConfigInstance

Parameters:

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

    The config value; up to 4096 characters.

Returns:



313
314
315
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb', line 313

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

#url ⇒ String

Returns The absolute URL of the Config.

Returns:

  • (String) —

    The absolute URL of the Config.



298
299
300
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb', line 298

def url
  @properties['url']
end

#value ⇒ String

Returns The config value.

Returns:

  • (String) —

    The config value.



286
287
288
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb', line 286

def value
  @properties['value']
end