Class: IntersightClient::IpmioverlanPolicyAllOf

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

Overview

Definition of the list of properties defined in ‘ipmioverlan.Policy’, excluding properties defined in parent classes.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IpmioverlanPolicyAllOf

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/intersight_client/models/ipmioverlan_policy_all_of.rb', line 111

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

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

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

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

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

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

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

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

  if attributes.key?(:'profiles')
    if (value = attributes[:'profiles']).is_a?(Array)
      self.profiles = value
    end
  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/ipmioverlan_policy_all_of.rb', line 20

def class_id
  @class_id
end

#enabled ⇒ Object

State of the IPMI Over LAN service on the endpoint.



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

def enabled
  @enabled
end

#encryption_key ⇒ Object

The encryption key to use for IPMI communication. It should have an even number of hexadecimal characters and not exceed 40 characters.



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

def encryption_key
  @encryption_key
end

#is_encryption_key_set ⇒ Object

Indicates whether the value of the ‘encryptionKey’ property has been set.



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

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

def object_type
  @object_type
end

#organization ⇒ Object

Returns the value of attribute organization.



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

def organization
  @organization
end

#privilege ⇒ Object

The highest privilege level that can be assigned to an IPMI session on a server. * admin - Privilege to perform all actions available through IPMI. * user - Privilege to perform some functions through IPMI but restriction on performing administrative tasks. * read-only - Privilege to view information throught IPMI but restriction on making any changes.



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

def privilege
  @privilege
end

#profiles ⇒ Object

An array of relationships to policyAbstractConfigProfile resources.



40
41
42
 
# File 'lib/intersight_client/models/ipmioverlan_policy_all_of.rb', line 40

def profiles
  @profiles
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns the key-value map of all the JSON attributes this model knows about



84
85
86
 
# File 'lib/intersight_client/models/ipmioverlan_policy_all_of.rb', line 84

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



79
80
81
 
# File 'lib/intersight_client/models/ipmioverlan_policy_all_of.rb', line 79

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'enabled' => :'Enabled',
    :'encryption_key' => :'EncryptionKey',
    :'is_encryption_key_set' => :'IsEncryptionKeySet',
    :'privilege' => :'Privilege',
    :'organization' => :'Organization',
    :'profiles' => :'Profiles'
  }
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



293
294
295
 
# File 'lib/intersight_client/models/ipmioverlan_policy_all_of.rb', line 293

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



103
104
105
106
107
 
# File 'lib/intersight_client/models/ipmioverlan_policy_all_of.rb', line 103

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'enabled' => :'Boolean',
    :'encryption_key' => :'String',
    :'is_encryption_key_set' => :'Boolean',
    :'privilege' => :'String',
    :'organization' => :'OrganizationOrganizationRelationship',
    :'profiles' => :'Array<PolicyAbstractConfigProfileRelationship>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      enabled == o.enabled &&
      encryption_key == o.encryption_key &&
      is_encryption_key_set == o.is_encryption_key_set &&
      privilege == o.privilege &&
      organization == o.organization &&
      profiles == o.profiles
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



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
357
358
359
360
 
# File 'lib/intersight_client/models/ipmioverlan_policy_all_of.rb', line 323

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



394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/intersight_client/models/ipmioverlan_policy_all_of.rb', line 394

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



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

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


280
281
282
 
# File 'lib/intersight_client/models/ipmioverlan_policy_all_of.rb', line 280

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



286
287
288
 
# File 'lib/intersight_client/models/ipmioverlan_policy_all_of.rb', line 286

def hash
  [class_id, object_type, enabled, encryption_key, is_encryption_key_set, privilege, organization, profiles].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



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/ipmioverlan_policy_all_of.rb', line 171

def list_invalid_properties
  invalid_properties = Array.new
  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

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

  if !@encryption_key.nil? && @encryption_key.to_s.length < 0
    invalid_properties.push('invalid value for "encryption_key", the character length must be great than or equal to 0.')
  end

  pattern = Regexp.new(/^[a-fA-F0-9]*$/)
  if !@encryption_key.nil? && @encryption_key !~ pattern
    invalid_properties.push("invalid value for \"encryption_key\", must conform to the pattern #{pattern}.")
  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



370
371
372
 
# File 'lib/intersight_client/models/ipmioverlan_policy_all_of.rb', line 370

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



376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/intersight_client/models/ipmioverlan_policy_all_of.rb', line 376

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



364
365
366
 
# File 'lib/intersight_client/models/ipmioverlan_policy_all_of.rb', line 364

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



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

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["ipmioverlan.Policy"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["ipmioverlan.Policy"])
  return false unless object_type_validator.valid?(@object_type)
  return false if !@encryption_key.nil? && @encryption_key.to_s.length > 40
  return false if !@encryption_key.nil? && @encryption_key.to_s.length < 0
  return false if !@encryption_key.nil? && @encryption_key !~ Regexp.new(/^[a-fA-F0-9]*$/)
  privilege_validator = EnumAttributeValidator.new('String', ["admin", "user", "read-only"])
  return false unless privilege_validator.valid?(@privilege)
  true
end