Class: IntersightClient::AssetDeviceConnection

Inherits:
MoBaseMo
  • Object
show all
Defined in:
lib/intersight_client/models/asset_device_connection.rb

Overview

An abstract class that holds the details of a device connectors connection to Intersight.

Direct Known Subclasses

AssetClusterMember, AssetDeviceRegistration

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

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

Initializes the object



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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#api_version ⇒ Object

The version of the connector API, describes the capability of the connector’s framework. If the version is lower than the current minimum supported version defined in the service managing the connection, the device connector will be connected with limited capabilities until the device connector is upgraded to a fully supported version. For example if a device connector that was released without delta inventory capabilities registers and connects to Intersight, inventory collection may be disabled until it has been upgraded.



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

def api_version
  @api_version
end

#app_partition_number ⇒ Object

The partition number corresponding to the instance of the Proxy App which is managing the web-socket to the device connector.



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

def app_partition_number
  @app_partition_number
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. The enum values provides the list of concrete types that can be instantiated from this abstract type.



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

def class_id
  @class_id
end

#connection_id ⇒ Object

The unique identifier for the current connection. The identifier persists across network connectivity loss and is reset on device connector process restart or platform administrator toggle of the Intersight connectivity. The connectionId can be used by services that need to interact with stateful plugins running in the device connector process. For example if a service schedules an inventory in a devices job scheduler plugin at registration it is not necessary to reschedule the job if the device loses network connectivity due to an Intersight service upgrade or intermittent network issues in the devices datacenter.



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

def connection_id
  @connection_id
end

#connection_reason ⇒ Object

If ‘connectionStatus’ is not equal to Connected, connectionReason provides further details about why the device is not connected with Intersight.



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

def connection_reason
  @connection_reason
end

#connection_status ⇒ Object

The status of the persistent connection between the device connector and Intersight. * “ - The target details have been persisted but Intersight has not yet attempted to connect to the target. * ‘Connected` - Intersight is able to establish a connection to the target and initiate management activities. * `NotConnected` - Intersight is unable to establish a connection to the target. * `ClaimInProgress` - Claim of the target is in progress. A connection to the target has not been fully established. * `Unclaimed` - The device was un-claimed from the users account by an Administrator of the device. Also indicates the failure to claim Targets of type HTTP Endpoint in Intersight. * `Claimed` - Target of type HTTP Endpoint is successfully claimed in Intersight. Currently no validation is performed to verify the Target connectivity from Intersight at the time of creation. However invoking API from Intersight Orchestrator fails if this Target is not reachable from Intersight or if Target API credentials are incorrect.



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

def connection_status
  @connection_status
end

#connection_status_last_change_time ⇒ Object

The last time at which the ‘connectionStatus’ property value changed. If connectionStatus is Connected, this time can be interpreted as the starting time since which a persistent connection has been maintained between Intersight and Device Connector. If connectionStatus is NotConnected, this time can be interpreted as the last time the device connector was connected with Intersight.



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

def connection_status_last_change_time
  @connection_status_last_change_time
end

#connector_version ⇒ Object

The version of the device connector running on the managed device.



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

def connector_version
  @connector_version
end

#device_external_ip_address ⇒ Object

The IP Address of the managed device as seen from Intersight at the time of registration. This could be the IP address of the managed device’s interface which has a route to the internet or a NAT IP addresss when the managed device is deployed in a private network.



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

def device_external_ip_address
  @device_external_ip_address
end

#object_type ⇒ Object

The fully-qualified name of the instantiated, concrete type. The value should be the same as the ‘ClassId’ property. The enum values provides the list of concrete types that can be instantiated from this abstract type.



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

def object_type
  @object_type
end

#proxy_app ⇒ Object

The name of the app which will proxy the messages to the device connector.



50
51
52
 
# File 'lib/intersight_client/models/asset_device_connection.rb', line 50

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



97
98
99
 
# File 'lib/intersight_client/models/asset_device_connection.rb', line 97

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)



92
93
94
 
# File 'lib/intersight_client/models/asset_device_connection.rb', line 92

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.



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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'api_version' => :'ApiVersion',
    :'app_partition_number' => :'AppPartitionNumber',
    :'connection_id' => :'ConnectionId',
    :'connection_reason' => :'ConnectionReason',
    :'connection_status' => :'ConnectionStatus',
    :'connection_status_last_change_time' => :'ConnectionStatusLastChangeTime',
    :'connector_version' => :'ConnectorVersion',
    :'device_external_ip_address' => :'DeviceExternalIpAddress',
    :'proxy_app' => :'ProxyApp'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



294
295
296
 
# File 'lib/intersight_client/models/asset_device_connection.rb', line 294

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



125
126
127
128
129
130
 
# File 'lib/intersight_client/models/asset_device_connection.rb', line 125

def self.openapi_all_of
  [
  :'AssetDeviceConnectionAllOf',
  :'MoBaseMo'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



133
134
135
 
# File 'lib/intersight_client/models/asset_device_connection.rb', line 133

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



119
120
121
122
 
# File 'lib/intersight_client/models/asset_device_connection.rb', line 119

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

.openapi_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/intersight_client/models/asset_device_connection.rb', line 102

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'api_version' => :'Integer',
    :'app_partition_number' => :'Integer',
    :'connection_id' => :'String',
    :'connection_reason' => :'String',
    :'connection_status' => :'String',
    :'connection_status_last_change_time' => :'Time',
    :'connector_version' => :'String',
    :'device_external_ip_address' => :'String',
    :'proxy_app' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/intersight_client/models/asset_device_connection.rb', line 263

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      api_version == o.api_version &&
      app_partition_number == o.app_partition_number &&
      connection_id == o.connection_id &&
      connection_reason == o.connection_reason &&
      connection_status == o.connection_status &&
      connection_status_last_change_time == o.connection_status_last_change_time &&
      connector_version == o.connector_version &&
      device_external_ip_address == o.device_external_ip_address &&
      proxy_app == o.proxy_app && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
357
358
359
360
361
362
 
# File 'lib/intersight_client/models/asset_device_connection.rb', line 325

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



396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/intersight_client/models/asset_device_connection.rb', line 396

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



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/intersight_client/models/asset_device_connection.rb', line 301

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

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



287
288
289
 
# File 'lib/intersight_client/models/asset_device_connection.rb', line 287

def hash
  [class_id, object_type, api_version, app_partition_number, connection_id, connection_reason, connection_status, connection_status_last_change_time, connector_version, device_external_ip_address, proxy_app].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/intersight_client/models/asset_device_connection.rb', line 204

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)



372
373
374
 
# File 'lib/intersight_client/models/asset_device_connection.rb', line 372

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/intersight_client/models/asset_device_connection.rb', line 378

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



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

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/intersight_client/models/asset_device_connection.rb', line 219

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["asset.ClusterMember", "asset.DeviceRegistration"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["asset.ClusterMember", "asset.DeviceRegistration"])
  return false unless object_type_validator.valid?(@object_type)
  connection_status_validator = EnumAttributeValidator.new('String', ["", "Connected", "NotConnected", "ClaimInProgress", "Unclaimed", "Claimed"])
  return false unless connection_status_validator.valid?(@connection_status)
  true && super
end