Class: PulpcoreClient::TaskResponse
- Inherits:
-
Object
- Object
- PulpcoreClient::TaskResponse
- Defined in:
- lib/pulpcore_client/models/task_response.rb
Overview
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.
Instance Attribute Summary collapse
-
#child_tasks ⇒ Object
Any tasks spawned by this task.
-
#created_resources ⇒ Object
Resources created by this task.
-
#error ⇒ Object
A JSON Object of a fatal error encountered during the execution of this task.
-
#finished_at ⇒ Object
Timestamp of the when this task stopped execution.
-
#name ⇒ Object
The name of task.
-
#parent_task ⇒ Object
The parent task that spawned this task.
-
#progress_reports ⇒ Object
Returns the value of attribute progress_reports.
-
#pulp_created ⇒ Object
Timestamp of creation.
-
#pulp_href ⇒ Object
Returns the value of attribute pulp_href.
-
#started_at ⇒ Object
Timestamp of the when this task started execution.
-
#state ⇒ Object
The current state of the task.
-
#task_group ⇒ Object
The task group that this task is a member of.
-
#worker ⇒ Object
The worker associated with this task.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ TaskResponse
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ TaskResponse
Initializes the object
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 |
# File 'lib/pulpcore_client/models/task_response.rb', line 101 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?(:'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 end |
Instance Attribute Details
#child_tasks ⇒ Object
Any tasks spawned by this task.
45 46 47 |
# File 'lib/pulpcore_client/models/task_response.rb', line 45 def child_tasks @child_tasks end |
#created_resources ⇒ Object
Resources created by this task.
53 54 55 |
# File 'lib/pulpcore_client/models/task_response.rb', line 53 def created_resources @created_resources end |
#error ⇒ Object
A JSON Object of a fatal error encountered during the execution of this task.
36 37 38 |
# File 'lib/pulpcore_client/models/task_response.rb', line 36 def error @error end |
#finished_at ⇒ Object
Timestamp of the when this task stopped execution.
33 34 35 |
# File 'lib/pulpcore_client/models/task_response.rb', line 33 def finished_at @finished_at end |
#name ⇒ Object
The name of task.
27 28 29 |
# File 'lib/pulpcore_client/models/task_response.rb', line 27 def name @name end |
#parent_task ⇒ Object
The parent task that spawned this task.
42 43 44 |
# File 'lib/pulpcore_client/models/task_response.rb', line 42 def parent_task @parent_task end |
#progress_reports ⇒ Object
Returns the value of attribute progress_reports.
50 51 52 |
# File 'lib/pulpcore_client/models/task_response.rb', line 50 def progress_reports @progress_reports end |
#pulp_created ⇒ Object
Timestamp of creation.
21 22 23 |
# File 'lib/pulpcore_client/models/task_response.rb', line 21 def pulp_created @pulp_created end |
#pulp_href ⇒ Object
Returns the value of attribute pulp_href.
18 19 20 |
# File 'lib/pulpcore_client/models/task_response.rb', line 18 def pulp_href @pulp_href end |
#started_at ⇒ Object
Timestamp of the when this task started execution.
30 31 32 |
# File 'lib/pulpcore_client/models/task_response.rb', line 30 def started_at @started_at end |
#state ⇒ Object
The current state of the task. The possible values include: ‘waiting’, ‘skipped’, ‘running’, ‘completed’, ‘failed’ and ‘canceled’.
24 25 26 |
# File 'lib/pulpcore_client/models/task_response.rb', line 24 def state @state end |
#task_group ⇒ Object
The task group that this task is a member of.
48 49 50 |
# File 'lib/pulpcore_client/models/task_response.rb', line 48 def task_group @task_group end |
#worker ⇒ Object
The worker associated with this task. This field is empty if a worker is not yet assigned.
39 40 41 |
# File 'lib/pulpcore_client/models/task_response.rb', line 39 def worker @worker end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 |
# File 'lib/pulpcore_client/models/task_response.rb', line 56 def self.attribute_map { :'pulp_href' => :'pulp_href', :'pulp_created' => :'pulp_created', :'state' => :'state', :'name' => :'name', :'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' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
226 227 228 |
# File 'lib/pulpcore_client/models/task_response.rb', line 226 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
94 95 96 97 |
# File 'lib/pulpcore_client/models/task_response.rb', line 94 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 |
# File 'lib/pulpcore_client/models/task_response.rb', line 75 def self.openapi_types { :'pulp_href' => :'String', :'pulp_created' => :'DateTime', :'state' => :'String', :'name' => :'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>' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 |
# File 'lib/pulpcore_client/models/task_response.rb', line 193 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 && 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 end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 |
# File 'lib/pulpcore_client/models/task_response.rb', line 254 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) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
323 324 325 326 327 328 329 330 331 332 333 334 335 |
# File 'lib/pulpcore_client/models/task_response.rb', line 323 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) ⇒ Object
Builds the object from hash
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 |
# File 'lib/pulpcore_client/models/task_response.rb', line 233 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) ⇒ Boolean
213 214 215 |
# File 'lib/pulpcore_client/models/task_response.rb', line 213 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
219 220 221 |
# File 'lib/pulpcore_client/models/task_response.rb', line 219 def hash [pulp_href, pulp_created, state, name, started_at, finished_at, error, worker, parent_task, child_tasks, task_group, progress_reports, created_resources].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
175 176 177 178 179 180 181 182 |
# File 'lib/pulpcore_client/models/task_response.rb', line 175 def list_invalid_properties invalid_properties = Array.new if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
299 300 301 |
# File 'lib/pulpcore_client/models/task_response.rb', line 299 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
305 306 307 308 309 310 311 312 313 314 315 316 317 |
# File 'lib/pulpcore_client/models/task_response.rb', line 305 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 ⇒ String
Returns the string representation of the object
293 294 295 |
# File 'lib/pulpcore_client/models/task_response.rb', line 293 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
186 187 188 189 |
# File 'lib/pulpcore_client/models/task_response.rb', line 186 def valid? return false if @name.nil? true end |