Class: OvirtSDK4::Step

Inherits:
Identified show all
Defined in:
lib/ovirtsdk4/types.rb,
lib/ovirtsdk4/types.rb

Instance Method Summary collapse

Methods included from Type

#dig, #href, #href=

Constructor Details

#initialize(opts = {}) ⇒ Step

Creates a new instance of the OvirtSDK4::Step class.

Parameters:

  • opts (Hash) (defaults to: {})

    A hash containing the attributes of the object. The keys of the hash should be symbols corresponding to the names of the attributes. The values of the hash should be the values of the attributes.

Options Hash (opts):

  • :comment (String)

    The value of attribute comment.

  • :description (String)

    The value of attribute description.

  • :end_time (DateTime)

    The value of attribute end_time.

  • :execution_host (Host, Hash)

    The value of attribute execution_host.

  • :external (Boolean)

    The value of attribute external.

  • :external_type (ExternalSystemType)

    The value of attribute external_type.

  • :id (String)

    The value of attribute id.

  • :job (Job, Hash)

    The value of attribute job.

  • :name (String)

    The value of attribute name.

  • :number (Integer)

    The value of attribute number.

  • :parent_step (Step, Hash)

    The value of attribute parent_step.

  • :progress (Integer)

    The value of attribute progress.

  • :start_time (DateTime)

    The value of attribute start_time.

  • :statistics (Array<Statistic>, Array<Hash>)

    The values of attribute statistics.

  • :status (StepStatus)

    The value of attribute status.

  • :type (StepEnum)

    The value of attribute type.


20661
20662
20663
20664
20665
20666
20667
20668
20669
20670
20671
20672
20673
20674
20675
# File 'lib/ovirtsdk4/types.rb', line 20661

def initialize(opts = {})
  super(opts)
  self.end_time = opts[:end_time]
  self.execution_host = opts[:execution_host]
  self.external = opts[:external]
  self.external_type = opts[:external_type]
  self.job = opts[:job]
  self.number = opts[:number]
  self.parent_step = opts[:parent_step]
  self.progress = opts[:progress]
  self.start_time = opts[:start_time]
  self.statistics = opts[:statistics]
  self.status = opts[:status]
  self.type = opts[:type]
end

Instance Method Details

#==(other) ⇒ Object

Returns true if self and other have the same attributes and values.


20680
20681
20682
20683
20684
20685
20686
20687
20688
20689
20690
20691
20692
20693
20694
# File 'lib/ovirtsdk4/types.rb', line 20680

def ==(other)
  super &&
  @end_time == other.end_time &&
  @execution_host == other.execution_host &&
  @external == other.external &&
  @external_type == other.external_type &&
  @job == other.job &&
  @number == other.number &&
  @parent_step == other.parent_step &&
  @progress == other.progress &&
  @start_time == other.start_time &&
  @statistics == other.statistics &&
  @status == other.status &&
  @type == other.type
end

#commentString

Returns the value of the comment attribute.

Returns:

  • (String)

20309
20310
20311
# File 'lib/ovirtsdk4/types.rb', line 20309

def comment
  @comment
end

#comment=(value) ⇒ Object

Sets the value of the comment attribute.

Parameters:

  • value (String)

20318
20319
20320
# File 'lib/ovirtsdk4/types.rb', line 20318

def comment=(value)
  @comment = value
end

#descriptionString

Returns the value of the description attribute.

Returns:

  • (String)

20327
20328
20329
# File 'lib/ovirtsdk4/types.rb', line 20327

def description
  @description
end

#description=(value) ⇒ Object

Sets the value of the description attribute.

Parameters:

  • value (String)

20336
20337
20338
# File 'lib/ovirtsdk4/types.rb', line 20336

def description=(value)
  @description = value
end

#end_timeDateTime

Returns the value of the end_time attribute.

Returns:

  • (DateTime)

20345
20346
20347
# File 'lib/ovirtsdk4/types.rb', line 20345

def end_time
  @end_time
end

#end_time=(value) ⇒ Object

Sets the value of the end_time attribute.

Parameters:

  • value (DateTime)

20354
20355
20356
# File 'lib/ovirtsdk4/types.rb', line 20354

def end_time=(value)
  @end_time = value
end

#execution_hostHost

Returns the value of the execution_host attribute.

Returns:


20363
20364
20365
# File 'lib/ovirtsdk4/types.rb', line 20363

def execution_host
  @execution_host
end

#execution_host=(value) ⇒ Object

Sets the value of the execution_host attribute.

The value parameter can be an instance of Host or a hash. If it is a hash then a new instance will be created passing the hash as the opts parameter to the constructor.

Parameters:

  • value (Host, Hash)

20376
20377
20378
20379
20380
20381
# File 'lib/ovirtsdk4/types.rb', line 20376

def execution_host=(value)
  if value.is_a?(Hash)
    value = Host.new(value)
  end
  @execution_host = value
end

#externalBoolean

Returns the value of the external attribute.

Returns:

  • (Boolean)

20388
20389
20390
# File 'lib/ovirtsdk4/types.rb', line 20388

def external
  @external
end

#external=(value) ⇒ Object

Sets the value of the external attribute.

Parameters:

  • value (Boolean)

20397
20398
20399
# File 'lib/ovirtsdk4/types.rb', line 20397

def external=(value)
  @external = value
end

#external_typeExternalSystemType

Returns the value of the external_type attribute.

Returns:


20406
20407
20408
# File 'lib/ovirtsdk4/types.rb', line 20406

def external_type
  @external_type
end

#external_type=(value) ⇒ Object

Sets the value of the external_type attribute.

