class PulpcoreClient::TaskGroupResponse

Base serializer for use with :class:`pulpcore.app.models.Model` This ensures that all Serializers provide values for the 'pulp_href` field. The class provides a default for the “ref_name“ attribute in the ModelSerializers's “Meta“ class. This ensures that the OpenAPI definitions of plugins are namespaced properly.

Attributes

all_tasks_dispatched[RW]

Whether all tasks have been spawned for this task group.

canceled[RW]

Number of tasks in the 'canceled' state

canceling[RW]

Number of tasks in the 'canceling' state

completed[RW]

Number of tasks in the 'completed' state

description[RW]

A description of the task group.

failed[RW]

Number of tasks in the 'failed' state

group_progress_reports[RW]
pulp_href[RW]
running[RW]

Number of tasks in the 'running' state

skipped[RW]

Number of tasks in the 'skipped' state

tasks[RW]
waiting[RW]

Number of tasks in the 'waiting' state

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/pulpcore_client/models/task_group_response.rb, line 52
def self.attribute_map
  {
    :'pulp_href' => :'pulp_href',
    :'description' => :'description',
    :'all_tasks_dispatched' => :'all_tasks_dispatched',
    :'waiting' => :'waiting',
    :'skipped' => :'skipped',
    :'running' => :'running',
    :'completed' => :'completed',
    :'canceled' => :'canceled',
    :'failed' => :'failed',
    :'canceling' => :'canceling',
    :'group_progress_reports' => :'group_progress_reports',
    :'tasks' => :'tasks'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/pulpcore_client/models/task_group_response.rb, line 218
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/pulpcore_client/models/task_group_response.rb, line 95
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PulpcoreClient::TaskGroupResponse` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `PulpcoreClient::TaskGroupResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'pulp_href')
    self.pulp_href = attributes[:'pulp_href']
  end

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.key?(:'all_tasks_dispatched')
    self.all_tasks_dispatched = attributes[:'all_tasks_dispatched']
  end

  if attributes.key?(:'waiting')
    self.waiting = attributes[:'waiting']
  end

  if attributes.key?(:'skipped')
    self.skipped = attributes[:'skipped']
  end

  if attributes.key?(:'running')
    self.running = attributes[:'running']
  end

  if attributes.key?(:'completed')
    self.completed = attributes[:'completed']
  end

  if attributes.key?(:'canceled')
    self.canceled = attributes[:'canceled']
  end

  if attributes.key?(:'failed')
    self.failed = attributes[:'failed']
  end

  if attributes.key?(:'canceling')
    self.canceling = attributes[:'canceling']
  end

  if attributes.key?(:'group_progress_reports')
    if (value = attributes[:'group_progress_reports']).is_a?(Array)
      self.group_progress_reports = value
    end
  end

  if attributes.key?(:'tasks')
    if (value = attributes[:'tasks']).is_a?(Array)
      self.tasks = value
    end
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/pulpcore_client/models/task_group_response.rb, line 88
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/pulpcore_client/models/task_group_response.rb, line 70
def self.openapi_types
  {
    :'pulp_href' => :'String',
    :'description' => :'String',
    :'all_tasks_dispatched' => :'Boolean',
    :'waiting' => :'Integer',
    :'skipped' => :'Integer',
    :'running' => :'Integer',
    :'completed' => :'Integer',
    :'canceled' => :'Integer',
    :'failed' => :'Integer',
    :'canceling' => :'Integer',
    :'group_progress_reports' => :'Array<GroupProgressReportResponse>',
    :'tasks' => :'Array<MinimalTaskResponse>'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/pulpcore_client/models/task_group_response.rb, line 186
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      pulp_href == o.pulp_href &&
      description == o.description &&
      all_tasks_dispatched == o.all_tasks_dispatched &&
      waiting == o.waiting &&
      skipped == o.skipped &&
      running == o.running &&
      completed == o.completed &&
      canceled == o.canceled &&
      failed == o.failed &&
      canceling == o.canceling &&
      group_progress_reports == o.group_progress_reports &&
      tasks == o.tasks
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/pulpcore_client/models/task_group_response.rb, line 246
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    PulpcoreClient.const_get(type).build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/pulpcore_client/models/task_group_response.rb, line 315
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/pulpcore_client/models/task_group_response.rb, line 225
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/pulpcore_client/models/task_group_response.rb, line 205
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/pulpcore_client/models/task_group_response.rb, line 211
def hash
  [pulp_href, description, all_tasks_dispatched, waiting, skipped, running, completed, canceled, failed, canceling, group_progress_reports, tasks].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/pulpcore_client/models/task_group_response.rb, line 163
def list_invalid_properties
  invalid_properties = Array.new
  if @description.nil?
    invalid_properties.push('invalid value for "description", description cannot be nil.')
  end

  if @all_tasks_dispatched.nil?
    invalid_properties.push('invalid value for "all_tasks_dispatched", all_tasks_dispatched cannot be nil.')
  end

  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/pulpcore_client/models/task_group_response.rb, line 291
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/pulpcore_client/models/task_group_response.rb, line 297
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/pulpcore_client/models/task_group_response.rb, line 285
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/pulpcore_client/models/task_group_response.rb, line 178
def valid?
  return false if @description.nil?
  return false if @all_tasks_dispatched.nil?
  true
end