Class: IbmCloudPower::IKEPolicy

Inherits:
Object
  • Object
show all
Defined in:
lib/ibm_cloud_power/models/ike_policy.rb

Overview

IKE Policy object

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IKEPolicy

Initializes the object

Parameters:

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

    Model attributes in the form of hash



101
102
103
104
105
106
107
108
109
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
 
# File 'lib/ibm_cloud_power/models/ike_policy.rb', line 101

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IbmCloudPower::IKEPolicy` 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.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `IbmCloudPower::IKEPolicy`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

Instance Attribute Details

#authentication ⇒ Object

authentication of the IKE Policy



20
21
22
 
# File 'lib/ibm_cloud_power/models/ike_policy.rb', line 20

def authentication
  @authentication
end

#dh_group ⇒ Object

DH group of the IKE Policy



23
24
25
 
# File 'lib/ibm_cloud_power/models/ike_policy.rb', line 23

def dh_group
  @dh_group
end

#encryption ⇒ Object

encryption of the IKE Policy



26
27
28
 
# File 'lib/ibm_cloud_power/models/ike_policy.rb', line 26

def encryption
  @encryption
end

#id ⇒ Object

unique identifier of the IKE Policy object



29
30
31
 
# File 'lib/ibm_cloud_power/models/ike_policy.rb', line 29

def id
  @id
end

#key_lifetime ⇒ Object

Policy key lifetime



32
33
34
 
# File 'lib/ibm_cloud_power/models/ike_policy.rb', line 32

def key_lifetime
  @key_lifetime
end

#name ⇒ Object

name of the IKE Policy



35
36
37
 
# File 'lib/ibm_cloud_power/models/ike_policy.rb', line 35

def name
  @name
end

#version ⇒ Object

version of the IKE Policy



38
39
40
 
# File 'lib/ibm_cloud_power/models/ike_policy.rb', line 38

def version
  @version
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



76
77
78
 
# File 'lib/ibm_cloud_power/models/ike_policy.rb', line 76

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/ibm_cloud_power/models/ike_policy.rb', line 63

def self.attribute_map
  {
    :'authentication' => :'authentication',
    :'dh_group' => :'dhGroup',
    :'encryption' => :'encryption',
    :'id' => :'id',
    :'key_lifetime' => :'keyLifetime',
    :'name' => :'name',
    :'version' => :'version'
  }
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



296
297
298
 
# File 'lib/ibm_cloud_power/models/ike_policy.rb', line 296

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



94
95
96
97
 
# File 'lib/ibm_cloud_power/models/ike_policy.rb', line 94

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

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/ibm_cloud_power/models/ike_policy.rb', line 81

def self.openapi_types
  {
    :'authentication' => :'String',
    :'dh_group' => :'Integer',
    :'encryption' => :'String',
    :'id' => :'String',
    :'key_lifetime' => :'Integer',
    :'name' => :'String',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/ibm_cloud_power/models/ike_policy.rb', line 269

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      authentication == o.authentication &&
      dh_group == o.dh_group &&
      encryption == o.encryption &&
      id == o.id &&
      key_lifetime == o.key_lifetime &&
      name == o.name &&
      version == o.version
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



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
363
364
 
# File 'lib/ibm_cloud_power/models/ike_policy.rb', line 327

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 = IbmCloudPower.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



398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/ibm_cloud_power/models/ike_policy.rb', line 398

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



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/ibm_cloud_power/models/ike_policy.rb', line 303

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


283
284
285
 
# File 'lib/ibm_cloud_power/models/ike_policy.rb', line 283

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



289
290
291
 
# File 'lib/ibm_cloud_power/models/ike_policy.rb', line 289

def hash
  [authentication, dh_group, encryption, id, key_lifetime, name, version].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



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
 
# File 'lib/ibm_cloud_power/models/ike_policy.rb', line 145

def list_invalid_properties
  invalid_properties = Array.new
  if @authentication.nil?
    invalid_properties.push('invalid value for "authentication", authentication cannot be nil.')
  end

  if @dh_group.nil?
    invalid_properties.push('invalid value for "dh_group", dh_group cannot be nil.')
  end

  if @encryption.nil?
    invalid_properties.push('invalid value for "encryption", encryption cannot be nil.')
  end

  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @key_lifetime.nil?
    invalid_properties.push('invalid value for "key_lifetime", key_lifetime cannot be nil.')
  end

  if @key_lifetime > 86400
    invalid_properties.push('invalid value for "key_lifetime", must be smaller than or equal to 86400.')
  end

  if @key_lifetime < 180
    invalid_properties.push('invalid value for "key_lifetime", must be greater than or equal to 180.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @version.nil?
    invalid_properties.push('invalid value for "version", version 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



374
375
376
 
# File 'lib/ibm_cloud_power/models/ike_policy.rb', line 374

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



380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/ibm_cloud_power/models/ike_policy.rb', line 380

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



368
369
370
 
# File 'lib/ibm_cloud_power/models/ike_policy.rb', line 368

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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/ibm_cloud_power/models/ike_policy.rb', line 188

def valid?
  return false if @authentication.nil?
  authentication_validator = EnumAttributeValidator.new('String', ["sha1", "md5", "sha-256", "sha-384"])
  return false unless authentication_validator.valid?(@authentication)
  return false if @dh_group.nil?
  dh_group_validator = EnumAttributeValidator.new('Integer', [1, 2, 5, 14, 19, 20, 24])
  return false unless dh_group_validator.valid?(@dh_group)
  return false if @encryption.nil?
  encryption_validator = EnumAttributeValidator.new('String', ["3des-cbc", "aes-128-cbc", "aes-128-gcm", "aes-192-cbc", "aes-256-cbc", "aes-256-gcm", "des-cbc"])
  return false unless encryption_validator.valid?(@encryption)
  return false if @id.nil?
  return false if @key_lifetime.nil?
  return false if @key_lifetime > 86400
  return false if @key_lifetime < 180
  return false if @name.nil?
  return false if @version.nil?
  version_validator = EnumAttributeValidator.new('Integer', [1, 2])
  return false unless version_validator.valid?(@version)
  true
end