Class: NutanixClustermgmt::ClustermgmtV40ConfigSnmpUser

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_user.rb

Overview

SNMP user information.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ ClustermgmtV40ConfigSnmpUser

Initializes the object

Parameters:

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

    Model attributes in the form of hash



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
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
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_user.rb', line 117

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `NutanixClustermgmt::ClustermgmtV40ConfigSnmpUser` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `NutanixClustermgmt::ClustermgmtV40ConfigSnmpUser`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

Instance Attribute Details

#auth_key ⇒ Object

SNMP user authentication key.



34
35
36
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_user.rb', line 34

def auth_key
  @auth_key
end

#auth_type ⇒ Object

Returns the value of attribute auth_type.



31
32
33
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_user.rb', line 31

def auth_type
  @auth_type
end

#ext_id ⇒ Object

A globally unique identifier of an instance that is suitable for external consumption.



23
24
25
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_user.rb', line 23

def ext_id
  @ext_id
end

#links ⇒ Object

A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.



26
27
28
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_user.rb', line 26

def links
  @links
end

#priv_key ⇒ Object

SNMP user encryption key.



39
40
41
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_user.rb', line 39

def priv_key
  @priv_key
end

#priv_type ⇒ Object

Returns the value of attribute priv_type.



36
37
38
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_user.rb', line 36

def priv_type
  @priv_type
end

#tenant_id ⇒ Object

A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this Id to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server).



20
21
22
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_user.rb', line 20

def tenant_id
  @tenant_id
end

#username ⇒ Object

SNMP username. For SNMP trap v3 version, SNMP username is required parameter.



29
30
31
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_user.rb', line 29

def username
  @username
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



78
79
80
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_user.rb', line 78

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



83
84
85
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_user.rb', line 83

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_user.rb', line 64

def self.attribute_map
  {
    :'tenant_id' => :'tenantId',
    :'ext_id' => :'extId',
    :'links' => :'links',
    :'username' => :'username',
    :'auth_type' => :'authType',
    :'auth_key' => :'authKey',
    :'priv_type' => :'privType',
    :'priv_key' => :'privKey'
  }
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



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_user.rb', line 369

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



109
110
111
112
113
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_user.rb', line 109

def self.openapi_all_of
  [
  :'CommonV10ResponseExternalizableAbstractModel'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



102
103
104
105
106
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_user.rb', line 102

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

.openapi_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_user.rb', line 88

def self.openapi_types
  {
    :'tenant_id' => :'String',
    :'ext_id' => :'String',
    :'links' => :'Array<CommonV10ResponseApiLink>',
    :'username' => :'String',
    :'auth_type' => :'ClustermgmtV40ConfigSnmpAuthType',
    :'auth_key' => :'String',
    :'priv_type' => :'ClustermgmtV40ConfigSnmpPrivType',
    :'priv_key' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_user.rb', line 341

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      tenant_id == o.tenant_id &&
      ext_id == o.ext_id &&
      links == o.links &&
      username == o.username &&
      auth_type == o.auth_type &&
      auth_key == o.auth_key &&
      priv_type == o.priv_type &&
      priv_key == o.priv_key
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


356
357
358
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_user.rb', line 356

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



362
363
364
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_user.rb', line 362

def hash
  [tenant_id, ext_id, links, username, auth_type, auth_key, priv_type, priv_key].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



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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_user.rb', line 174

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  pattern = Regexp.new(/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)
  if !@tenant_id.nil? && @tenant_id !~ pattern
    invalid_properties.push("invalid value for \"tenant_id\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)
  if !@ext_id.nil? && @ext_id !~ pattern
    invalid_properties.push("invalid value for \"ext_id\", must conform to the pattern #{pattern}.")
  end

  if !@links.nil? && @links.length > 20
    invalid_properties.push('invalid value for "links", number of items must be less than or equal to 20.')
  end

  if !@links.nil? && @links.length < 0
    invalid_properties.push('invalid value for "links", number of items must be greater than or equal to 0.')
  end

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

  if @username.to_s.length > 64
    invalid_properties.push('invalid value for "username", the character length must be smaller than or equal to 64.')
  end

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

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

  pattern = Regexp.new(/^[^']+$/)
  if @auth_key !~ pattern
    invalid_properties.push("invalid value for \"auth_key\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^[^']+$/)
  if !@priv_key.nil? && @priv_key !~ pattern
    invalid_properties.push("invalid value for \"priv_key\", must conform to the pattern #{pattern}.")
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_user.rb', line 391

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

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

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_user.rb', line 226

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@tenant_id.nil? && @tenant_id !~ Regexp.new(/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)
  return false if !@ext_id.nil? && @ext_id !~ Regexp.new(/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)
  return false if !@links.nil? && @links.length > 20
  return false if !@links.nil? && @links.length < 0
  return false if @username.nil?
  return false if @username.to_s.length > 64
  return false if @auth_type.nil?
  return false if @auth_key.nil?
  return false if @auth_key !~ Regexp.new(/^[^']+$/)
  return false if !@priv_key.nil? && @priv_key !~ Regexp.new(/^[^']+$/)
  true
end