Class: Nodeum::Task

Inherits:
Object
  • Object
show all
Defined in:
lib/nodeum_sdk/models/task.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Task

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/nodeum_sdk/models/task.rb', line 139

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#action ⇒ Object

Returns the value of attribute action.



35
36
37
 
# File 'lib/nodeum_sdk/models/task.rb', line 35

def action
  @action
end

#activate ⇒ Object

Returns the value of attribute activate.



37
38
39
 
# File 'lib/nodeum_sdk/models/task.rb', line 37

def activate
  @activate
end

#comment ⇒ Object

Returns the value of attribute comment.



21
22
23
 
# File 'lib/nodeum_sdk/models/task.rb', line 21

def comment
  @comment
end

#conflict_resolution ⇒ Object

Returns the value of attribute conflict_resolution.



33
34
35
 
# File 'lib/nodeum_sdk/models/task.rb', line 33

def conflict_resolution
  @conflict_resolution
end

#creation_date ⇒ Object

Returns the value of attribute creation_date.



39
40
41
 
# File 'lib/nodeum_sdk/models/task.rb', line 39

def creation_date
  @creation_date
end

#creation_username ⇒ Object

Returns the value of attribute creation_username.



43
44
45
 
# File 'lib/nodeum_sdk/models/task.rb', line 43

def creation_username
  @creation_username
end

#destination_type ⇒ Object

Returns the value of attribute destination_type.



29
30
31
 
# File 'lib/nodeum_sdk/models/task.rb', line 29

def destination_type
  @destination_type
end

#id ⇒ Object

Returns the value of attribute id.



17
18
19
 
# File 'lib/nodeum_sdk/models/task.rb', line 17

def id
  @id
end

#job_finished ⇒ Object

Returns the value of attribute job_finished.



51
52
53
 
# File 'lib/nodeum_sdk/models/task.rb', line 51

def job_finished
  @job_finished
end

#job_started ⇒ Object

Returns the value of attribute job_started.



49
50
51
 
# File 'lib/nodeum_sdk/models/task.rb', line 49

def job_started
  @job_started
end

#modification_date ⇒ Object

Returns the value of attribute modification_date.



41
42
43
 
# File 'lib/nodeum_sdk/models/task.rb', line 41

def modification_date
  @modification_date
end

#modification_username ⇒ Object

Returns the value of attribute modification_username.



45
46
47
 
# File 'lib/nodeum_sdk/models/task.rb', line 45

def modification_username
  @modification_username
end

#name ⇒ Object

Returns the value of attribute name.



19
20
21
 
# File 'lib/nodeum_sdk/models/task.rb', line 19

def name
  @name
end

#priority ⇒ Object

Returns the value of attribute priority.



31
32
33
 
# File 'lib/nodeum_sdk/models/task.rb', line 31

def priority
  @priority
end

#processed_size ⇒ Object

Returns the value of attribute processed_size.



53
54
55
 
# File 'lib/nodeum_sdk/models/task.rb', line 53

def processed_size
  @processed_size
end

#source_type ⇒ Object

Returns the value of attribute source_type.



27
28
29
 
# File 'lib/nodeum_sdk/models/task.rb', line 27

def source_type
  @source_type
end

#status ⇒ Object

Returns the value of attribute status.



47
48
49
 
# File 'lib/nodeum_sdk/models/task.rb', line 47

def status
  @status
end

#to_process_size ⇒ Object

Returns the value of attribute to_process_size.



55
56
57
 
# File 'lib/nodeum_sdk/models/task.rb', line 55

def to_process_size
  @to_process_size
end

#workflow_action ⇒ Object

Returns the value of attribute workflow_action.



25
26
27
 
# File 'lib/nodeum_sdk/models/task.rb', line 25

def workflow_action
  @workflow_action
end

#workflow_type ⇒ Object

Returns the value of attribute workflow_type.



23
24
25
 
# File 'lib/nodeum_sdk/models/task.rb', line 23

def workflow_type
  @workflow_type
end

Class Method Details

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/nodeum_sdk/models/task.rb', line 80

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'comment' => :'comment',
    :'workflow_type' => :'workflow_type',
    :'workflow_action' => :'workflow_action',
    :'source_type' => :'source_type',
    :'destination_type' => :'destination_type',
    :'priority' => :'priority',
    :'conflict_resolution' => :'conflict_resolution',
    :'action' => :'action',
    :'activate' => :'activate',
    :'creation_date' => :'creation_date',
    :'modification_date' => :'modification_date',
    :'creation_username' => :'creation_username',
    :'modification_username' => :'modification_username',
    :'status' => :'status',
    :'job_started' => :'job_started',
    :'job_finished' => :'job_finished',
    :'processed_size' => :'processed_size',
    :'to_process_size' => :'to_process_size'
  }
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



