Class: IntersightClient::BulkExportedItemAllOf

Inherits:
Object
  • Object
show all
Defined in:
lib/intersight_client/models/bulk_exported_item_all_of.rb

Overview

Definition of the list of properties defined in ‘bulk.ExportedItem’, excluding properties defined in parent classes.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BulkExportedItemAllOf

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IntersightClient::BulkExportedItemAllOf` 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.acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `#{self.class.name}`. Please check the name to make sure it's valid. List of attributes: " + self.class.acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'class_id')
    self.class_id = attributes[:'class_id']
  else
    self.class_id = 'bulk.ExportedItem'
  end

  if attributes.key?(:'object_type')
    self.object_type = attributes[:'object_type']
  else
    self.object_type = 'bulk.ExportedItem'
  end

  if attributes.key?(:'export_tags')
    self.export_tags = attributes[:'export_tags']
  else
    self.export_tags = false
  end

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'related_items')
    if (value = attributes[:'related_items']).is_a?(Array)
      self.related_items = value
    end
  end
end

Instance Attribute Details

#class_idObject

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.



20
21
22
# File 'lib/intersight_client/models/bulk_exported_item_all_of.rb', line 20

def class_id
  @class_id
end

#exportObject

Returns the value of attribute export.



48
49
50
# File 'lib/intersight_client/models/bulk_exported_item_all_of.rb', line 48

def export
  @export
end

#export_tagsObject

Specifies whether tags must be exported for item MO.



26
27
28
# File 'lib/intersight_client/models/bulk_exported_item_all_of.rb', line 26

def export_tags
  @export_tags
end

#file_nameObject

Name of the file corresponding to item MO.



29
30
31
# File 'lib/intersight_client/models/bulk_exported_item_all_of.rb', line 29

def file_name
  @file_name
end

#itemObject

Returns the value of attribute item.



31
32
33
# File 'lib/intersight_client/models/bulk_exported_item_all_of.rb', line 31

def item
  @item
end

#nameObject

MO item identity (the moref corresponding to item) expressed as a string.



34
35
36
# File 'lib/intersight_client/models/bulk_exported_item_all_of.rb', line 34

def name
  @name
end

#object_typeObject

The fully-qualified name of the instantiated, concrete type. The value should be the same as the ‘ClassId’ property.



23
24
25
# File 'lib/intersight_client/models/bulk_exported_item_all_of.rb', line 23

def object_type
  @object_type
end

#parent_itemObject

Returns the value of attribute parent_item.



50
51
52
# File 'lib/intersight_client/models/bulk_exported_item_all_of.rb', line 50

def parent_item
  @parent_item
end

An array of relationships to bulkExportedItem resources.



53
54
55
# File 'lib/intersight_client/models/bulk_exported_item_all_of.rb', line 53

def related_items
  @related_items
end

#service_nameObject

Name of the service that owns the item MO.



37
38
39
# File 'lib/intersight_client/models/bulk_exported_item_all_of.rb', line 37

def service_name
  @service_name
end

#service_versionObject

Version of the service that owns the item MO.



40
41
42
# File 'lib/intersight_client/models/bulk_exported_item_all_of.rb', line 40

def service_version
  @service_version
end

#statusObject

Status of the item’s export operation. * “ - The operation has not started. * ValidationInProgress - The validation operation is in progress. * Valid - The content to be imported is valid. * InValid - The content to be imported is not valid and the status message will have the reason. * InProgress - The operation is in progress. * Success - The operation has succeeded. * Failed - The operation has failed. * RollBackInitiated - The rollback has been inititiated for import failure. * RollBackFailed - The rollback has failed for import failure. * RollbackCompleted - The rollback has completed for import failure. * RollbackAborted - The rollback has been aborted for import failure. * OperationTimedOut - The operation has timed out. * OperationCancelled - The operation has been cancelled. * CancelInProgress - The operation is being cancelled.



43
44
45
# File 'lib/intersight_client/models/bulk_exported_item_all_of.rb', line 43

def status
  @status
end

#status_messageObject

Progress or error message for the MO’s export operation.



46
47
48
# File 'lib/intersight_client/models/bulk_exported_item_all_of.rb', line 46

