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 [Host, Hash] :execution_host The value of attribute `execution_host`.

@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 [Integer] :progress The value of attribute `progress`.

@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 20233
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

Public Instance Methods

==(other) click to toggle source

Returns `true` if `self` and `other` have the same attributes and values.

Calls superclass method OvirtSDK4::Identified#==
# File lib/ovirtsdk4/types.rb, line 20252
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() click to toggle source

Returns the value of the `comment` attribute.

@return [String]

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

Sets the value of the `comment` attribute.

@param value [String]

# File lib/ovirtsdk4/types.rb, line 19890
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 19899
def description
  @description
end
description=(value) click to toggle source

Sets the value of the `description` attribute.

@param value [String]

# File lib/ovirtsdk4/types.rb, line 19908
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 19917
def end_time
  @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 19926
def end_time=(value)
  @end_time = value
end
execution_host() click to toggle source

Returns the value of the `execution_host` attribute.

@return [Host]

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

Sets the value of the `execution_host` attribute.

@param value [Host, Hash]

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

# File lib/ovirtsdk4/types.rb, line 19948
def execution_host=(value)
  if value.is_a?(Hash)
    value = Host.new(value)
  end
  @execution_host = value
end
external() click to toggle source

Returns the value of the `external` attribute.

@return [Boolean]

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

Sets the value of the `external` attribute.

@param value [Boolean]

# File lib/ovirtsdk4/types.rb, line 19969
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 19978
def external_type
  @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 19987
def external_type=(value)
  @external_type = value
end
hash() click to toggle source

Generates a hash value for this object.

Calls superclass method OvirtSDK4::Identified#hash
# File lib/ovirtsdk4/types.rb, line 20271
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() click to toggle source

Returns the value of the `id` attribute.

@return [String]

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

Sets the value of the `id` attribute.

@param value [String]

# File lib/ovirtsdk4/types.rb, line 20005
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 20014
def job
  @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 20027
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 20039
def name
  @name
end
name=(value) click to toggle source

Sets the value of the `name` attribute.

@param value [String]

# File lib/ovirtsdk4/types.rb, line 20048
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 20057
def number
  @number
end
number=(value) click to toggle source

Sets the value of the `number` attribute.

@param value [Integer]

# File lib/ovirtsdk4/types.rb, line 20066
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 20075
def parent_step
  @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 20088
def parent_step=(value)
  if value.is_a?(Hash)
    value = Step.new(value)
  end
  @parent_step = value
end
progress() click to toggle source

Returns the value of the `progress` attribute.

@return [Integer]

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

Sets the value of the `progress` attribute.

@param value [Integer]

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

Returns the value of the `start_time` attribute.

@return [DateTime]

# File lib/ovirtsdk4/types.rb, line 20118
def start_time
  @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 20127
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 20136
def statistics
  @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 20145
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 20162
def status
  @status
end
status=(value) click to toggle source

Sets the value of the `status` attribute.

@param value [StepStatus]

# File lib/ovirtsdk4/types.rb, line 20171
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 20180
def type
  @type
end
type=(value) click to toggle source

Sets the value of the `type` attribute.

@param value [StepEnum]

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