Class: VSphereAutomation::VAPI::VapiMetadataMetamodelStructureInfo

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VapiMetadataMetamodelStructureInfo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
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/vsphere-automation-vapi/models/vapi_metadata_metamodel_structure_info.rb', line 62

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?(:'name')
    self.name = attributes[:'name']
  end

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

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

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

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

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

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

Instance Attribute Details

#constants ⇒ Object

Metamodel information of all the constant elements contained in the structure element. The key in the map is the name of the constant element and the value in the map is the metamodel information for the constant element.



23
24
25
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_metamodel_structure_info.rb', line 23

def constants
  @constants
end

#documentation ⇒ Object

English language documentation for a structure element. It can contain HTML markup and Javadoc tags. The first sentence of the structure documentation is a complete sentence that identifies the structure by name and summarizes the purpose of the structure.



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

def documentation
  @documentation
end

#enumerations ⇒ Object

Metamodel information of all the enumeration elements contained in the structure element. The key in the map is the identifier of the enumeration element and the value is the metamodel information of the enumeration element.



20
21
22
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_metamodel_structure_info.rb', line 20

def enumerations
  @enumerations
end

#fields ⇒ Object

Metamodel information of all the field elements. The order of the field elements in the list matches the order in which the fields are defined in the service.



26
27
28
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_metamodel_structure_info.rb', line 26

def fields
  @fields
end

#metadata ⇒ Object

Generic metadata elements for the structure element. The key in the map is the name of the metadata element and the value is the data associated with that metadata element. <p> The vapi.metadata.metamodel.MetadataIdentifier contains possible string values for keys in the map.



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

def metadata
  @metadata
end

#name ⇒ Object

Dot separated name of the structure element. The segments in the name reflect the organization of the APIs. The format of each segment is lower case with underscores. Each underscore represents a word boundary. If there are acronyms in the word, the capitalization is preserved. This format makes it easy to translate the segment into a different naming convention.



15
16
17
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_metamodel_structure_info.rb', line 15

def name
  @name
end

#type ⇒ Object

Returns the value of attribute type.



17
18
19
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_metamodel_structure_info.rb', line 17

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_metamodel_structure_info.rb', line 35

def self.attribute_map
  {
    :'name' => :'name',
    :'type' => :'type',
    :'enumerations' => :'enumerations',
    :'constants' => :'constants',
    :'fields' => :'fields',
    :'metadata' => :'metadata',
    :'documentation' => :'documentation'
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_metamodel_structure_info.rb', line 48

def self.openapi_types
  {
    :'name' => :'String',
    :'type' => :'VapiMetadataMetamodelStructureInfoType',
    :'enumerations' => :'Array<VapiMetadataMetamodelPackageInfoEnumerations>',
    :'constants' => :'Array<VapiMetadataMetamodelServiceInfoConstants>',
    :'fields' => :'Array<VapiMetadataMetamodelFieldInfo>',
    :'metadata' => :'Array<VapiMetadataMetamodelComponentInfoMetadata>',
    :'documentation' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_metamodel_structure_info.rb', line 155

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      type == o.type &&
      enumerations == o.enumerations &&
      constants == o.constants &&
      fields == o.fields &&
      metadata == o.metadata &&
      documentation == o.documentation
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



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
232
233
234
235
236
237
238
239
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_metamodel_structure_info.rb', line 203

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::VAPI.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



269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_metamodel_structure_info.rb', line 269

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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_metamodel_structure_info.rb', line 182

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


169
170
171
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_metamodel_structure_info.rb', line 169

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



175
176
177
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_metamodel_structure_info.rb', line 175

def hash
  [name, type, enumerations, constants, fields, metadata, documentation].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



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
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_metamodel_structure_info.rb', line 107

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

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

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

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

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

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

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



249
250
251
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_metamodel_structure_info.rb', line 249

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



255
256
257
258
259
260
261
262
263
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_metamodel_structure_info.rb', line 255

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



243
244
245
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_metamodel_structure_info.rb', line 243

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



142
143
144
145
146
147
148
149
150
151
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_metamodel_structure_info.rb', line 142

def valid?
  return false if @name.nil?
  return false if @type.nil?
  return false if @enumerations.nil?
  return false if @constants.nil?
  return false if @fields.nil?
  return false if @metadata.nil?
  return false if @documentation.nil?
  true
end