Class: Twilio::REST::Preview::DeployedDevices::FleetInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/preview/deployed_devices/fleet.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, sid: nil) ⇒ FleetInstance

Initialize the FleetInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    Provides a 34 character string that uniquely identifies the requested Fleet resource.


313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 313

def initialize(version, payload, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'url' => payload['url'],
      'unique_name' => payload['unique_name'],
      'friendly_name' => payload['friendly_name'],
      'account_sid' => payload['account_sid'],
      'default_deployment_sid' => payload['default_deployment_sid'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'links' => payload['links'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The unique SID that identifies this Account.

Returns:

  • (String) —

    The unique SID that identifies this Account.


371
372
373
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 371

def 
  @properties['account_sid']
end

#certificates ⇒ certificates

Access the certificates

Returns:


441
442
443
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 441

def certificates
  context.certificates
end

#context ⇒ FleetContext

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

Returns:


338
339
340
341
342
343
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 338

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

#date_created ⇒ Time

Returns The date this Fleet was created.

Returns:

  • (Time) —

    The date this Fleet was created.


383
384
385
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 383

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this Fleet was updated.

Returns:

  • (Time) —

    The date this Fleet was updated.


389
390
391
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 389

def date_updated
  @properties['date_updated']
end

#default_deployment_sid ⇒ String

Returns The unique SID that identifies this Fleet's default Deployment.

Returns:

  • (String) —

    The unique SID that identifies this Fleet's default Deployment.


377
378
379
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 377

def default_deployment_sid
  @properties['default_deployment_sid']
end

#delete ⇒ Boolean

Delete the FleetInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


409
410
411
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 409

def delete
  context.delete
end

#deployments ⇒ deployments

Access the deployments

Returns:


434
435
436
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 434

def deployments
  context.deployments
end

#devices ⇒ devices

Access the devices

Returns:


427
428
429
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 427

def devices
  context.devices
end

#fetch ⇒ FleetInstance

Fetch the FleetInstance

Returns:


402
403
404
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 402

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns A human readable description for this Fleet.

Returns:

  • (String) —

    A human readable description for this Fleet.


365
366
367
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 365

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


461
462
463
464
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 461

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

#keys ⇒ keys

Access the keys

Returns:


448
449
450
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 448

def keys
  context.keys
end

#links ⇒ String

Returns Nested resource URLs.

Returns:

  • (String) —

    Nested resource URLs.


395
396
397
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 395

def links
  @properties['links']
end

#sid ⇒ String

Returns A string that uniquely identifies this Fleet.

Returns:

  • (String) —

    A string that uniquely identifies this Fleet.


347
348
349
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 347

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation


454
455
456
457
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 454

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

#unique_name ⇒ String

Returns A unique, addressable name of this Fleet.

Returns:

  • (String) —

    A unique, addressable name of this Fleet.


359
360
361
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 359

def unique_name
  @properties['unique_name']
end

#update(friendly_name: :unset, default_deployment_sid: :unset) ⇒ FleetInstance

Update the FleetInstance

Parameters:

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

    Provides a human readable descriptive text for this Fleet, up to 256 characters long.

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

    Provides a string identifier of a Deployment that is going to be used as a default one for this Fleet.

Returns:


420
421
422
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 420

def update(friendly_name: :unset, default_deployment_sid: :unset)
  context.update(friendly_name: friendly_name, default_deployment_sid: default_deployment_sid, )
end

#url ⇒ String

Returns URL of this Fleet.

Returns:

  • (String) —

    URL of this Fleet.


353
354
355
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 353

def url
  @properties['url']
end