Class: NutanixClustermgmt::ClustermgmtV40ConfigSnmpTrap

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

Overview

SNMP trap details.

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 = {}) ⇒ ClustermgmtV40ConfigSnmpTrap

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_trap.rb', line 136

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `NutanixClustermgmt::ClustermgmtV40ConfigSnmpTrap` 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::ClustermgmtV40ConfigSnmpTrap`. 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?(:'address')
    self.address = attributes[:'address']
  else
    self.address = nil
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



28
29
30
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_trap.rb', line 28

def address
  @address
end

#community_string ⇒ Object

Community string(plaintext) for SNMP version 2.0.



50
51
52
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_trap.rb', line 50

def community_string
  @community_string
end

#engine_id ⇒ Object

SNMP engine Id.



42
43
44
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_trap.rb', line 42

def engine_id
  @engine_id
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_trap.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_trap.rb', line 26

def links
  @links
end

#port ⇒ Object

SNMP port.



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

def port
  @port
end

#protocol ⇒ Object

Returns the value of attribute protocol.



33
34
35
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_trap.rb', line 33

def protocol
  @protocol
end

#reciever_name ⇒ Object

SNMP receiver name.



47
48
49
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_trap.rb', line 47

def reciever_name
  @reciever_name
end

#should_inform ⇒ Object

SNMP information status.



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

def should_inform
  @should_inform
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_trap.rb', line 20

def tenant_id
  @tenant_id
end

#username ⇒ Object

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



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

def username
  @username
end

#version ⇒ Object

Returns the value of attribute version.



44
45
46
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_trap.rb', line 44

def version
  @version
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



93
94
95
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_trap.rb', line 93

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



98
99
100
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_trap.rb', line 98

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_trap.rb', line 75

def self.attribute_map
  {
    :'tenant_id' => :'tenantId',
    :'ext_id' => :'extId',
    :'links' => :'links',
    :'address' => :'address',
    :'username' => :'username',
    :'protocol' => :'protocol',
    :'port' => :'port',
    :'should_inform' => :'shouldInform',
    :'engine_id' => :'engineId',
    :'version' => :'version',
    :'reciever_name' => :'recieverName',
    :'community_string' => :'communityString'
  }
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



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_trap.rb', line 409

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)



128
129
130
131
132
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_trap.rb', line 128

def self.openapi_all_of
  [
  :'CommonV10ResponseExternalizableAbstractModel'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



121
122
123
124
125
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_trap.rb', line 121

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

.openapi_types ⇒ Object

Attribute type mapping.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_trap.rb', line 103

def self.openapi_types
  {
    :'tenant_id' => :'String',
    :'ext_id' => :'String',
    :'links' => :'Array<CommonV10ResponseApiLink>',
    :'address' => :'CommonV10ConfigIPAddress',
    :'username' => :'String',
    :'protocol' => :'ClustermgmtV40ConfigSnmpProtocol',
    :'port' => :'Integer',
    :'should_inform' => :'Boolean',
    :'engine_id' => :'String',
    :'version' => :'ClustermgmtV40ConfigSnmpTrapVersion',
    :'reciever_name' => :'String',
    :'community_string' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_trap.rb', line 377

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 &&
      address == o.address &&
      username == o.username &&
      protocol == o.protocol &&
      port == o.port &&
      should_inform == o.should_inform &&
      engine_id == o.engine_id &&
      version == o.version &&
      reciever_name == o.reciever_name &&
      community_string == o.community_string
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


396
397
398
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_trap.rb', line 396

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



402
403
404
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_trap.rb', line 402

def hash
  [tenant_id, ext_id, links, address, username, protocol, port, should_inform, engine_id, version, reciever_name, community_string].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



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
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_trap.rb', line 207

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 @address.nil?
    invalid_properties.push('invalid value for "address", address cannot be nil.')
  end

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

  pattern = Regexp.new(/^(?:0[xX])?[0-9a-fA-F]+$/)
  if !@engine_id.nil? && @engine_id !~ pattern
    invalid_properties.push("invalid value for \"engine_id\", must conform to the pattern #{pattern}.")
  end

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

  if !@reciever_name.nil? && @reciever_name.to_s.length > 64
    invalid_properties.push('invalid value for "reciever_name", the character length must be smaller than or equal to 64.')
  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



431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_trap.rb', line 431

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



254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/nutanix_clustermgmt/models/clustermgmt_v40_config_snmp_trap.rb', line 254

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 @address.nil?
  return false if !@username.nil? && @username.to_s.length > 64
  return false if !@engine_id.nil? && @engine_id !~ Regexp.new(/^(?:0[xX])?[0-9a-fA-F]+$/)
  return false if @version.nil?
  return false if !@reciever_name.nil? && @reciever_name.to_s.length > 64
  true
end