Class: IbmCloudPower::IKEPolicyTemplate

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IKEPolicyTemplate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
# File 'lib/ibm_cloud_power/models/ike_policy_template.rb', line 68

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

Instance Attribute Details

#authenticationObject

ikePolicy Authentication default value



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

def authentication
  @authentication
end

#dh_groupObject

ikePolicy DHGroup default value



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

def dh_group
  @dh_group
end

#encryptionObject

ikePolicy Encryption default value



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

def encryption
  @encryption
end

#key_lifetimeObject

Policy key lifetime



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

def key_lifetime
  @key_lifetime
end

#versionObject

ikePolicy Version default value



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

def version
  @version
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



45
46
47
# File 'lib/ibm_cloud_power/models/ike_policy_template.rb', line 45

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



34
35
36
37
38
39
40
41
42
# File 'lib/ibm_cloud_power/models/ike_policy_template.rb', line 34

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



195
196
197
# File 'lib/ibm_cloud_power/models/ike_policy_template.rb', line 195

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

.openapi_nullableObject

List of attributes with nullable: true



61
62
63
64
# File 'lib/ibm_cloud_power/models/ike_policy_template.rb', line 61

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

.openapi_typesObject

Attribute type mapping.



50
51
52
53
54
55
56
57
58
# File 'lib/ibm_cloud_power/models/ike_policy_template.rb', line 50

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



170
171
172
173
174
175
176
177
178
# File 'lib/ibm_cloud_power/models/ike_policy_template.rb', line 170

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 &&
      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



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
# File 'lib/ibm_cloud_power/models/ike_policy_template.rb', line 226

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



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

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



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'lib/ibm_cloud_power/models/ike_policy_template.rb', line 202

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


182
183
184
# File 'lib/ibm_cloud_power/models/ike_policy_template.rb', line 182

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



188
189
190
# File 'lib/ibm_cloud_power/models/ike_policy_template.rb', line 188

def hash
  [authentication, dh_group, encryption, key_lifetime, version].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



273
274
275
# File 'lib/ibm_cloud_power/models/ike_policy_template.rb', line 273

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



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

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



267
268
269
# File 'lib/ibm_cloud_power/models/ike_policy_template.rb', line 267

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



139
140
141
142
143
144
145
146
147
148
# File 'lib/ibm_cloud_power/models/ike_policy_template.rb', line 139

def valid?
  return false if @authentication.nil?
  return false if @dh_group.nil?
  return false if @encryption.nil?
  return false if @key_lifetime.nil?
  return false if @key_lifetime > 86400
  return false if @key_lifetime < 180
  return false if @version.nil?
  true
end