Class: VSphereAutomation::CIS::CisTaskInfo

Inherits:
Object
  • Object
show all
Defined in:
lib/vsphere-automation-cis/models/cis_task_info.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CisTaskInfo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
131
132
133
134
135
136
137
 
# File 'lib/vsphere-automation-cis/models/cis_task_info.rb', line 84

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'progress')
    self.progress = attributes[:'progress']
  end

  if attributes.has_key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.has_key?(:'service')
    self.service = attributes[:'service']
  end

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

  if attributes.has_key?(:'parent')
    self.parent = attributes[:'parent']
  end

  if attributes.has_key?(:'target')
    self.target = attributes[:'target']
  end

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

  if attributes.has_key?(:'cancelable')
    self.cancelable = attributes[:'cancelable']
  end

  if attributes.has_key?(:'error')
    self.error = attributes[:'error']
  end

  if attributes.has_key?(:'start_time')
    self.start_time = attributes[:'start_time']
  end

  if attributes.has_key?(:'end_time')
    self.end_time = attributes[:'end_time']
  end

  if attributes.has_key?(:'user')
    self.user = attributes[:'user']
  end
end

Instance Attribute Details

#cancelable ⇒ Object

Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses.



32
33
34
 
# File 'lib/vsphere-automation-cis/models/cis_task_info.rb', line 32

def cancelable
  @cancelable
end

#description ⇒ Object

Returns the value of attribute description.



16
17
18
 
# File 'lib/vsphere-automation-cis/models/cis_task_info.rb', line 16

def description
  @description
end

#end_time ⇒ Object

Time when the operation is completed. This field is optional and it is only relevant when the value of CommonInfo.status is one of SUCCEEDED or FAILED.



41
42
43
 
# File 'lib/vsphere-automation-cis/models/cis_task_info.rb', line 41

def end_time
  @end_time
end

#error ⇒ Object

Description of the error if the operation status is "FAILED". If unset the description of why the operation failed will be included in the result of the operation (see Info.result).



35
36
37
 
# File 'lib/vsphere-automation-cis/models/cis_task_info.rb', line 35

def error
  @error
end

#operation ⇒ Object

Identifier of the operation associated with the task. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: vapi.operation. When operations return a value of this structure as a result, the field will be an identifier for the resource type: vapi.operation.



22
23
24
 
# File 'lib/vsphere-automation-cis/models/cis_task_info.rb', line 22

def operation
  @operation
end

#parent ⇒ Object

Parent of the current task. This field will be unset if the task has no parent. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: cis.task. When operations return a value of this structure as a result, the field will be an identifier for the resource type: cis.task.



25
26
27
 
# File 'lib/vsphere-automation-cis/models/cis_task_info.rb', line 25

def parent
  @parent
end

#progress ⇒ Object

Returns the value of attribute progress.



14
15
16
 
# File 'lib/vsphere-automation-cis/models/cis_task_info.rb', line 14

def progress
  @progress
end

#service ⇒ Object

Identifier of the service containing the operation. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: vapi.service. When operations return a value of this structure as a result, the field will be an identifier for the resource type: vapi.service.



19
20
21
 
# File 'lib/vsphere-automation-cis/models/cis_task_info.rb', line 19

def service
  @service
end

#start_time ⇒ Object

Time when the operation is started. This field is optional and it is only relevant when the value of CommonInfo.status is one of RUNNING, BLOCKED, SUCCEEDED, or FAILED.



38
39
40
 
# File 'lib/vsphere-automation-cis/models/cis_task_info.rb', line 38

def start_time
  @start_time
end

#status ⇒ Object

Returns the value of attribute status.



29
30
31
 
# File 'lib/vsphere-automation-cis/models/cis_task_info.rb', line 29

def status
  @status
end

#target ⇒ Object

Returns the value of attribute target.



27
28
29
 
# File 'lib/vsphere-automation-cis/models/cis_task_info.rb', line 27

def target
  @target
end

#user ⇒ Object

Name of the user who performed the operation. This field will be unset if the operation is performed by the system.



44
45
46
 
# File 'lib/vsphere-automation-cis/models/cis_task_info.rb', line 44

def user
  @user
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/vsphere-automation-cis/models/cis_task_info.rb', line 47

def self.attribute_map
  {
    :'progress' => :'progress',
    :'description' => :'description',
    :'service' => :'service',
    :'operation' => :'operation',
    :'parent' => :'parent',
    :'target' => :'target',
    :'status' => :'status',
    :'cancelable' => :'cancelable',
    :'error' => :'error',
    :'start_time' => :'start_time',
    :'end_time' => :'end_time',
    :'user' => :'user'
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/vsphere-automation-cis/models/cis_task_info.rb', line 65

def self.openapi_types
  {
    :'progress' => :'CisTaskProgress',
    :'description' => :'VapiStdLocalizableMessage',
    :'service' => :'String',
    :'operation' => :'String',
    :'parent' => :'String',
    :'target' => :'VapiStdDynamicID',
    :'status' => :'CisTaskStatus',
    :'cancelable' => :'Boolean',
    :'error' => :'String',
    :'start_time' => :'DateTime',
    :'end_time' => :'DateTime',
    :'user' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/vsphere-automation-cis/models/cis_task_info.rb', line 179

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      progress == o.progress &&
      description == o.description &&
      service == o.service &&
      operation == o.operation &&
      parent == o.parent &&
      target == o.target &&
      status == o.status &&
      cancelable == o.cancelable &&
      error == o.error &&
      start_time == o.start_time &&
      end_time == o.end_time &&
      user == o.user
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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/vsphere-automation-cis/models/cis_task_info.rb', line 232

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, :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
    temp_model = VSphereAutomation::CIS.const_get(type).new
    temp_model.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



298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/vsphere-automation-cis/models/cis_task_info.rb', line 298

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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/vsphere-automation-cis/models/cis_task_info.rb', line 211

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


198
199
200
 
# File 'lib/vsphere-automation-cis/models/cis_task_info.rb', line 198

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



204
205
206
 
# File 'lib/vsphere-automation-cis/models/cis_task_info.rb', line 204

def hash
  [progress, description, service, operation, parent, target, status, cancelable, error, start_time, end_time, user].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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/vsphere-automation-cis/models/cis_task_info.rb', line 141

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

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

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

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

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



278
279
280
 
# File 'lib/vsphere-automation-cis/models/cis_task_info.rb', line 278

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



284
285
286
287
288
289
290
291
292
 
# File 'lib/vsphere-automation-cis/models/cis_task_info.rb', line 284

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



272
273
274
 
# File 'lib/vsphere-automation-cis/models/cis_task_info.rb', line 272

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



168
169
170
171
172
173
174
175
 
# File 'lib/vsphere-automation-cis/models/cis_task_info.rb', line 168

def valid?
  return false if @description.nil?
  return false if @service.nil?
  return false if @operation.nil?
  return false if @status.nil?
  return false if @cancelable.nil?
  true
end