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

#href, #href=

Constructor Details

- (Step) initialize(opts = {})

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.

  • :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.

  • :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.



15268
15269
15270
15271
15272
15273
15274
15275
15276
15277
15278
15279
15280
15281
15282
15283
15284
# File 'lib/ovirtsdk4/types.rb', line 15268

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

Instance Method Details

- (String) comment

Returns the value of the comment attribute.

Returns:

  • (String)


14964
14965
14966
# File 'lib/ovirtsdk4/types.rb', line 14964

def comment
  return @comment
end

- (Object) comment=(value)

Sets the value of the comment attribute.

Parameters:

  • value (String)


14973
14974
14975
# File 'lib/ovirtsdk4/types.rb', line 14973

def comment=(value)
  @comment = value
end

- (String) description

Returns the value of the description attribute.

Returns:

  • (String)


14982
14983
14984
# File 'lib/ovirtsdk4/types.rb', line 14982

def description
  return @description
end

- (Object) description=(value)

Sets the value of the description attribute.

Parameters:

  • value (String)


14991
14992
14993
# File 'lib/ovirtsdk4/types.rb', line 14991

def description=(value)
  @description = value
end

- (DateTime) end_time

Returns the value of the end_time attribute.

Returns:

  • (DateTime)


15000
15001
15002
# File 'lib/ovirtsdk4/types.rb', line 15000

def end_time
  return @end_time
end

- (Object) end_time=(value)

Sets the value of the end_time attribute.

Parameters:

  • value (DateTime)


15009
15010
15011
# File 'lib/ovirtsdk4/types.rb', line 15009

def end_time=(value)
  @end_time = value
end

- (Boolean) external

Returns the value of the external attribute.

Returns:

  • (Boolean)


15018
15019
15020
# File 'lib/ovirtsdk4/types.rb', line 15018

def external
  return @external
end

- (Object) external=(value)

Sets the value of the external attribute.

Parameters:

  • value (Boolean)


15027
15028
15029
# File 'lib/ovirtsdk4/types.rb', line 15027

def external=(value)
  @external = value
end

- (ExternalSystemType) external_type

Returns the value of the external_type attribute.

Returns:



15036
15037
15038
# File 'lib/ovirtsdk4/types.rb', line 15036

def external_type
  return @external_type
end

- (Object) external_type=(value)

Sets the value of the external_type attribute.

Parameters:



15045
15046
15047
# File 'lib/ovirtsdk4/types.rb', line 15045

def external_type=(value)
  @external_type = value
end

- (String) id

Returns the value of the id attribute.

Returns:

  • (String)


15054
15055
15056
# File 'lib/ovirtsdk4/types.rb', line 15054

def id
  return @id
end

- (Object) id=(value)

Sets the value of the id attribute.

Parameters:

  • value (String)


15063
15064
15065
# File 'lib/ovirtsdk4/types.rb', line 15063

def id=(value)
  @id = value
end

- (Job) job

Returns the value of the job attribute.

Returns:



15072
15073
15074
# File 'lib/ovirtsdk4/types.rb', line 15072

def job
  return @job
end

- (Object) job=(value)

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)


15085
15086
15087
15088
15089
15090
# File 'lib/ovirtsdk4/types.rb', line 15085

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

- (String) name

Returns the value of the name attribute.

Returns:

  • (String)


15097
15098
15099
# File 'lib/ovirtsdk4/types.rb', line 15097

def name
  return @name
end

- (Object) name=(value)

Sets the value of the name attribute.

Parameters:

  • value (String)


15106
15107
15108
# File 'lib/ovirtsdk4/types.rb', line 15106

def name=(value)
  @name = value
end

- (Integer) number

Returns the value of the number attribute.

Returns:

  • (Integer)


15115
15116
15117
# File 'lib/ovirtsdk4/types.rb', line 15115

def number
  return @number
end

- (Object) number=(value)

Sets the value of the number attribute.

Parameters:

  • value (Integer)


15124
15125
15126
# File 'lib/ovirtsdk4/types.rb', line 15124

def number=(value)
  @number = value
end

- (Step) parent_step

Returns the value of the parent_step attribute.

Returns:



15133
15134
15135
# File 'lib/ovirtsdk4/types.rb', line 15133

def parent_step
  return @parent_step
end

- (Object) parent_step=(value)

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)


15146
15147
15148
15149
15150
15151
# File 'lib/ovirtsdk4/types.rb', line 15146

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

- (DateTime) start_time

Returns the value of the start_time attribute.

Returns:

  • (DateTime)


15158
15159
15160
# File 'lib/ovirtsdk4/types.rb', line 15158

def start_time
  return @start_time
end

- (Object) start_time=(value)

Sets the value of the start_time attribute.

Parameters:

  • value (DateTime)


15167
15168
15169
# File 'lib/ovirtsdk4/types.rb', line 15167

def start_time=(value)
  @start_time = value
end

- (Array<Statistic>) statistics

Returns the value of the statistics attribute.

Returns:



15176
15177
15178
# File 'lib/ovirtsdk4/types.rb', line 15176

def statistics
  return @statistics
end

- (Object) statistics=(list)

Sets the value of the statistics attribute.

Parameters:



15184
15185
15186
15187
15188
15189
15190
15191
15192
15193
15194
# File 'lib/ovirtsdk4/types.rb', line 15184

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

- (StepStatus) status

Returns the value of the status attribute.

Returns:



15201
15202
15203
# File 'lib/ovirtsdk4/types.rb', line 15201

def status
  return @status
end

- (Object) status=(value)

Sets the value of the status attribute.

Parameters:



15210
15211
15212
# File 'lib/ovirtsdk4/types.rb', line 15210

def status=(value)
  @status = value
end

- (StepEnum) type

Returns the value of the type attribute.

Returns:



15219
15220
15221
# File 'lib/ovirtsdk4/types.rb', line 15219

def type
  return @type
end

- (Object) type=(value)

Sets the value of the type attribute.

Parameters:



15228
15229
15230
# File 'lib/ovirtsdk4/types.rb', line 15228

def type=(value)
  @type = value
end