Class: VSphereAutomation::VAPI::VapiMetadataMetamodelEnumerationInfo

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VapiMetadataMetamodelEnumerationInfo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_metamodel_enumeration_info.rb', line 48

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?(:'values')
    if (value = attributes[:'values']).is_a?(Array)
      self.values = 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

#documentation ⇒ Object

English language documentation for an enumeration element. It can contain HTML markup and Javadoc tags. The first sentence of the enumeration documentation is a complete sentence that identifies the enumeration by name and summarizes the purpose of the enumeration. The documentation describes the context in which the enumeration is used. <p> The documentation also contains references to the context in which the enumeration is used. But if the enumeration is used in many contexts, the references may not be present.



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

def documentation
  @documentation
end

#metadata ⇒ Object

Generic metadata elements for an enumeration 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.



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

def metadata
  @metadata
end

#name ⇒ Object

Dot separated name of the enumeration 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_enumeration_info.rb', line 15

def name
  @name
end

#values ⇒ Object

Metamodel information of all the enumeration value elements contained in this enumeration element. The order of the enumeration value elements in the list is same as the order in which they are defined in the interface definition file.



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

def values
  @values
end

Class Method Details

.attribute_map ⇒ Object

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



27
28
29
30
31
32
33
34
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_metamodel_enumeration_info.rb', line 27

def self.attribute_map
  {
    :'name' => :'name',
    :'values' => :'values',
    :'metadata' => :'metadata',
    :'documentation' => :'documentation'
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'name' => :'String',
    :'values' => :'Array<VapiMetadataMetamodelEnumerationValueInfo>',
    :'metadata' => :'Array<VapiMetadataMetamodelComponentInfoMetadata>',
    :'documentation' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



110
111
112
113
114
115
116
117
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_metamodel_enumeration_info.rb', line 110

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      values == o.values &&
      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



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

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



221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_metamodel_enumeration_info.rb', line 221

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



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_metamodel_enumeration_info.rb', line 134

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


121
122
123
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_metamodel_enumeration_info.rb', line 121

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



127
128
129
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_metamodel_enumeration_info.rb', line 127

def hash
  [name, values, 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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_metamodel_enumeration_info.rb', line 77

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

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



201
202
203
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_metamodel_enumeration_info.rb', line 201

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



207
208
209
210
211
212
213
214
215
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_metamodel_enumeration_info.rb', line 207

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



195
196
197
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_metamodel_enumeration_info.rb', line 195

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



100
101
102
103
104
105
106
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_metamodel_enumeration_info.rb', line 100

def valid?
  return false if @name.nil?
  return false if @values.nil?
  return false if @metadata.nil?
  return false if @documentation.nil?
  true
end