Class: IntersightClient::AssetClusterMember

Inherits:
AssetDeviceConnection show all
Defined in:
lib/intersight_client/models/asset_cluster_member.rb

Overview

A node within a cluster of device connectors. A Device Registration may contain multiple ClusterMembers with each holding the connection details of the device connector as well as the nodes current leadership within the cluster.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from AssetDeviceConnection

#api_version, #app_partition_number, #connection_id, #connection_reason, #connection_status, #connection_status_last_change_time, #connector_version, #device_external_ip_address, #proxy_app

Attributes inherited from MoBaseMo

#account_moid, #ancestors, #create_time, #display_names, #domain_group_moid, #mod_time, #moid, #owners, #parent, #permission_resources, #shared_scope, #tags, #version_context

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AssetClusterMember

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



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
171
172
173
174
175
176
 
# File 'lib/intersight_client/models/asset_cluster_member.rb', line 123

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IntersightClient::AssetClusterMember` 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.ClusterMember'
  end

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

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

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

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

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

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

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

Instance Attribute Details

#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_cluster_member.rb', line 20

def class_id
  @class_id
end

#device ⇒ Object

Returns the value of attribute device.



39
40
41
 
# File 'lib/intersight_client/models/asset_cluster_member.rb', line 39

def device
  @device
end

#leadership ⇒ Object

The current leadershipstate of this member. Updated by the device connector on failover or leadership change. If a member is elected as Primary within the cluster this connection will be the same as the DeviceRegistration connection. E.g a message addressed to the DeviceRegistration will be forwarded to the ClusterMember connection. * ‘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.



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

def leadership
  @leadership
end

#locked_leader ⇒ Object

Devices lock their leadership on failure to heartbeat with peers. Value acts as a third party tie breaker in election between nodes. Intersight enforces that only one cluster member exists with this value set to true.



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

def locked_leader
  @locked_leader
end

#member_identity ⇒ Object

The unique identity of the member within the cluster. The identity is retrieved from the platform and reported by the device connector at connection time.



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

def member_identity
  @member_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_cluster_member.rb', line 23

def object_type
  @object_type
end

#parent_cluster_member_identity ⇒ Object

The member idenity of the cluster member through which this device is connected if applicable.



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

def parent_cluster_member_identity
  @parent_cluster_member_identity
end

#sudi ⇒ Object

Returns the value of attribute sudi.



37
38
39
 
# File 'lib/intersight_client/models/asset_cluster_member.rb', line 37

def sudi
  @sudi
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)



83
84
85
 
# File 'lib/intersight_client/models/asset_cluster_member.rb', line 83

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)



78
79
80
 
# File 'lib/intersight_client/models/asset_cluster_member.rb', line 78

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.



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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'leadership' => :'Leadership',
    :'locked_leader' => :'LockedLeader',
    :'member_identity' => :'MemberIdentity',
    :'parent_cluster_member_identity' => :'ParentClusterMemberIdentity',
    :'sudi' => :'Sudi',
    :'device' => :'Device'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



267
268
269
 
# File 'lib/intersight_client/models/asset_cluster_member.rb', line 267

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



109
110
111
112
113
114
 
# File 'lib/intersight_client/models/asset_cluster_member.rb', line 109

def self.openapi_all_of
  [
  :'AssetClusterMemberAllOf',
  :'AssetDeviceConnection'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



117
118
119
 
# File 'lib/intersight_client/models/asset_cluster_member.rb', line 117

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



102
103
104
105
106
 
# File 'lib/intersight_client/models/asset_cluster_member.rb', line 102

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'leadership' => :'String',
    :'locked_leader' => :'Boolean',
    :'member_identity' => :'String',
    :'parent_cluster_member_identity' => :'String',
    :'sudi' => :'AssetSudiInfo',
    :'device' => :'AssetDeviceRegistrationRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/intersight_client/models/asset_cluster_member.rb', line 239

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      leadership == o.leadership &&
      locked_leader == o.locked_leader &&
      member_identity == o.member_identity &&
      parent_cluster_member_identity == o.parent_cluster_member_identity &&
      sudi == o.sudi &&
      device == o.device && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type Data type

  • value Value to be deserialized

Returns:

  • Deserialized data



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/intersight_client/models/asset_cluster_member.rb', line 298

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:

  • Any valid value

Returns:

  • Returns the value in the form of hash



369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/intersight_client/models/asset_cluster_member.rb', line 369

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:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/intersight_client/models/asset_cluster_member.rb', line 274

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • to be compared

Returns:

See Also:

  • `==` method


254
255
256
 
# File 'lib/intersight_client/models/asset_cluster_member.rb', line 254

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



260
261
262
 
# File 'lib/intersight_client/models/asset_cluster_member.rb', line 260

def hash
  [class_id, object_type, leadership, locked_leader, member_identity, parent_cluster_member_identity, sudi, device].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



180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/intersight_client/models/asset_cluster_member.rb', line 180

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:

  • Returns the object in the form of hash



345
346
347
 
# File 'lib/intersight_client/models/asset_cluster_member.rb', line 345

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/intersight_client/models/asset_cluster_member.rb', line 351

def to_hash
  hash = super
  AssetClusterMember.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = AssetClusterMember.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 presentation of the object



339
340
341
 
# File 'lib/intersight_client/models/asset_cluster_member.rb', line 339

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • true if the model is valid



195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/intersight_client/models/asset_cluster_member.rb', line 195

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["asset.ClusterMember"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["asset.ClusterMember"])
  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