Class: IbmCloudPower::Task

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

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



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
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
 
# File 'lib/ibm_cloud_power/models/task.rb', line 82

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#cloud_instance_id ⇒ Object

Cloud Instance ID of task owner



24
25
26
 
# File 'lib/ibm_cloud_power/models/task.rb', line 24

def cloud_instance_id
  @cloud_instance_id
end

#component_id ⇒ Object

the component id of the task



30
31
32
 
# File 'lib/ibm_cloud_power/models/task.rb', line 30

def component_id
  @component_id
end

#component_type ⇒ Object

the component type of the task



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

def component_type
  @component_type
end

#creation_date ⇒ Object

Creation Date



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

def creation_date
  @creation_date
end

#last_update_date ⇒ Object

Last Update Date



42
43
44
 
# File 'lib/ibm_cloud_power/models/task.rb', line 42

def last_update_date
  @last_update_date
end

#operation ⇒ Object

Task Operation



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

def operation
  @operation
end

#status ⇒ Object

status code of the task



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

def status
  @status
end

#status_detail ⇒ Object

status detail of the task



36
37
38
 
# File 'lib/ibm_cloud_power/models/task.rb', line 36

def status_detail
  @status_detail
end

#task_id ⇒ Object

Pcloud Task ID



18
19
20
 
# File 'lib/ibm_cloud_power/models/task.rb', line 18

def task_id
  @task_id
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/ibm_cloud_power/models/task.rb', line 45

def self.attribute_map
  {
    :'task_id' => :'taskID',
    :'operation' => :'operation',
    :'cloud_instance_id' => :'cloudInstanceID',
    :'component_type' => :'componentType',
    :'component_id' => :'componentID',
    :'status' => :'status',
    :'status_detail' => :'statusDetail',
    :'creation_date' => :'creationDate',
    :'last_update_date' => :'lastUpdateDate'
  }
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



221
222
223
 
# File 'lib/ibm_cloud_power/models/task.rb', line 221

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



75
76
77
78
 
# File 'lib/ibm_cloud_power/models/task.rb', line 75

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

.openapi_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/ibm_cloud_power/models/task.rb', line 60

def self.openapi_types
  {
    :'task_id' => :'String',
    :'operation' => :'String',
    :'cloud_instance_id' => :'String',
    :'component_type' => :'String',
    :'component_id' => :'String',
    :'status' => :'String',
    :'status_detail' => :'String',
    :'creation_date' => :'DateTime',
    :'last_update_date' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/ibm_cloud_power/models/task.rb', line 192

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      task_id == o.task_id &&
      operation == o.operation &&
      cloud_instance_id == o.cloud_instance_id &&
      component_type == o.component_type &&
      component_id == o.component_id &&
      status == o.status &&
      status_detail == o.status_detail &&
      creation_date == o.creation_date &&
      last_update_date == o.last_update_date
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



251
252
253
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
 
# File 'lib/ibm_cloud_power/models/task.rb', line 251

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



320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/ibm_cloud_power/models/task.rb', line 320

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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/ibm_cloud_power/models/task.rb', line 228

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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


208
209
210
 
# File 'lib/ibm_cloud_power/models/task.rb', line 208

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



214
215
216
 
# File 'lib/ibm_cloud_power/models/task.rb', line 214

def hash
  [task_id, operation, cloud_instance_id, component_type, component_id, status, status_detail, creation_date, last_update_date].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



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

def list_invalid_properties
  invalid_properties = Array.new
  if @task_id.nil?
    invalid_properties.push('invalid value for "task_id", task_id cannot be nil.')
  end

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

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

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

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

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

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

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

  if @last_update_date.nil?
    invalid_properties.push('invalid value for "last_update_date", last_update_date 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



296
297
298
 
# File 'lib/ibm_cloud_power/models/task.rb', line 296

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



302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/ibm_cloud_power/models/task.rb', line 302

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



290
291
292
 
# File 'lib/ibm_cloud_power/models/task.rb', line 290

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



177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/ibm_cloud_power/models/task.rb', line 177

def valid?
  return false if @task_id.nil?
  return false if @operation.nil?
  return false if @cloud_instance_id.nil?
  return false if @component_type.nil?
  return false if @component_id.nil?
  return false if @status.nil?
  return false if @status_detail.nil?
  return false if @creation_date.nil?
  return false if @last_update_date.nil?
  true
end