Class: Twilio::REST::Microvisor::V1::DeviceInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Microvisor::V1::DeviceInstance
- Defined in:
- lib/twilio-ruby/rest/microvisor/v1/device.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The unique SID identifier of the Account.
-
#app ⇒ Hash
Information about the target App and the App reported by this Device.
-
#context ⇒ DeviceContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The date that this Device was created, given in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#date_updated ⇒ Time
The date that this Device was last updated, given in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#device_configs ⇒ device_configs
Access the device_configs.
-
#device_secrets ⇒ device_secrets
Access the device_secrets.
-
#fetch ⇒ DeviceInstance
Fetch the DeviceInstance.
-
#initialize(version, payload, sid: nil) ⇒ DeviceInstance
constructor
Initialize the DeviceInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#links ⇒ Hash
The absolute URLs of related resources.
-
#logging ⇒ Hash
Object specifying whether application logging is enabled for this Device.
-
#sid ⇒ String
A 34-character string that uniquely identifies this Device.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#unique_name ⇒ String
A developer-defined string that uniquely identifies the Device.
-
#update(unique_name: :unset, target_app: :unset, logging_enabled: :unset, restart_app: :unset) ⇒ DeviceInstance
Update the DeviceInstance.
-
#url ⇒ String
The URL of this resource.
Constructor Details
#initialize(version, payload, sid: nil) ⇒ DeviceInstance
Initialize the DeviceInstance
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 |
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 279 def initialize(version, payload , sid: nil) super(version) # Marshaled Properties @properties = { 'sid' => payload['sid'], 'unique_name' => payload['unique_name'], 'account_sid' => payload['account_sid'], 'app' => payload['app'], 'logging' => payload['logging'], '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 = { 'sid' => sid || @properties['sid'] , } end |
Instance Method Details
#account_sid ⇒ String
Returns The unique SID identifier of the Account.
325 326 327 |
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 325 def account_sid @properties['account_sid'] end |
#app ⇒ Hash
Returns Information about the target App and the App reported by this Device. Contains the properties ‘target_sid`, `date_targeted`, `update_status` (one of `up-to-date`, `pending` and `error`), `update_error_code`, `reported_sid` and `date_reported`.
331 332 333 |
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 331 def app @properties['app'] end |
#context ⇒ DeviceContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
304 305 306 307 308 309 |
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 304 def context unless @instance_context @instance_context = DeviceContext.new(@version , @params['sid']) end @instance_context end |
#date_created ⇒ Time
Returns The date that this Device was created, given in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
343 344 345 |
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 343 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The date that this Device was last updated, given in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
349 350 351 |
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 349 def date_updated @properties['date_updated'] end |
#device_configs ⇒ device_configs
Access the device_configs
405 406 407 |
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 405 def device_configs context.device_configs end |
#device_secrets ⇒ device_secrets
Access the device_secrets
398 399 400 |
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 398 def device_secrets context.device_secrets end |
#fetch ⇒ DeviceInstance
Fetch the DeviceInstance
368 369 370 371 |
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 368 def fetch context.fetch end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
418 419 420 421 |
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 418 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Microvisor.V1.DeviceInstance #{values}>" end |
#links ⇒ Hash
Returns The absolute URLs of related resources.
361 362 363 |
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 361 def links @properties['links'] end |
#logging ⇒ Hash
Returns Object specifying whether application logging is enabled for this Device. Contains the properties ‘enabled` and `date_expires`.
337 338 339 |
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 337 def logging @properties['logging'] end |
#sid ⇒ String
Returns A 34-character string that uniquely identifies this Device.
313 314 315 |
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 313 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
411 412 413 414 |
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 411 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Microvisor.V1.DeviceInstance #{values}>" end |
#unique_name ⇒ String
Returns A developer-defined string that uniquely identifies the Device. This value must be unique for all Devices on this Account. The ‘unique_name` value may be used as an alternative to the `sid` in the URL path to address the resource.
319 320 321 |
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 319 def unique_name @properties['unique_name'] end |
#update(unique_name: :unset, target_app: :unset, logging_enabled: :unset, restart_app: :unset) ⇒ DeviceInstance
Update the DeviceInstance
380 381 382 383 384 385 386 387 388 389 390 391 392 393 |
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 380 def update( unique_name: :unset, target_app: :unset, logging_enabled: :unset, restart_app: :unset ) context.update( unique_name: unique_name, target_app: target_app, logging_enabled: logging_enabled, restart_app: restart_app, ) end |
#url ⇒ String
Returns The URL of this resource.
355 356 357 |
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 355 def url @properties['url'] end |