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.



20279
20280
20281
20282
20283
20284
20285
20286
20287
20288
20289
20290
20291
20292
20293
 
# File 'lib/ovirtsdk4/types.rb', line 20279

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.



20298
20299
20300
20301
20302
20303
20304
20305
20306
20307
20308
20309
20310
20311
20312
 
# File 'lib/ovirtsdk4/types.rb', line 20298

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) 


19927
19928
19929
 
# File 'lib/ovirtsdk4/types.rb', line 19927

def comment
  @comment
end

#comment=(value) ⇒ Object

Sets the value of the comment attribute.

Parameters:

  • value (String) 


19936
19937
19938
 
# File 'lib/ovirtsdk4/types.rb', line 19936

def comment=(value)
  @comment = value
end

#description ⇒ String

Returns the value of the description attribute.

Returns:

  • (String) 


19945
19946
19947
 
# File 'lib/ovirtsdk4/types.rb', line 19945

def description
  @description
end

#description=(value) ⇒ Object

Sets the value of the description attribute.

Parameters:

  • value (String) 


19954
19955
19956
 
# File 'lib/ovirtsdk4/types.rb', line 19954

def description=(value)
  @description = value
end

#end_time ⇒ DateTime

Returns the value of the end_time attribute.

Returns:

  • (DateTime) 


19963
19964
19965
 
# File 'lib/ovirtsdk4/types.rb', line 19963

def end_time
  @end_time
end

#end_time=(value) ⇒ Object

Sets the value of the end_time attribute.

Parameters:

  • value (DateTime) 


19972
19973
19974
 
# File 'lib/ovirtsdk4/types.rb', line 19972

def end_time=(value)
  @end_time = value
end

#execution_host ⇒ Host

Returns the value of the execution_host attribute.

Returns:



19981
19982
19983
 
# File 'lib/ovirtsdk4/types.rb', line 19981

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) 


19994
19995
19996
19997
19998
19999
 
# File 'lib/ovirtsdk4/types.rb', line 19994

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) 


20006
20007
20008
 
# File 'lib/ovirtsdk4/types.rb', line 20006

def external
  @external
end

#external=(value) ⇒ Object

Sets the value of the external attribute.

Parameters:

  • value (Boolean) 


20015
20016
20017
 
# File 'lib/ovirtsdk4/types.rb', line 20015

def external=(value)
  @external = value
end

#external_type ⇒ ExternalSystemType

Returns the value of the external_type attribute.

Returns:



20024
20025
20026
 
# File 'lib/ovirtsdk4/types.rb', line 20024

def external_type
  @external_type
end

#external_type=(value) ⇒ Object

Sets the value of the external_type attribute.

Parameters:



20033
20034
20035
 
# File 'lib/ovirtsdk4/types.rb', line 20033

def external_type=(value)
  @external_type = value
end

#hash ⇒ Object

Generates a hash value for this object.



20317
20318
20319
20320
20321
20322
20323
20324
20325
20326
20327
20328
20329
20330
20331
 
# File 'lib/ovirtsdk4/types.rb', line 20317

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) 


20042
20043
20044
 
# File 'lib/ovirtsdk4/types.rb', line 20042

def id
  @id
end

#id=(value) ⇒ Object

Sets the value of the id attribute.

Parameters:

  • value (String) 


20051
20052
20053
 
# File 'lib/ovirtsdk4/types.rb', line 20051

def id=(value)
  @id = value
end

#job ⇒ Job

Returns the value of the job attribute.

Returns:



20060
20061
20062
 
# File 'lib/ovirtsdk4/types.rb', line 20060

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) 


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

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) 


20085
20086
20087
 
# File 'lib/ovirtsdk4/types.rb', line 20085

def name
  @name
end

#name=(value) ⇒ Object

Sets the value of the name attribute.

Parameters:

  • value (String) 


20094
20095
20096
 
# File 'lib/ovirtsdk4/types.rb', line 20094

def name=(value)
  @name = value
end

#number ⇒ Integer

Returns the value of the number attribute.

Returns:

  • (Integer) 


20103
20104
20105
 
# File 'lib/ovirtsdk4/types.rb', line 20103

def number
  @number
end

#number=(value) ⇒ Object

Sets the value of the number attribute.

Parameters:

  • value (Integer) 


20112
20113
20114
 
# File 'lib/ovirtsdk4/types.rb', line 20112

def number=(value)
  @number = value
end

#parent_step ⇒ Step

Returns the value of the parent_step attribute.

Returns:



20121
20122
20123
 
# File 'lib/ovirtsdk4/types.rb', line 20121

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) 


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

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) 


20146
20147
20148
 
# File 'lib/ovirtsdk4/types.rb', line 20146

def progress
  @progress
end

#progress=(value) ⇒ Object

Sets the value of the progress attribute.

Parameters:

  • value (Integer) 


20155
20156
20157
 
# File 'lib/ovirtsdk4/types.rb', line 20155

def progress=(value)
  @progress = value
end

#start_time ⇒ DateTime

Returns the value of the start_time attribute.

Returns:

  • (DateTime) 


20164
20165
20166
 
# File 'lib/ovirtsdk4/types.rb', line 20164

def start_time
  @start_time
end

#start_time=(value) ⇒ Object

Sets the value of the start_time attribute.

Parameters:

  • value (DateTime) 


20173
20174
20175
 
# File 'lib/ovirtsdk4/types.rb', line 20173

def start_time=(value)
  @start_time = value
end

#statistics ⇒ Array<Statistic>

Returns the value of the statistics attribute.

Returns:



20182
20183
20184
 
# File 'lib/ovirtsdk4/types.rb', line 20182

def statistics
  @statistics
end

#statistics=(list) ⇒ Object

Sets the value of the statistics attribute.

Parameters:



20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
 
# File 'lib/ovirtsdk4/types.rb', line 20191

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:



20208
20209
20210
 
# File 'lib/ovirtsdk4/types.rb', line 20208

def status
  @status
end

#status=(value) ⇒ Object

Sets the value of the status attribute.

Parameters:



20217
20218
20219
 
# File 'lib/ovirtsdk4/types.rb', line 20217

def status=(value)
  @status = value
end

#type ⇒ StepEnum

Returns the value of the type attribute.

Returns:



20226
20227
20228
 
# File 'lib/ovirtsdk4/types.rb', line 20226

def type
  @type
end

#type=(value) ⇒ Object

Sets the value of the type attribute.

Parameters:



20235
20236
20237
 
# File 'lib/ovirtsdk4/types.rb', line 20235

def type=(value)
  @type = value
end