Class: IbmCloudPower::IKEPolicyCreate

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

Overview

IKE Policy object used for creation

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IKEPolicyCreate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

Instance Attribute Details

#authentication ⇒ Object

Returns the value of attribute authentication.



19
20
21
 
# File 'lib/ibm_cloud_power/models/ike_policy_create.rb', line 19

def authentication
  @authentication
end

#dh_group ⇒ Object

DH group of the IKE Policy



22
23
24
 
# File 'lib/ibm_cloud_power/models/ike_policy_create.rb', line 22

def dh_group
  @dh_group
end

#encryption ⇒ Object

encryption of the IKE Policy



25
26
27
 
# File 'lib/ibm_cloud_power/models/ike_policy_create.rb', line 25

def encryption
  @encryption
end

#key_lifetime ⇒ Object

Policy key lifetime



28
29
30
 
# File 'lib/ibm_cloud_power/models/ike_policy_create.rb', line 28

def key_lifetime
  @key_lifetime
end

#name ⇒ Object

name of the IKE Policy



31
32
33
 
# File 'lib/ibm_cloud_power/models/ike_policy_create.rb', line 31

def name
  @name
end

#preshared_key ⇒ Object

Preshared key used in this IKE Policy (length of preshared key must be even)



34
35
36
 
# File 'lib/ibm_cloud_power/models/ike_policy_create.rb', line 34

def preshared_key
  @preshared_key
end

#version ⇒ Object

version of the IKE Policy



37
38
39
 
# File 'lib/ibm_cloud_power/models/ike_policy_create.rb', line 37

def version
  @version
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



75
76
77
 
# File 'lib/ibm_cloud_power/models/ike_policy_create.rb', line 75

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

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



306
307
308
 
# File 'lib/ibm_cloud_power/models/ike_policy_create.rb', line 306

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



93
94
95
96
 
# File 'lib/ibm_cloud_power/models/ike_policy_create.rb', line 93

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

.openapi_types ⇒ Object

Attribute type mapping.



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

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/ibm_cloud_power/models/ike_policy_create.rb', line 279

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



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
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/ibm_cloud_power/models/ike_policy_create.rb', line 337

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



408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/ibm_cloud_power/models/ike_policy_create.rb', line 408

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



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/ibm_cloud_power/models/ike_policy_create.rb', line 313

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


293
294
295
 
# File 'lib/ibm_cloud_power/models/ike_policy_create.rb', line 293

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



299
300
301
 
# File 'lib/ibm_cloud_power/models/ike_policy_create.rb', line 299

def hash
  [authentication, dh_group, encryption, key_lifetime, name, preshared_key, 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



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

def list_invalid_properties
  invalid_properties = Array.new
  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 @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 @name.to_s.length > 47
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 47.')
  end

  if @name.to_s.length < 1
    invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
  end

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



384
385
386
 
# File 'lib/ibm_cloud_power/models/ike_policy_create.rb', line 384

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



390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/ibm_cloud_power/models/ike_policy_create.rb', line 390

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



378
379
380
 
# File 'lib/ibm_cloud_power/models/ike_policy_create.rb', line 378

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



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

def valid?
  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', ["aes-256-cbc", "aes-192-cbc", "aes-128-cbc", "aes-256-gcm", "aes-128-gcm", "3des-cbc"])
  return false unless encryption_validator.valid?(@encryption)
  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 @name.to_s.length > 47
  return false if @name.to_s.length < 1
  return false if @preshared_key.nil?
  return false if @version.nil?
  version_validator = EnumAttributeValidator.new('Integer', [1, 2])
  return false unless version_validator.valid?(@version)
  true
end