def status_message
  @status_message
end

Class Method Details

.acceptable_attribute_mapObject

Returns the key-value map of all the JSON attributes this model knows about



102
103
104
# File 'lib/intersight_client/models/bulk_exported_item_all_of.rb', line 102

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



97
98
99
# File 'lib/intersight_client/models/bulk_exported_item_all_of.rb', line 97

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'export_tags' => :'ExportTags',
    :'file_name' => :'FileName',
    :'item' => :'Item',
    :'name' => :'Name',
    :'service_name' => :'ServiceName',
    :'service_version' => :'ServiceVersion',
    :'status' => :'Status',
    :'status_message' => :'StatusMessage',
    :'export' => :'Export',
    :'parent_item' => :'ParentItem',
    :'related_items' => :'RelatedItems'
  }
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



304
305
306
# File 'lib/intersight_client/models/bulk_exported_item_all_of.rb', line 304

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

.openapi_nullableObject

List of attributes with nullable: true



126
127
128
129
130
# File 'lib/intersight_client/models/bulk_exported_item_all_of.rb', line 126

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

.openapi_typesObject

Attribute type mapping.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'lib/intersight_client/models/bulk_exported_item_all_of.rb', line 107

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'export_tags' => :'Boolean',
    :'file_name' => :'String',
    :'item' => :'MoMoRef',
    :'name' => :'String',
    :'service_name' => :'String',
    :'service_version' => :'String',
    :'status' => :'String',
    :'status_message' => :'String',
    :'export' => :'BulkExportRelationship',
    :'parent_item' => :'BulkExportedItemRelationship',
    :'related_items' => :'Array<BulkExportedItemRelationship>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
# File 'lib/intersight_client/models/bulk_exported_item_all_of.rb', line 271

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      export_tags == o.export_tags &&
      file_name == o.file_name &&
      item == o.item &&
      name == o.name &&
      service_name == o.service_name &&
      service_version == o.service_version &&
      status == o.status &&
      status_message == o.status_message &&
      export == o.export &&
      parent_item == o.parent_item &&
      related_items == o.related_items
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



334
335
336
337
338
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
# File 'lib/intersight_client/models/bulk_exported_item_all_of.rb', line 334

def _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 = IntersightClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



405
406
407
408
409
410
411
412
413
414
415
416
417
# File 'lib/intersight_client/models/bulk_exported_item_all_of.rb', line 405

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



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
# File 'lib/intersight_client/models/bulk_exported_item_all_of.rb', line 311

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


291
292
293
# File 'lib/intersight_client/models/bulk_exported_item_all_of.rb', line 291

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



297
298
299
# File 'lib/intersight_client/models/bulk_exported_item_all_of.rb', line 297

def hash
  [class_id, object_type, export_tags, file_name, item, name, service_name, service_version, status, status_message, export, parent_item, related_items].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



212
213
214
215
216
217
218
219
220
221
222
223
# File 'lib/intersight_client/models/bulk_exported_item_all_of.rb', line 212

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



381
382
383
# File 'lib/intersight_client/models/bulk_exported_item_all_of.rb', line 381

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



387
388
389
390
391
392
393
394
395
396
397
398
399
# File 'lib/intersight_client/models/bulk_exported_item_all_of.rb', line 387

def to_hash
  hash = {}
  BulkExportedItemAllOf.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = BulkExportedItemAllOf.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



375
376
377
# File 'lib/intersight_client/models/bulk_exported_item_all_of.rb', line 375

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



227
228
229
230
231
232
233
234
235
236
237
# File 'lib/intersight_client/models/bulk_exported_item_all_of.rb', line 227

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["bulk.ExportedItem"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["bulk.ExportedItem"])
  return false unless object_type_validator.valid?(@object_type)
  status_validator = EnumAttributeValidator.new('String', ["", "ValidationInProgress", "Valid", "InValid", "InProgress", "Success", "Failed", "RollBackInitiated", "RollBackFailed", "RollbackCompleted", "RollbackAborted", "OperationTimedOut", "OperationCancelled", "CancelInProgress"])
  return false unless status_validator.valid?(@status)
  true
end