Class: VSphereAutomation::VAPI::VapiMetadataCliCommandOptionInfo

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VapiMetadataCliCommandOptionInfo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



57
58
59
60
61
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
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_cli_command_option_info.rb', line 57

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

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

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

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

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

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

Instance Attribute Details

#description ⇒ Object

The description of the option to be displayed to the user when they request usage information for a CLI command.



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

def description
  @description
end

#field_name ⇒ Object

The fully qualified name of the option referred to by the operation element in Info#operationId.



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

def field_name
  @field_name
end

#generic ⇒ Object

Returns the value of attribute generic.



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

def generic
  @generic
end

#long_option ⇒ Object

The long option name of the parameter as used by the user.



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

def long_option
  @long_option
end

#short_option ⇒ Object

The single character value option name.



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

def short_option
  @short_option
end

#type ⇒ Object

The type of option. This is used to display information about what kind of data is expected (string, number, boolean, etc.) for the option when they request usage information for a CLI command. For enumerated type this stores the fully qualified enumerated type id.



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
40
41
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_cli_command_option_info.rb', line 32

def self.attribute_map
  {
    :'long_option' => :'long_option',
    :'short_option' => :'short_option',
    :'field_name' => :'field_name',
    :'description' => :'description',
    :'type' => :'type',
    :'generic' => :'generic'
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
52
53
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_cli_command_option_info.rb', line 44

def self.openapi_types
  {
    :'long_option' => :'String',
    :'short_option' => :'String',
    :'field_name' => :'String',
    :'description' => :'String',
    :'type' => :'String',
    :'generic' => :'VapiMetadataCliCommandGenericType'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



128
129
130
131
132
133
134
135
136
137
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_cli_command_option_info.rb', line 128

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      long_option == o.long_option &&
      short_option == o.short_option &&
      field_name == o.field_name &&
      description == o.description &&
      type == o.type &&
      generic == o.generic
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



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
209
210
211
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_cli_command_option_info.rb', line 175

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



241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_cli_command_option_info.rb', line 241

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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_cli_command_option_info.rb', line 154

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


141
142
143
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_cli_command_option_info.rb', line 141

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



147
148
149
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_cli_command_option_info.rb', line 147

def hash
  [long_option, short_option, field_name, description, type, generic].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



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_cli_command_option_info.rb', line 90

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

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

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

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

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



221
222
223
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_cli_command_option_info.rb', line 221

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



227
228
229
230
231
232
233
234
235
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_cli_command_option_info.rb', line 227

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



215
216
217
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_cli_command_option_info.rb', line 215

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



117
118
119
120
121
122
123
124
 
# File 'lib/vsphere-automation-vapi/models/vapi_metadata_cli_command_option_info.rb', line 117

def valid?
  return false if @long_option.nil?
  return false if @field_name.nil?
  return false if @description.nil?
  return false if @type.nil?
  return false if @generic.nil?
  true
end