Parameters:


20415
20416
20417
# File 'lib/ovirtsdk4/types.rb', line 20415

def external_type=(value)
  @external_type = value
end

#hashObject

Generates a hash value for this object.


20699
20700
20701
20702
20703
20704
20705
20706
20707
20708
20709
20710
20711
20712
20713
# File 'lib/ovirtsdk4/types.rb', line 20699

def hash
  super +
  @end_time.hash +
  @execution_host.hash +
  @external.hash +
  @external_type.hash +
  @job.hash +
  @number.hash +
  @parent_step.hash +
  @progress.hash +
  @start_time.hash +
  @statistics.hash +
  @status.hash +
  @type.hash
end

#idString

Returns the value of the id attribute.

Returns:

  • (String)

20424
20425
20426
# File 'lib/ovirtsdk4/types.rb', line 20424

def id
  @id
end

#id=(value) ⇒ Object

Sets the value of the id attribute.

Parameters:

  • value (String)

20433
20434
20435
# File 'lib/ovirtsdk4/types.rb', line 20433

def id=(value)
  @id = value
end

#jobJob

Returns the value of the job attribute.

Returns:


20442
20443
20444
# File 'lib/ovirtsdk4/types.rb', line 20442

def job
  @job
end

#job=(value) ⇒ Object

Sets the value of the job attribute.

The value parameter can be an instance of Job or a hash. If it is a hash then a new instance will be created passing the hash as the opts parameter to the constructor.

Parameters:

  • value (Job, Hash)

20455
20456
20457
20458
20459
20460
# File 'lib/ovirtsdk4/types.rb', line 20455

def job=(value)
  if value.is_a?(Hash)
    value = Job.new(value)
  end
  @job = value
end

#nameString

Returns the value of the name attribute.

Returns:

  • (String)

20467
20468
20469
# File 'lib/ovirtsdk4/types.rb', line 20467

def name
  @name
end

#name=(value) ⇒ Object

Sets the value of the name attribute.

Parameters:

  • value (String)

20476
20477
20478
# File 'lib/ovirtsdk4/types.rb', line 20476

def name=(value)
  @name = value
end

#numberInteger

Returns the value of the number attribute.

Returns:

  • (Integer)

20485
20486
20487
# File 'lib/ovirtsdk4/types.rb', line 20485

def number
  @number
end

#number=(value) ⇒ Object

Sets the value of the number attribute.

Parameters:

  • value (Integer)

20494
20495
20496
# File 'lib/ovirtsdk4/types.rb', line 20494

def number=(value)
  @number = value
end

#parent_stepStep

Returns the value of the parent_step attribute.

Returns:


20503
20504
20505
# File 'lib/ovirtsdk4/types.rb', line 20503

def parent_step
  @parent_step
end

#parent_step=(value) ⇒ Object

Sets the value of the parent_step attribute.

The value parameter can be an instance of OvirtSDK4::Step or a hash. If it is a hash then a new instance will be created passing the hash as the opts parameter to the constructor.

Parameters:

  • value (Step, Hash)

20516
20517
20518
20519
20520
20521
# File 'lib/ovirtsdk4/types.rb', line 20516

def parent_step=(value)
  if value.is_a?(Hash)
    value = Step.new(value)
  end
  @parent_step = value
end

#progressInteger

Returns the value of the progress attribute.

Returns:

  • (Integer)

20528
20529
20530
# File 'lib/ovirtsdk4/types.rb', line 20528

def progress
  @progress
end

#progress=(value) ⇒ Object

Sets the value of the progress attribute.

Parameters:

  • value (Integer)

20537
20538
20539
# File 'lib/ovirtsdk4/types.rb', line 20537

def progress=(value)
  @progress = value
end

#start_timeDateTime

Returns the value of the start_time attribute.

Returns:

  • (DateTime)

20546
20547
20548
# File 'lib/ovirtsdk4/types.rb', line 20546

def start_time
  @start_time
end

#start_time=(value) ⇒ Object

Sets the value of the start_time attribute.

Parameters:

  • value (DateTime)

20555
20556
20557
# File 'lib/ovirtsdk4/types.rb', line 20555

def start_time=(value)
  @start_time = value
end

#statisticsArray<Statistic>

Returns the value of the statistics attribute.

Returns:


20564
20565
20566
# File 'lib/ovirtsdk4/types.rb', line 20564

def statistics
  @statistics
end

#statistics=(list) ⇒ Object

Sets the value of the statistics attribute.

Parameters:


20573
20574
20575
20576
20577
20578
20579
20580
20581
20582
20583
# File 'lib/ovirtsdk4/types.rb', line 20573

def statistics=(list)
  if list.class == Array
    list = List.new(list)
    list.each_with_index do |value, index|
      if value.is_a?(Hash)
        list[index] = Statistic.new(value)
      end
    end
  end
  @statistics = list
end

#statusStepStatus

Returns the value of the status attribute.

Returns:


20590
20591
20592
# File 'lib/ovirtsdk4/types.rb', line 20590

def status
  @status
end

#status=(value) ⇒ Object

Sets the value of the status attribute.

Parameters:


20599
20600
20601
# File 'lib/ovirtsdk4/types.rb', line 20599

def status=(value)
  @status = value
end

#typeStepEnum

Returns the value of the type attribute.

Returns:


20608
20609
20610
# File 'lib/ovirtsdk4/types.rb', line 20608

def type
  @type
end

#type=(value) ⇒ Object

Sets the value of the type attribute.

Parameters:


20617
20618
20619
# File 'lib/ovirtsdk4/types.rb', line 20617

def type=(value)
  @type = value
end