Class: IntersightClient::StorageRemoteKeySetting

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

Overview

Models the remote key configurarion required for disks encryptions. KMIP is the only remote key protocol supported in the policy.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StorageRemoteKeySetting

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



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
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/intersight_client/models/storage_remote_key_setting.rb', line 129

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

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

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

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

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

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

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

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

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

def class_id
  @class_id
end

#is_password_set ⇒ Object

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



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

def is_password_set
  @is_password_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/storage_remote_key_setting.rb', line 23

def object_type
  @object_type
end

#password ⇒ Object

The password for the KMIP server login.



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

def password
  @password
end

#port ⇒ Object

The port to which the KMIP client should connect.



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

def port
  @port
end

#primary_server ⇒ Object

The IP address of the primary KMIP server. It could be an IPv4 address, an IPv6 address, or a hostname. Hostnames are valid only when Inband is configured for the CIMC address.



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

def primary_server
  @primary_server
end

#secondary_server ⇒ Object

The IP address of the secondary KMIP server. It could be an IPv4 address, an IPv6 address, or a hostname. Hostnames are valid only when Inband is configured for the CIMC address.



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

def secondary_server
  @secondary_server
end

#server_certificate ⇒ Object

The certificate/ public key of the KMIP server. It is required for initiating secure communication with the server.



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

def server_certificate
  @server_certificate
end

#username ⇒ Object

The user name for the KMIP server login.



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

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



89
90
91
 
# File 'lib/intersight_client/models/storage_remote_key_setting.rb', line 89

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)



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

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.



69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/intersight_client/models/storage_remote_key_setting.rb', line 69

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'is_password_set' => :'IsPasswordSet',
    :'password' => :'Password',
    :'port' => :'Port',
    :'primary_server' => :'PrimaryServer',
    :'secondary_server' => :'SecondaryServer',
    :'server_certificate' => :'ServerCertificate',
    :'username' => :'Username'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



326
327
328
 
# File 'lib/intersight_client/models/storage_remote_key_setting.rb', line 326

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



115
116
117
118
119
120
 
# File 'lib/intersight_client/models/storage_remote_key_setting.rb', line 115

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



123
124
125
 
# File 'lib/intersight_client/models/storage_remote_key_setting.rb', line 123

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



109
110
111
112
 
# File 'lib/intersight_client/models/storage_remote_key_setting.rb', line 109

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

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/intersight_client/models/storage_remote_key_setting.rb', line 94

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'is_password_set' => :'Boolean',
    :'password' => :'String',
    :'port' => :'Integer',
    :'primary_server' => :'String',
    :'secondary_server' => :'String',
    :'server_certificate' => :'String',
    :'username' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/intersight_client/models/storage_remote_key_setting.rb', line 297

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      is_password_set == o.is_password_set &&
      password == o.password &&
      port == o.port &&
      primary_server == o.primary_server &&
      secondary_server == o.secondary_server &&
      server_certificate == o.server_certificate &&
      username == o.username && 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



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/intersight_client/models/storage_remote_key_setting.rb', line 357

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



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/intersight_client/models/storage_remote_key_setting.rb', line 428

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



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/intersight_client/models/storage_remote_key_setting.rb', line 333

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • to be compared

Returns:

See Also:

  • `==` method


313
314
315
 
# File 'lib/intersight_client/models/storage_remote_key_setting.rb', line 313

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



319
320
321
 
# File 'lib/intersight_client/models/storage_remote_key_setting.rb', line 319

def hash
  [class_id, object_type, is_password_set, password, port, primary_server, secondary_server, server_certificate, username].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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/intersight_client/models/storage_remote_key_setting.rb', line 192

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

  pattern = Regexp.new(/[!"#%&'\(\)\*\+,\-\.\/:;<>@\[\\\]\^_`\{\|\}~a-zA-Z0-9]{0,80}/)
  if !@password.nil? && @password !~ pattern
    invalid_properties.push("invalid value for \"password\", must conform to the pattern #{pattern}.")
  end

  if !@port.nil? && @port > 65535
    invalid_properties.push('invalid value for "port", must be smaller than or equal to 65535.')
  end

  if !@port.nil? && @port < 1024
    invalid_properties.push('invalid value for "port", must be greater than or equal to 1024.')
  end

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



404
405
406
 
# File 'lib/intersight_client/models/storage_remote_key_setting.rb', line 404

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



410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/intersight_client/models/storage_remote_key_setting.rb', line 410

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



398
399
400
 
# File 'lib/intersight_client/models/storage_remote_key_setting.rb', line 398

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



225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/intersight_client/models/storage_remote_key_setting.rb', line 225

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["storage.RemoteKeySetting"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["storage.RemoteKeySetting"])
  return false unless object_type_validator.valid?(@object_type)
  return false if !@password.nil? && @password !~ Regexp.new(/[!"#%&'\(\)\*\+,\-\.\/:;<>@\[\\\]\^_`\{\|\}~a-zA-Z0-9]{0,80}/)
  return false if !@port.nil? && @port > 65535
  return false if !@port.nil? && @port < 1024
  return false if !@username.nil? && @username !~ Regexp.new(/^$|[a-zA-Z][a-zA-Z0-9_.-]{0,31}/)
  true && super
end