372
373
374
 
# File 'lib/nodeum_sdk/models/task.rb', line 372

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



132
133
134
135
 
# File 'lib/nodeum_sdk/models/task.rb', line 132

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'comment' => :'String',
    :'workflow_type' => :'String',
    :'workflow_action' => :'String',
    :'source_type' => :'String',
    :'destination_type' => :'String',
    :'priority' => :'Integer',
    :'conflict_resolution' => :'String',
    :'action' => :'String',
    :'activate' => :'Boolean',
    :'creation_date' => :'String',
    :'modification_date' => :'String',
    :'creation_username' => :'String',
    :'modification_username' => :'String',
    :'status' => :'String',
    :'job_started' => :'String',
    :'job_finished' => :'String',
    :'processed_size' => :'Integer',
    :'to_process_size' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/nodeum_sdk/models/task.rb', line 332

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      comment == o.comment &&
      workflow_type == o.workflow_type &&
      workflow_action == o.workflow_action &&
      source_type == o.source_type &&
      destination_type == o.destination_type &&
      priority == o.priority &&
      conflict_resolution == o.conflict_resolution &&
      action == o.action &&
      activate == o.activate &&
      creation_date == o.creation_date &&
      modification_date == o.modification_date &&
      creation_username == o.creation_username &&
      modification_username == o.modification_username &&
      status == o.status &&
      job_started == o.job_started &&
      job_finished == o.job_finished &&
      processed_size == o.processed_size &&
      to_process_size == o.to_process_size
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



400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/nodeum_sdk/models/task.rb', line 400

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



469
470
471
472
473
474
475
476
477
478
479
480
481
 
# File 'lib/nodeum_sdk/models/task.rb', line 469

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



379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/nodeum_sdk/models/task.rb', line 379

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


359
360
361
 
# File 'lib/nodeum_sdk/models/task.rb', line 359

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



365
366
367
 
# File 'lib/nodeum_sdk/models/task.rb', line 365

def hash
  [id, name, comment, workflow_type, workflow_action, source_type, destination_type, priority, conflict_resolution, action, activate, creation_date, modification_date, creation_username, modification_username, status, job_started, job_finished, processed_size, to_process_size].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



235
236
237
238
 
# File 'lib/nodeum_sdk/models/task.rb', line 235

def list_invalid_properties
  invalid_properties = Array.new
  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



445
446
447
 
# File 'lib/nodeum_sdk/models/task.rb', line 445

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



451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/nodeum_sdk/models/task.rb', line 451

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



439
440
441
 
# File 'lib/nodeum_sdk/models/task.rb', line 439

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



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/nodeum_sdk/models/task.rb', line 242

def valid?
  workflow_type_validator = EnumAttributeValidator.new('String', ["active_archive", "offline_archive", "data_exchange", "data_migration", "maintenance", "data_enrichment"])
  return false unless workflow_type_validator.valid?(@workflow_type)
  workflow_action_validator = EnumAttributeValidator.new('String', ["copy", "move", "erase", "scan", "rehydratation", "format", "check_consistency", "duplication", "cache_cleaning", "ejection", "get_index", "full_backup", "incremental_backup"])
  return false unless workflow_action_validator.valid?(@workflow_action)
  source_type_validator = EnumAttributeValidator.new('String', ["container", "primary_nas", "secondary_nas", "primary_cloud", "secondary_cloud", "secondary_tape"])
  return false unless source_type_validator.valid?(@source_type)
  destination_type_validator = EnumAttributeValidator.new('String', ["container", "primary_nas", "secondary_nas", "primary_cloud", "secondary_cloud", "secondary_tape"])
  return false unless destination_type_validator.valid?(@destination_type)
  conflict_resolution_validator = EnumAttributeValidator.new('String', ["rename", "overwrite", "ignore"])
  return false unless conflict_resolution_validator.valid?(@conflict_resolution)
  action_validator = EnumAttributeValidator.new('String', ["noop", "run", "pause", "stop", "resume"])
  return false unless action_validator.valid?(@action)
  status_validator = EnumAttributeValidator.new('String', ["not_activated", "done", "in_progress", "error", "paused", "stopped_by_system", "in_queue", "finished_with_warnings", "calculating", "stopped_by_user"])
  return false unless status_validator.valid?(@status)
  true
end