class OvirtSDK4::Step

Public Class Methods

new(opts = {}) click to toggle source

Creates a new instance of the {Step} class.

@param opts [Hash] 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.

@option opts [String] :comment The value of attribute `comment`.

@option opts [String] :description The value of attribute `description`.

@option opts [DateTime] :end_time The value of attribute `end_time`.

@option opts [Boolean] :external The value of attribute `external`.

@option opts [ExternalSystemType] :external_type The value of attribute `external_type`.

@option opts [String] :id The value of attribute `id`.

@option opts [Job, Hash] :job The value of attribute `job`.

@option opts [String] :name The value of attribute `name`.

@option opts [Integer] :number The value of attribute `number`.

@option opts [Step, Hash] :parent_step The value of attribute `parent_step`.

@option opts [DateTime] :start_time The value of attribute `start_time`.

@option opts [Array<Statistic>, Array<Hash>] :statistics The values of attribute `statistics`.

@option opts [StepStatus] :status The value of attribute `status`.

@option opts [StepEnum] :type The value of attribute `type`.

Calls superclass method OvirtSDK4::Identified.new
# File lib/ovirtsdk4/types.rb, line 15859
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

Public Instance Methods

comment() click to toggle source

Returns the value of the `comment` attribute.

@return [String]

# File lib/ovirtsdk4/types.rb, line 15555
def comment
  return @comment
end
comment=(value) click to toggle source

Sets the value of the `comment` attribute.

@param value [String]

# File lib/ovirtsdk4/types.rb, line 15564
def comment=(value)
  @comment = value
end
description() click to toggle source

Returns the value of the `description` attribute.

@return [String]

# File lib/ovirtsdk4/types.rb, line 15573
def description
  return @description
end
description=(value) click to toggle source

Sets the value of the `description` attribute.

@param value [String]

# File lib/ovirtsdk4/types.rb, line 15582
def description=(value)
  @description = value
end
end_time() click to toggle source

Returns the value of the `end_time` attribute.

@return [DateTime]

# File lib/ovirtsdk4/types.rb, line 15591
def end_time
  return @end_time
end
end_time=(value) click to toggle source

Sets the value of the `end_time` attribute.

@param value [DateTime]

# File lib/ovirtsdk4/types.rb, line 15600
def end_time=(value)
  @end_time = value
end
external() click to toggle source

Returns the value of the `external` attribute.

@return [Boolean]

# File lib/ovirtsdk4/types.rb, line 15609
def external
  return @external
end
external=(value) click to toggle source

Sets the value of the `external` attribute.

@param value [Boolean]

# File lib/ovirtsdk4/types.rb, line 15618
def external=(value)
  @external = value
end
external_type() click to toggle source

Returns the value of the `external_type` attribute.

@return [ExternalSystemType]

# File lib/ovirtsdk4/types.rb, line 15627
def external_type
  return @external_type
end
external_type=(value) click to toggle source

Sets the value of the `external_type` attribute.

@param value [ExternalSystemType]

# File lib/ovirtsdk4/types.rb, line 15636
def external_type=(value)
  @external_type = value
end
id() click to toggle source

Returns the value of the `id` attribute.

@return [String]

# File lib/ovirtsdk4/types.rb, line 15645
def id
  return @id
end
id=(value) click to toggle source

Sets the value of the `id` attribute.

@param value [String]

# File lib/ovirtsdk4/types.rb, line 15654
def id=(value)
  @id = value
end
job() click to toggle source

Returns the value of the `job` attribute.

@return [Job]

# File lib/ovirtsdk4/types.rb, line 15663
def job
  return @job
end
job=(value) click to toggle source

Sets the value of the `job` attribute.

@param value [Job, Hash]

The `value` parameter can be an instance of {OvirtSDK4::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.

# File lib/ovirtsdk4/types.rb, line 15676
def job=(value)
  if value.is_a?(Hash)
    value = Job.new(value)
  end
  @job = value
end
name() click to toggle source

Returns the value of the `name` attribute.

@return [String]

# File lib/ovirtsdk4/types.rb, line 15688
def name
  return @name
end
name=(value) click to toggle source

Sets the value of the `name` attribute.

@param value [String]

# File lib/ovirtsdk4/types.rb, line 15697
def name=(value)
  @name = value
end
number() click to toggle source

Returns the value of the `number` attribute.

@return [Integer]

# File lib/ovirtsdk4/types.rb, line 15706
def number
  return @number
end
number=(value) click to toggle source

Sets the value of the `number` attribute.

@param value [Integer]

# File lib/ovirtsdk4/types.rb, line 15715
def number=(value)
  @number = value
end
parent_step() click to toggle source

Returns the value of the `parent_step` attribute.

@return [Step]

# File lib/ovirtsdk4/types.rb, line 15724
def parent_step
  return @parent_step
end
parent_step=(value) click to toggle source

Sets the value of the `parent_step` attribute.

@param value [Step, Hash]

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.

# File lib/ovirtsdk4/types.rb, line 15737
def parent_step=(value)
  if value.is_a?(Hash)
    value = Step.new(value)
  end
  @parent_step = value
end
start_time() click to toggle source

Returns the value of the `start_time` attribute.

@return [DateTime]

# File lib/ovirtsdk4/types.rb, line 15749
def start_time
  return @start_time
end
start_time=(value) click to toggle source

Sets the value of the `start_time` attribute.

@param value [DateTime]

# File lib/ovirtsdk4/types.rb, line 15758
def start_time=(value)
  @start_time = value
end
statistics() click to toggle source

Returns the value of the `statistics` attribute.

@return [Array<Statistic>]

# File lib/ovirtsdk4/types.rb, line 15767
def statistics
  return @statistics
end
statistics=(list) click to toggle source

Sets the value of the `statistics` attribute.

@param list [Array<Statistic>]

# File lib/ovirtsdk4/types.rb, line 15775
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() click to toggle source

Returns the value of the `status` attribute.

@return [StepStatus]

# File lib/ovirtsdk4/types.rb, line 15792
def status
  return @status
end
status=(value) click to toggle source

Sets the value of the `status` attribute.

@param value [StepStatus]

# File lib/ovirtsdk4/types.rb, line 15801
def status=(value)
  @status = value
end
type() click to toggle source

Returns the value of the `type` attribute.

@return [StepEnum]

# File lib/ovirtsdk4/types.rb, line 15810
def type
  return @type
end
type=(value) click to toggle source

Sets the value of the `type` attribute.

@param value [StepEnum]

# File lib/ovirtsdk4/types.rb, line 15819
def type=(value)
  @type = value
end