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.



20381
20382
20383
20384
20385
20386
20387
20388
20389
20390
20391
20392
20393
20394
20395
 
# File 'lib/ovirtsdk4/types.rb', line 20381

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.



20400
20401
20402
20403
20404
20405
20406
20407
20408
20409
20410
20411
20412
20413
20414
 
# File 'lib/ovirtsdk4/types.rb', line 20400

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

#comment ⇒ String

Returns the value of the comment attribute.

Returns:

  • (String) 


20029
20030
20031
 
# File 'lib/ovirtsdk4/types.rb', line 20029

def comment
  @comment
end

#comment=(value) ⇒ Object

Sets the value of the comment attribute.

Parameters:

  • value (String) 


20038
20039
20040
 
# File 'lib/ovirtsdk4/types.rb', line 20038

def comment=(value)
  @comment = value
end

#description ⇒ String

Returns the value of the description attribute.

Returns:

  • (String) 


20047
20048
20049
 
# File 'lib/ovirtsdk4/types.rb', line 20047

def description
  @description
end

#description=(value) ⇒ Object

Sets the value of the description attribute.

Parameters:

  • value (String) 


20056
20057
20058
 
# File 'lib/ovirtsdk4/types.rb', line 20056

def description=(value)
  @description = value
end

#end_time ⇒ DateTime

Returns the value of the end_time attribute.

Returns:

  • (DateTime) 


20065
20066
20067
 
# File 'lib/ovirtsdk4/types.rb', line 20065

def end_time
  @end_time
end

#end_time=(value) ⇒ Object

Sets the value of the end_time attribute.

Parameters:

  • value (DateTime) 


20074
20075
20076
 
# File 'lib/ovirtsdk4/types.rb', line 20074

def end_time=(value)
  @end_time = value
end

#execution_host ⇒ Host

Returns the value of the execution_host attribute.

Returns:



20083
20084
20085
 
# File 'lib/ovirtsdk4/types.rb', line 20083

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) 


20096
20097
20098
20099
20100
20101
 
# File 'lib/ovirtsdk4/types.rb', line 20096

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

#external ⇒ Boolean

Returns the value of the external attribute.

Returns:

  • (Boolean) 


20108
20109
20110
 
# File 'lib/ovirtsdk4/types.rb', line 20108

def external
  @external
end

#external=(value) ⇒ Object

Sets the value of the external attribute.

Parameters:

  • value (Boolean) 


20117
20118
20119
 
# File 'lib/ovirtsdk4/types.rb', line 20117

def external=(value)
  @external = value
end

#external_type ⇒ ExternalSystemType

Returns the value of the external_type attribute.

Returns:



20126
20127
20128
 
# File 'lib/ovirtsdk4/types.rb', line 20126

def external_type
  @external_type
end

#external_type=(value) ⇒ Object

Sets the value of the external_type attribute.

Parameters:



20135
20136
20137
 
# File 'lib/ovirtsdk4/types.rb', line 20135

def external_type=(value)
  @external_type = value
end

#hash ⇒ Object

Generates a hash value for this object.



20419
20420
20421
20422
20423
20424
20425
20426
20427
20428
20429
20430
20431
20432
20433
 
# File 'lib/ovirtsdk4/types.rb', line 20419

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

#id ⇒ String

Returns the value of the id attribute.

Returns:

  • (String) 


20144
20145
20146
 
# File 'lib/ovirtsdk4/types.rb', line 20144

def id
  @id
end

#id=(value) ⇒ Object

Sets the value of the id attribute.

Parameters:

  • value (String) 


20153
20154
20155
 
# File 'lib/ovirtsdk4/types.rb', line 20153

def id=(value)
  @id = value
end

#job ⇒ Job

Returns the value of the job attribute.

Returns:



20162
20163
20164
 
# File 'lib/ovirtsdk4/types.rb', line 20162

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) 


20175
20176
20177
20178
20179
20180
 
# File 'lib/ovirtsdk4/types.rb', line 20175

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

#name ⇒ String

Returns the value of the name attribute.

Returns:

  • (String) 


20187
20188
20189
 
# File 'lib/ovirtsdk4/types.rb', line 20187

def name
  @name
end

#name=(value) ⇒ Object

Sets the value of the name attribute.

Parameters:

  • value (String) 


20196
20197
20198
 
# File 'lib/ovirtsdk4/types.rb', line 20196

def name=(value)
  @name = value
end

#number ⇒ Integer

Returns the value of the number attribute.

Returns:

  • (Integer) 


20205
20206
20207
 
# File 'lib/ovirtsdk4/types.rb', line 20205

def number
  @number
end

#number=(value) ⇒ Object

Sets the value of the number attribute.

Parameters:

  • value (Integer) 


20214
20215
20216
 
# File 'lib/ovirtsdk4/types.rb', line 20214

def number=(value)
  @number = value
end

#parent_step ⇒ Step

Returns the value of the parent_step attribute.

Returns:



20223
20224
20225
 
# File 'lib/ovirtsdk4/types.rb', line 20223

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) 


20236
20237
20238
20239
20240
20241
 
# File 'lib/ovirtsdk4/types.rb', line 20236

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

#progress ⇒ Integer

Returns the value of the progress attribute.

Returns:

  • (Integer) 


20248
20249
20250
 
# File 'lib/ovirtsdk4/types.rb', line 20248

def progress
  @progress
end

#progress=(value) ⇒ Object

Sets the value of the progress attribute.

Parameters:

  • value (Integer) 


20257
20258
20259
 
# File 'lib/ovirtsdk4/types.rb', line 20257

def progress=(value)
  @progress = value
end

#start_time ⇒ DateTime

Returns the value of the start_time attribute.

Returns:

  • (DateTime) 


20266
20267
20268
 
# File 'lib/ovirtsdk4/types.rb', line 20266

def start_time
  @start_time
end

#start_time=(value) ⇒ Object

Sets the value of the start_time attribute.

Parameters:

  • value (DateTime) 


20275
20276
20277
 
# File 'lib/ovirtsdk4/types.rb', line 20275

def start_time=(value)
  @start_time = value
end

#statistics ⇒ Array<Statistic>

Returns the value of the statistics attribute.

Returns:



20284
20285
20286
 
# File 'lib/ovirtsdk4/types.rb', line 20284

def statistics
  @statistics
end

#statistics=(list) ⇒ Object

Sets the value of the statistics attribute.

Parameters:



20293
20294
20295
20296
20297
20298
20299
20300
20301
20302
20303
 
# File 'lib/ovirtsdk4/types.rb', line 20293

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

#status ⇒ StepStatus

Returns the value of the status attribute.

Returns:



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

def status
  @status
end

#status=(value) ⇒ Object

Sets the value of the status attribute.

Parameters:



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

def status=(value)
  @status = value
end

#type ⇒ StepEnum

Returns the value of the type attribute.

Returns:



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

def type
  @type
end

#type=(value) ⇒ Object

Sets the value of the type attribute.

Parameters:



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

def type=(value)
  @type = value
end