Class: PulpcoreClient::TaskResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/pulpcore_client/models/task_response.rb

Overview

Base serializer for use with [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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TaskResponse

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/pulpcore_client/models/task_response.rb', line 142

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?(:'prn')
    self.prn = attributes[:'prn']
  end

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

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

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

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  else
    self.name = nil
  end

  if attributes.key?(:'logging_cid')
    self.logging_cid = attributes[:'logging_cid']
  else
    self.logging_cid = nil
  end

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

  if attributes.key?(:'unblocked_at')
    self.unblocked_at = attributes[:'unblocked_at']
  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

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

Instance Attribute Details

#child_tasks ⇒ Object

Any tasks spawned by this task.



61
62
63
 
# File 'lib/pulpcore_client/models/task_response.rb', line 61

def child_tasks
  @child_tasks
end

#created_by ⇒ Object

User who dispatched this task.



40
41
42
 
# File 'lib/pulpcore_client/models/task_response.rb', line 40

def created_by
  @created_by
end

#created_resources ⇒ Object

Resources created by this task.



69
70
71
 
# File 'lib/pulpcore_client/models/task_response.rb', line 69

def created_resources
  @created_resources
end

#error ⇒ Object

A JSON Object of a fatal error encountered during the execution of this task.



52
53
54
 
# File 'lib/pulpcore_client/models/task_response.rb', line 52

def error
  @error
end

#finished_at ⇒ Object

Timestamp of when this task stopped execution.



49
50
51
 
# File 'lib/pulpcore_client/models/task_response.rb', line 49

def finished_at
  @finished_at
end

#logging_cid ⇒ Object

The logging correlation id associated with this task



37
38
39
 
# File 'lib/pulpcore_client/models/task_response.rb', line 37

def logging_cid
  @logging_cid
end

#name ⇒ Object

The name of task.



34
35
36
 
# File 'lib/pulpcore_client/models/task_response.rb', line 34

def name
  @name
end

#parent_task ⇒ Object

The parent task that spawned this task.



58
59
60
 
# File 'lib/pulpcore_client/models/task_response.rb', line 58

def parent_task
  @parent_task
end

#prn ⇒ Object

The Pulp Resource Name (PRN).



22
23
24
 
# File 'lib/pulpcore_client/models/task_response.rb', line 22

def prn
  @prn
end

#progress_reports ⇒ Object

Returns the value of attribute progress_reports.



66
67
68
 
# File 'lib/pulpcore_client/models/task_response.rb', line 66

def progress_reports
  @progress_reports
end

#pulp_created ⇒ Object

Timestamp of creation.



25
26
27
 
# File 'lib/pulpcore_client/models/task_response.rb', line 25

def pulp_created
  @pulp_created
end

#pulp_href ⇒ Object

Returns the value of attribute pulp_href.



19
20
21
 
# File 'lib/pulpcore_client/models/task_response.rb', line 19

def pulp_href
  @pulp_href
end

#pulp_last_updated ⇒ Object

Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same.



28
29
30
 
# File 'lib/pulpcore_client/models/task_response.rb', line 28

def pulp_last_updated
  @pulp_last_updated
end

#reserved_resources_record ⇒ Object

A list of resources required by that task.



72
73
74
 
# File 'lib/pulpcore_client/models/task_response.rb', line 72

def reserved_resources_record
  @reserved_resources_record
end

#result ⇒ Object

Returns the value of attribute result.



74
75
76
 
# File 'lib/pulpcore_client/models/task_response.rb', line 74

def result
  @result
end

#started_at ⇒ Object

Timestamp of when this task started execution.



46
47
48
 
# File 'lib/pulpcore_client/models/task_response.rb', line 46

def started_at
  @started_at
end

#state ⇒ Object

The current state of the task. The possible values include: ‘waiting’, ‘skipped’, ‘running’, ‘completed’, ‘failed’, ‘canceled’ and ‘canceling’.



31
32
33
 
# File 'lib/pulpcore_client/models/task_response.rb', line 31

def state
  @state
end

#task_group ⇒ Object

The task group that this task is a member of.



64
65
66
 
# File 'lib/pulpcore_client/models/task_response.rb', line 64

def task_group
  @task_group
end

#unblocked_at ⇒ Object

Timestamp of when this task was identified ready for pickup.



43
44
45
 
# File 'lib/pulpcore_client/models/task_response.rb', line 43

def unblocked_at
  @unblocked_at
end

#worker ⇒ Object

The worker associated with this task. This field is empty if a worker is not yet assigned.



55
56
57
 
# File 'lib/pulpcore_client/models/task_response.rb', line 55

def worker
  @worker
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/pulpcore_client/models/task_response.rb', line 339

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = PulpcoreClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



103
104
105
 
# File 'lib/pulpcore_client/models/task_response.rb', line 103

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/pulpcore_client/models/task_response.rb', line 77

def self.attribute_map
  {
    :'pulp_href' => :'pulp_href',
    :'prn' => :'prn',
    :'pulp_created' => :'pulp_created',
    :'pulp_last_updated' => :'pulp_last_updated',
    :'state' => :'state',
    :'name' => :'name',
    :'logging_cid' => :'logging_cid',
    :'created_by' => :'created_by',
    :'unblocked_at' => :'unblocked_at',
    :'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',
    :'result' => :'result'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/pulpcore_client/models/task_response.rb', line 315

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



134
135
136
137
138
 
# File 'lib/pulpcore_client/models/task_response.rb', line 134

def self.openapi_nullable
  Set.new([
    :'result'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/pulpcore_client/models/task_response.rb', line 108

def self.openapi_types
  {
    :'pulp_href' => :'String',
    :'prn' => :'String',
    :'pulp_created' => :'Time',
    :'pulp_last_updated' => :'Time',
    :'state' => :'String',
    :'name' => :'String',
    :'logging_cid' => :'String',
    :'created_by' => :'String',
    :'unblocked_at' => :'Time',
    :'started_at' => :'Time',
    :'finished_at' => :'Time',
    :'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<String>',
    :'result' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/pulpcore_client/models/task_response.rb', line 275

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      pulp_href == o.pulp_href &&
      prn == o.prn &&
      pulp_created == o.pulp_created &&
      pulp_last_updated == o.pulp_last_updated &&
      state == o.state &&
      name == o.name &&
      logging_cid == o.logging_cid &&
      created_by == o.created_by &&
      unblocked_at == o.unblocked_at &&
      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 &&
      result == o.result
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/pulpcore_client/models/task_response.rb', line 410

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


302
303
304
 
# File 'lib/pulpcore_client/models/task_response.rb', line 302

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



308
309
310
 
# File 'lib/pulpcore_client/models/task_response.rb', line 308

def hash
  [pulp_href, prn, pulp_created, pulp_last_updated, state, name, logging_cid, created_by, unblocked_at, started_at, finished_at, error, worker, parent_task, child_tasks, task_group, progress_reports, created_resources, reserved_resources_record, result].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/pulpcore_client/models/task_response.rb', line 250

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



386
387
388
 
# File 'lib/pulpcore_client/models/task_response.rb', line 386

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/pulpcore_client/models/task_response.rb', line 392

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

Returns:

  • (String) —

    String presentation of the object



380
381
382
 
# File 'lib/pulpcore_client/models/task_response.rb', line 380

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



266
267
268
269
270
271
 
# File 'lib/pulpcore_client/models/task_response.rb', line 266

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @logging_cid.nil?
  true
end