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.



21134
21135
21136
21137
21138
21139
21140
21141
21142
21143
21144
21145
21146
21147
21148
 
# File 'lib/ovirtsdk4/types.rb', line 21134

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.



21153
21154
21155
21156
21157
21158
21159
21160
21161
21162
21163
21164
21165
21166
21167
 
# File 'lib/ovirtsdk4/types.rb', line 21153

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) 


20782
20783
20784
 
# File 'lib/ovirtsdk4/types.rb', line 20782

def comment
  @comment
end

#comment=(value) ⇒ Object

Sets the value of the comment attribute.

Parameters:

  • value (String) 


20791
20792
20793
 
# File 'lib/ovirtsdk4/types.rb', line 20791

def comment=(value)
  @comment = value
end

#description ⇒ String

Returns the value of the description attribute.

Returns:

  • (String) 


20800
20801
20802
 
# File 'lib/ovirtsdk4/types.rb', line 20800

def description
  @description
end

#description=(value) ⇒ Object

Sets the value of the description attribute.

Parameters:

  • value (String) 


20809
20810
20811
 
# File 'lib/ovirtsdk4/types.rb', line 20809

def description=(value)
  @description = value
end

#end_time ⇒ DateTime

Returns the value of the end_time attribute.

Returns:

  • (DateTime) 


20818
20819
20820
 
# File 'lib/ovirtsdk4/types.rb', line 20818

def end_time
  @end_time
end

#end_time=(value) ⇒ Object

Sets the value of the end_time attribute.

Parameters:

  • value (DateTime) 


20827
20828
20829
 
# File 'lib/ovirtsdk4/types.rb', line 20827

def end_time=(value)
  @end_time = value
end

#execution_host ⇒ Host

Returns the value of the execution_host attribute.

Returns:



20836
20837
20838
 
# File 'lib/ovirtsdk4/types.rb', line 20836

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) 


20849
20850
20851
20852
20853
20854
 
# File 'lib/ovirtsdk4/types.rb', line 20849

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) 


20861
20862
20863
 
# File 'lib/ovirtsdk4/types.rb', line 20861

def external
  @external
end

#external=(value) ⇒ Object

Sets the value of the external attribute.

Parameters:

  • value (Boolean) 


20870
20871
20872
 
# File 'lib/ovirtsdk4/types.rb', line 20870

def external=(value)
  @external = value
end

#external_type ⇒ ExternalSystemType

Returns the value of the external_type attribute.

Returns:



20879
20880
20881
 
# File 'lib/ovirtsdk4/types.rb', line 20879

def external_type
  @external_type
end

#external_type=(value) ⇒ Object

Sets the value of the external_type attribute.

Parameters:



20888
20889
20890
 
# File 'lib/ovirtsdk4/types.rb', line 20888

def external_type=(value)
  @external_type = value
end

#hash ⇒ Object

Generates a hash value for this object.



21172
21173
21174
21175
21176
21177
21178
21179
21180
21181
21182
21183
21184
21185
21186
 
# File 'lib/ovirtsdk4/types.rb', line 21172

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) 


20897
20898
20899
 
# File 'lib/ovirtsdk4/types.rb', line 20897

def id
  @id
end

#id=(value) ⇒ Object

Sets the value of the id attribute.

Parameters:

  • value (String) 


20906
20907
20908
 
# File 'lib/ovirtsdk4/types.rb', line 20906

def id=(value)
  @id = value
end

#job ⇒ Job

Returns the value of the job attribute.

Returns:



20915
20916
20917
 
# File 'lib/ovirtsdk4/types.rb', line 20915

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) 


20928
20929
20930
20931
20932
20933
 
# File 'lib/ovirtsdk4/types.rb', line 20928

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) 


20940
20941
20942
 
# File 'lib/ovirtsdk4/types.rb', line 20940

def name
  @name
end

#name=(value) ⇒ Object

Sets the value of the name attribute.

Parameters:

  • value (String) 


20949
20950
20951
 
# File 'lib/ovirtsdk4/types.rb', line 20949

def name=(value)
  @name = value
end

#number ⇒ Integer

Returns the value of the number attribute.

Returns:

  • (Integer) 


20958
20959
20960
 
# File 'lib/ovirtsdk4/types.rb', line 20958

def number
  @number
end

#number=(value) ⇒ Object

Sets the value of the number attribute.

Parameters:

  • value (Integer) 


20967
20968
20969
 
# File 'lib/ovirtsdk4/types.rb', line 20967

def number=(value)
  @number = value
end

#parent_step ⇒ Step

Returns the value of the parent_step attribute.

Returns:



20976
20977
20978
 
# File 'lib/ovirtsdk4/types.rb', line 20976

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) 


20989
20990
20991
20992
20993
20994
 
# File 'lib/ovirtsdk4/types.rb', line 20989

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) 


21001
21002
21003
 
# File 'lib/ovirtsdk4/types.rb', line 21001

def progress
  @progress
end

#progress=(value) ⇒ Object

Sets the value of the progress attribute.

Parameters:

  • value (Integer) 


21010
21011
21012
 
# File 'lib/ovirtsdk4/types.rb', line 21010

def progress=(value)
  @progress = value
end

#start_time ⇒ DateTime

Returns the value of the start_time attribute.

Returns:

  • (DateTime) 


21019
21020
21021
 
# File 'lib/ovirtsdk4/types.rb', line 21019

def start_time
  @start_time
end

#start_time=(value) ⇒ Object

Sets the value of the start_time attribute.

Parameters:

  • value (DateTime) 


21028
21029
21030
 
# File 'lib/ovirtsdk4/types.rb', line 21028

def start_time=(value)
  @start_time = value
end

#statistics ⇒ Array<Statistic>

Returns the value of the statistics attribute.

Returns:



21037
21038
21039
 
# File 'lib/ovirtsdk4/types.rb', line 21037

def statistics
  @statistics
end

#statistics=(list) ⇒ Object

Sets the value of the statistics attribute.

Parameters:



21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
 
# File 'lib/ovirtsdk4/types.rb', line 21046

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:



21063
21064
21065
 
# File 'lib/ovirtsdk4/types.rb', line 21063

def status
  @status
end

#status=(value) ⇒ Object

Sets the value of the status attribute.

Parameters:



21072
21073
21074
 
# File 'lib/ovirtsdk4/types.rb', line 21072

def status=(value)
  @status = value
end

#type ⇒ StepEnum

Returns the value of the type attribute.

Returns:



21081
21082
21083
 
# File 'lib/ovirtsdk4/types.rb', line 21081

def type
  @type
end

#type=(value) ⇒ Object

Sets the value of the type attribute.

Parameters:



21090
21091
21092
 
# File 'lib/ovirtsdk4/types.rb', line 21090

def type=(value)
  @type = value
end