Class: Twilio::REST::Preview::DeployedDevices::FleetContext::DeploymentInstance

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Preview::DeployedDevices::FleetContext::DeploymentInstance

Defined in:

lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.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 help@twilio.com.

Instance Method Summary

• #account_sid ⇒ String

  The unique SID that identifies this Account.

• #context ⇒ DeploymentContext

  Generate an instance context for the instance, the context is capable of performing various actions.

• #date_created ⇒ Time

  The date this Deployment was created.

• #date_updated ⇒ Time

  The date this Deployment was updated.

• #delete ⇒ Boolean

  Delete the DeploymentInstance.

• #fetch ⇒ DeploymentInstance

  Fetch the DeploymentInstance.

• #fleet_sid ⇒ String

  The unique identifier of the Fleet.

• #friendly_name ⇒ String

  A human readable description for this Deployment.

• #initialize(version, payload, fleet_sid: nil, sid: nil) ⇒ DeploymentInstance constructor

  Initialize the DeploymentInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #sid ⇒ String

  A string that uniquely identifies this Deployment.

• #sync_service_sid ⇒ String

  The unique identifier of the Sync service instance.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #update(friendly_name: :unset, sync_service_sid: :unset) ⇒ DeploymentInstance

  Update the DeploymentInstance.

• #url ⇒ String

  URL of this Deployment.

Constructor Details

#initialize(version, payload, fleet_sid: nil, sid: nil) ⇒ DeploymentInstance

Initialize the DeploymentInstance

# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 242

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

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

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

Instance Method Details

#account_sid ⇒ String

# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 299

def account_sid
  @properties['account_sid']
end

#context ⇒ DeploymentContext

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

# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 266

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

#date_created ⇒ Time

# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 311

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 317

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the DeploymentInstance

# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 331

def delete
  context.delete
end

#fetch ⇒ DeploymentInstance

Fetch the DeploymentInstance

# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 324

def fetch
  context.fetch
end

#fleet_sid ⇒ String

# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 293

def fleet_sid
  @properties['fleet_sid']
end

#friendly_name ⇒ String

# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 287

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 356

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

#sid ⇒ String

# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 275

def sid
  @properties['sid']
end

#sync_service_sid ⇒ String

# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 305

def sync_service_sid
  @properties['sync_service_sid']
end

#to_s ⇒ Object

Provide a user friendly representation

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

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

#update(friendly_name: :unset, sync_service_sid: :unset) ⇒ DeploymentInstance

Update the DeploymentInstance

# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 343

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

#url ⇒ String

# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 281

def url
  @properties['url']
end