Class: PulpcoreClient::TaskRead

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TaskRead

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/pulpcore_client/models/task_read.rb', line 104

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PulpcoreClient::TaskRead` 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::TaskRead`. 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')
    if (value = attributes[:'error']).is_a?(Hash)
      self.error = value
    end
  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

Instance Attribute Details

#child_tasks ⇒ Object

Any tasks spawned by this task.



44
45
46
 
# File 'lib/pulpcore_client/models/task_read.rb', line 44

def child_tasks
  @child_tasks
end

#created_resources ⇒ Object

Resources created by this task.



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

def created_resources
  @created_resources
end

#error ⇒ Object

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



35
36
37
 
# File 'lib/pulpcore_client/models/task_read.rb', line 35

def error
  @error
end

#finished_at ⇒ Object

Timestamp of the when this task stopped execution.



32
33
34
 
# File 'lib/pulpcore_client/models/task_read.rb', line 32

def finished_at
  @finished_at
end

#name ⇒ Object

The name of task.



26
27
28
 
# File 'lib/pulpcore_client/models/task_read.rb', line 26

def name
  @name
end

#parent_task ⇒ Object

The parent task that spawned this task.



41
42
43
 
# File 'lib/pulpcore_client/models/task_read.rb', line 41

def parent_task
  @parent_task
end

#progress_reports ⇒ Object

Returns the value of attribute progress_reports.



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

def progress_reports
  @progress_reports
end

#pulp_created ⇒ Object

Timestamp of creation.



20
21
22
 
# File 'lib/pulpcore_client/models/task_read.rb', line 20

def pulp_created
  @pulp_created
end

#pulp_href ⇒ Object

Returns the value of attribute pulp_href.



17
18
19
 
# File 'lib/pulpcore_client/models/task_read.rb', line 17

def pulp_href
  @pulp_href
end

#reserved_resources_record ⇒ Object

Returns the value of attribute reserved_resources_record.



54
55
56
 
# File 'lib/pulpcore_client/models/task_read.rb', line 54

def reserved_resources_record
  @reserved_resources_record
end

#started_at ⇒ Object

Timestamp of the when this task started execution.



29
30
31
 
# File 'lib/pulpcore_client/models/task_read.rb', line 29

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’.



23
24
25
 
# File 'lib/pulpcore_client/models/task_read.rb', line 23

def state
  @state
end

#task_group ⇒ Object

The task group that this task is a member of.



47
48
49
 
# File 'lib/pulpcore_client/models/task_read.rb', line 47

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.



38
39
40
 
# File 'lib/pulpcore_client/models/task_read.rb', line 38

def worker
  @worker
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/pulpcore_client/models/task_read.rb', line 57

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',
    :'reserved_resources_record' => :'reserved_resources_record'
  }
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



272
273
274
 
# File 'lib/pulpcore_client/models/task_read.rb', line 272

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



97
98
99
100
 
# File 'lib/pulpcore_client/models/task_read.rb', line 97

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/pulpcore_client/models/task_read.rb', line 77

def self.openapi_types
  {
    :'pulp_href' => :'String',
    :'pulp_created' => :'DateTime',
    :'state' => :'String',
    :'name' => :'String',
    :'started_at' => :'DateTime',
    :'finished_at' => :'DateTime',
    :'error' => :'Hash<String, Object>',
    :'worker' => :'String',
    :'parent_task' => :'String',
    :'child_tasks' => :'Array<String>',
    :'task_group' => :'String',
    :'progress_reports' => :'Array<ProgressReport>',
    :'created_resources' => :'Array<String>',
    :'reserved_resources_record' => :'Array<Object>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/pulpcore_client/models/task_read.rb', line 238

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 &&
      reserved_resources_record == o.reserved_resources_record
end

#_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



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/pulpcore_client/models/task_read.rb', line 300

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/pulpcore_client/models/task_read.rb', line 369

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/pulpcore_client/models/task_read.rb', line 279

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


259
260
261
 
# File 'lib/pulpcore_client/models/task_read.rb', line 259

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



265
266
267
 
# File 'lib/pulpcore_client/models/task_read.rb', line 265

def hash
  [pulp_href, pulp_created, state, name, started_at, finished_at, error, worker, parent_task, child_tasks, task_group, progress_reports, created_resources, reserved_resources_record].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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/pulpcore_client/models/task_read.rb', line 186

def list_invalid_properties
  invalid_properties = Array.new
  if !@state.nil? && @state.to_s.length < 1
    invalid_properties.push('invalid value for "state", the character length must be great than or equal to 1.')
  end

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

  if @name.to_s.length < 1
    invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
  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



345
346
347
 
# File 'lib/pulpcore_client/models/task_read.rb', line 345

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



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/pulpcore_client/models/task_read.rb', line 351

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



339
340
341
 
# File 'lib/pulpcore_client/models/task_read.rb', line 339

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



205
206
207
208
209
210
 
# File 'lib/pulpcore_client/models/task_read.rb', line 205

def valid?
  return false if !@state.nil? && @state.to_s.length < 1
  return false if @name.nil?
  return false if @name.to_s.length < 1
  true
end