Class: IntersightClient::ConnectorTargetChangeMessage

Inherits:
ConnectorBaseMessage show all
Defined in:
lib/intersight_client/models/connector_target_change_message.rb

Overview

The message sent to the Appliance device connector when a Target is created, modified or deleted. Appliance device connector is expected to maintain a durable cache of relevent Target information such that it can perform inventory collection and change operations against the target without soliciting basic connectivity details from Intersight.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from ConnectorBaseMessage

#encrypted_aes_key, #encryption_key, #secure_properties

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConnectorTargetChangeMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



110
111
112
113
114
115
116
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
 
# File 'lib/intersight_client/models/connector_target_change_message.rb', line 110

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

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

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

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

  if attributes.key?(:'target_moid')
    self.target_moid = attributes[:'target_moid']
  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/connector_target_change_message.rb', line 20

def class_id
  @class_id
end

#mod_status ⇒ Object

ModStatus indicates if the change message conveys a creation, modification or deletion of an Target instance. * ‘None` - The ’none’ operation/state.Indicates a configuration profile has been deployed, and the desired configuration matches the actual device configuration. * ‘Created` - The ’create’ operation/state.Indicates a configuration profile has been created and associated with a device, but the configuration specified in the profilehas not been applied yet. For example, this could happen when the user creates a server profile and has not deployed the profile yet. * ‘Modified` - The ’update’ operation/state.Indicates some of the desired configuration changes specified in a profile have not been been applied to the associated device.This happens when the user has made changes to a profile and has not deployed the changes yet, or when the workflow to applythe configuration changes has not completed succesfully. * ‘Deleted` - The ’delete’ operation/state.Indicates a configuration profile has been been disassociated from a device and the user has not undeployed these changes yet.



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

def mod_status
  @mod_status
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/connector_target_change_message.rb', line 23

def object_type
  @object_type
end

#target_details ⇒ Object

A Json-serialized representation of the ‘configuration’ portion of the Target instance. Ie the representation contains configuration properties like the target’s connectivity information but not operation status. The representation include credential information, encrypted with the RSA public key of the Appliance device connector. Appliance device connector is the sole maintainer of the RSA private key and the only system component which is capable of interpreting the credential.



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

def target_details
  @target_details
end

#target_moid ⇒ Object

The Moid identifying the Target instance being created, modified or deleted.



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

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



73
74
75
 
# File 'lib/intersight_client/models/connector_target_change_message.rb', line 73

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)



68
69
70
 
# File 'lib/intersight_client/models/connector_target_change_message.rb', line 68

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.



57
58
59
60
61
62
63
64
65
 
# File 'lib/intersight_client/models/connector_target_change_message.rb', line 57

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'mod_status' => :'ModStatus',
    :'target_details' => :'TargetDetails',
    :'target_moid' => :'TargetMoid'
  }
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



239
240
241
 
# File 'lib/intersight_client/models/connector_target_change_message.rb', line 239

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



96
97
98
99
100
101
 
# File 'lib/intersight_client/models/connector_target_change_message.rb', line 96

def self.openapi_all_of
  [
  :'ConnectorBaseMessage',
  :'ConnectorTargetChangeMessageAllOf'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



104
105
106
 
# File 'lib/intersight_client/models/connector_target_change_message.rb', line 104

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



89
90
91
92
93
 
# File 'lib/intersight_client/models/connector_target_change_message.rb', line 89

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

.openapi_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
 
# File 'lib/intersight_client/models/connector_target_change_message.rb', line 78

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'mod_status' => :'String',
    :'target_details' => :'Object',
    :'target_moid' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      mod_status == o.mod_status &&
      target_details == o.target_details &&
      target_moid == o.target_moid && 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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/intersight_client/models/connector_target_change_message.rb', line 270

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



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

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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/intersight_client/models/connector_target_change_message.rb', line 246

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


226
227
228
 
# File 'lib/intersight_client/models/connector_target_change_message.rb', line 226

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



232
233
234
 
# File 'lib/intersight_client/models/connector_target_change_message.rb', line 232

def hash
  [class_id, object_type, mod_status, target_details, target_moid].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



155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/intersight_client/models/connector_target_change_message.rb', line 155

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



317
318
319
 
# File 'lib/intersight_client/models/connector_target_change_message.rb', line 317

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



323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/intersight_client/models/connector_target_change_message.rb', line 323

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



311
312
313
 
# File 'lib/intersight_client/models/connector_target_change_message.rb', line 311

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



170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/intersight_client/models/connector_target_change_message.rb', line 170

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["connector.TargetChangeMessage"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["connector.TargetChangeMessage"])
  return false unless object_type_validator.valid?(@object_type)
  mod_status_validator = EnumAttributeValidator.new('String', ["None", "Created", "Modified", "Deleted"])
  return false unless mod_status_validator.valid?(@mod_status)
  true && super
end