Class: IntersightClient::AssetConnectionControlMessage

Inherits:
MoBaseComplexType show all
Defined in:
lib/intersight_client/models/asset_connection_control_message.rb

Overview

Control message used to update the context of a devices connection. When a device registration is modified (e.g. by a user modifying the claim status) the process managing the connection must be notified of the change. On changes aurora will attempt to send the change to the current owner of the connection.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AssetConnectionControlMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/intersight_client/models/asset_connection_control_message.rb', line 134

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

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

  # call parent's initialize
  super(attributes)

  if attributes.key?(:'class_id')
    self.class_id = attributes[:'class_id']
  else
    self.class_id = 'asset.ConnectionControlMessage'
  end

  if attributes.key?(:'object_type')
    self.object_type = attributes[:'object_type']
  else
    self.object_type = 'asset.ConnectionControlMessage'
  end

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

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

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

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

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

  if attributes.key?(:'leadership')
    self.leadership = attributes[:'leadership']
  else
    self.leadership = 'Unknown'
  end

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

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

Instance Attribute Details

#account ⇒ Object

The account id to which the device belongs.



26
27
28
 
# File 'lib/intersight_client/models/asset_connection_control_message.rb', line 26

def 
  @account
end

#class_id ⇒ Object

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.



20
21
22
 
# File 'lib/intersight_client/models/asset_connection_control_message.rb', line 20

def class_id
  @class_id
end

#connector_version ⇒ Object

The version of the device connector currently running on the platform. Deprecated by newer connectors that will report this directly to the device connector gateway in a websocket header, but included to continue to support older versions which report any version change after connect.



29
30
31
 
# File 'lib/intersight_client/models/asset_connection_control_message.rb', line 29

def connector_version
  @connector_version
end

#device_id ⇒ Object

The Moid of the device under change. Used to route the message to a devices connection.



32
33
34
 
# File 'lib/intersight_client/models/asset_connection_control_message.rb', line 32

def device_id
  @device_id
end

#domain_group ⇒ Object

The domain group id to which the device belongs.



35
36
37
 
# File 'lib/intersight_client/models/asset_connection_control_message.rb', line 35

def domain_group
  @domain_group
end

#evict ⇒ Object

Flag to force any open connections to be evicted. Used in case device has been deleted or blacklisted.



38
39
40
 
# File 'lib/intersight_client/models/asset_connection_control_message.rb', line 38

def evict
  @evict
end

#leadership ⇒ Object

The current leadership of a device cluster member. * ‘Unknown` - The node is unable to complete election or determine the current state. If the device has been registered before and the node has access to the current credentials it will establish a connection to Intersight with limited capabilities that can be used to debug the HA failure from Intersight. * `Primary` - The node has been elected as the primary and will establish a connection to the Intersight service and accept all message types enabled for a primary node. There can only be one primary in a given cluster, while the underlying platform may be active-active only one connector will assume the primary role. * `Secondary` - The node has been elected as a secondary node in the cluster. The device connector will establish a connection to the Intersight service with limited capabilities. e.g. file upload will be enabled, but requests to the underlying platform management will be disabled.



41
42
43
 
# File 'lib/intersight_client/models/asset_connection_control_message.rb', line 41

def leadership
  @leadership
end

#new_identity ⇒ Object

The new identity assigned to a device on ownership change (claim/unclaim).



44
45
46
 
# File 'lib/intersight_client/models/asset_connection_control_message.rb', line 44

def new_identity
  @new_identity
end

#object_type ⇒ Object

The fully-qualified name of the instantiated, concrete type. The value should be the same as the ‘ClassId’ property.



23
24
25
 
# File 'lib/intersight_client/models/asset_connection_control_message.rb', line 23

def object_type
  @object_type
end

#partition ⇒ Object

The partition the device was last connected to, used to address the control message to the device connector gateway instance holding the devices connection.



47
48
49
 
# File 'lib/intersight_client/models/asset_connection_control_message.rb', line 47

def partition
  @partition
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns the key-value map of all the JSON attributes this model knows about, including the ones defined in its parent(s)



93
94
95
 
# File 'lib/intersight_client/models/asset_connection_control_message.rb', line 93

def self.acceptable_attribute_map
  attribute_map.merge(superclass.acceptable_attribute_map)
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about, including the ones defined in its parent(s)



88
89
90
 
# File 'lib/intersight_client/models/asset_connection_control_message.rb', line 88

def self.acceptable_attributes
  attribute_map.values.concat(superclass.acceptable_attributes)
end

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/intersight_client/models/asset_connection_control_message.rb', line 72

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'account' => :'Account',
    :'connector_version' => :'ConnectorVersion',
    :'device_id' => :'DeviceId',
    :'domain_group' => :'DomainGroup',
    :'evict' => :'Evict',
    :'leadership' => :'Leadership',
    :'new_identity' => :'NewIdentity',
    :'partition' => :'Partition'
  }
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



288
289
290
 
# File 'lib/intersight_client/models/asset_connection_control_message.rb', line 288

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



120
121
122
123
124
125
 
# File 'lib/intersight_client/models/asset_connection_control_message.rb', line 120

def self.openapi_all_of
  [
  :'AssetConnectionControlMessageAllOf',
  :'MoBaseComplexType'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



128
129
130
 
# File 'lib/intersight_client/models/asset_connection_control_message.rb', line 128

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



114
115
116
117
 
# File 'lib/intersight_client/models/asset_connection_control_message.rb', line 114

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/intersight_client/models/asset_connection_control_message.rb', line 98

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'account' => :'String',
    :'connector_version' => :'String',
    :'device_id' => :'String',
    :'domain_group' => :'String',
    :'evict' => :'Boolean',
    :'leadership' => :'String',
    :'new_identity' => :'String',
    :'partition' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/intersight_client/models/asset_connection_control_message.rb', line 258

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
       == o. &&
      connector_version == o.connector_version &&
      device_id == o.device_id &&
      domain_group == o.domain_group &&
      evict == o.evict &&
      leadership == o.leadership &&
      new_identity == o.new_identity &&
      partition == o.partition && super(o)
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



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/intersight_client/models/asset_connection_control_message.rb', line 319

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :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
    # models (e.g. Pet) or oneOf
    klass = IntersightClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/intersight_client/models/asset_connection_control_message.rb', line 390

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



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/intersight_client/models/asset_connection_control_message.rb', line 295

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


275
276
277
 
# File 'lib/intersight_client/models/asset_connection_control_message.rb', line 275

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



281
282
283
 
# File 'lib/intersight_client/models/asset_connection_control_message.rb', line 281

def hash
  [class_id, object_type, , connector_version, device_id, domain_group, evict, leadership, new_identity, partition].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



199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/intersight_client/models/asset_connection_control_message.rb', line 199

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

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



366
367
368
 
# File 'lib/intersight_client/models/asset_connection_control_message.rb', line 366

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



372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/intersight_client/models/asset_connection_control_message.rb', line 372

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

    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



360
361
362
 
# File 'lib/intersight_client/models/asset_connection_control_message.rb', line 360

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



214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/intersight_client/models/asset_connection_control_message.rb', line 214

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["asset.ConnectionControlMessage"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["asset.ConnectionControlMessage"])
  return false unless object_type_validator.valid?(@object_type)
  leadership_validator = EnumAttributeValidator.new('String', ["Unknown", "Primary", "Secondary"])
  return false unless leadership_validator.valid?(@leadership)
  true && super
end