class PulpcoreClient::TaskResponse
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
Any tasks spawned by this task.
Resources created by this task.
A JSON Object of a fatal error encountered during the execution of this task.
Timestamp of the when this task stopped execution.
The logging correlation id associated with this task
The name of task.
The parent task that spawned this task.
Timestamp of creation.
Timestamp of the when this task started execution.
The current state of the task. The possible values include: 'waiting', 'skipped', 'running', 'completed', 'failed' and 'canceled'.
The task group that this task is a member of.
The worker associated with this task. This field is empty if a worker is not yet assigned.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/pulpcore_client/models/task_response.rb, line 61 def self.attribute_map { :'pulp_href' => :'pulp_href', :'pulp_created' => :'pulp_created', :'state' => :'state', :'name' => :'name', :'logging_cid' => :'logging_cid', :'started_at' => :'started_at', :'finished_at' => :'finished_at', :'error' => :'error', :'worker' => :'worker', :'parent_task' => :'parent_task', :'child_tasks' => :'child_tasks', :'task_group' => :'task_group', :'progress_reports' => :'progress_reports', :'created_resources' => :'created_resources', :'reserved_resources_record' => :'reserved_resources_record' } end
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_response.rb, line 252 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/pulpcore_client/models/task_response.rb, line 110 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `PulpcoreClient::TaskResponse` 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::TaskResponse`. 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?(:'pulp_created') self.pulp_created = attributes[:'pulp_created'] end if attributes.key?(:'state') self.state = attributes[:'state'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'logging_cid') self.logging_cid = attributes[:'logging_cid'] end if attributes.key?(:'started_at') self.started_at = attributes[:'started_at'] end if attributes.key?(:'finished_at') self.finished_at = attributes[:'finished_at'] end if attributes.key?(:'error') self.error = attributes[:'error'] end if attributes.key?(:'worker') self.worker = attributes[:'worker'] end if attributes.key?(:'parent_task') self.parent_task = attributes[:'parent_task'] end if attributes.key?(:'child_tasks') if (value = attributes[:'child_tasks']).is_a?(Array) self.child_tasks = value end end if attributes.key?(:'task_group') self.task_group = attributes[:'task_group'] end if attributes.key?(:'progress_reports') if (value = attributes[:'progress_reports']).is_a?(Array) self.progress_reports = value end end if attributes.key?(:'created_resources') if (value = attributes[:'created_resources']).is_a?(Array) self.created_resources = value end end if attributes.key?(:'reserved_resources_record') if (value = attributes[:'reserved_resources_record']).is_a?(Array) self.reserved_resources_record = value end end end
List of attributes with nullable: true
# File lib/pulpcore_client/models/task_response.rb, line 103 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/pulpcore_client/models/task_response.rb, line 82 def self.openapi_types { :'pulp_href' => :'String', :'pulp_created' => :'DateTime', :'state' => :'String', :'name' => :'String', :'logging_cid' => :'String', :'started_at' => :'DateTime', :'finished_at' => :'DateTime', :'error' => :'Object', :'worker' => :'String', :'parent_task' => :'String', :'child_tasks' => :'Array<String>', :'task_group' => :'String', :'progress_reports' => :'Array<ProgressReportResponse>', :'created_resources' => :'Array<String>', :'reserved_resources_record' => :'Array<Object>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/pulpcore_client/models/task_response.rb, line 217 def ==(o) return true if self.equal?(o) self.class == o.class && pulp_href == o.pulp_href && pulp_created == o.pulp_created && state == o.state && name == o.name && logging_cid == o.logging_cid && started_at == o.started_at && finished_at == o.finished_at && error == o.error && worker == o.worker && parent_task == o.parent_task && child_tasks == o.child_tasks && task_group == o.task_group && progress_reports == o.progress_reports && created_resources == o.created_resources && reserved_resources_record == o.reserved_resources_record end
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_response.rb, line 280 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
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_response.rb, line 349 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
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_response.rb, line 259 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
@see the `==` method @param [Object] Object to be compared
# File lib/pulpcore_client/models/task_response.rb, line 239 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/pulpcore_client/models/task_response.rb, line 245 def hash [pulp_href, pulp_created, state, name, logging_cid, started_at, finished_at, error, worker, parent_task, child_tasks, task_group, progress_reports, created_resources, reserved_resources_record].hash end
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_response.rb, line 194 def list_invalid_properties invalid_properties = Array.new if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end if @logging_cid.nil? invalid_properties.push('invalid value for "logging_cid", logging_cid cannot be nil.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/pulpcore_client/models/task_response.rb, line 331 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/pulpcore_client/models/task_response.rb, line 319 def to_s to_hash.to_s end
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_response.rb, line 209 def valid? return false if @name.nil? return false if @logging_cid.nil? true end