Class: IbmCloudPower::VPNConnection

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VPNConnection

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/ibm_cloud_power/models/vpn_connection.rb', line 122

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

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

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

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

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

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

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

  if attributes.key?(:'network_ids')
    if (value = attributes[:'network_ids']).is_a?(Array)
      self.network_ids = value
    end
  end

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

  if attributes.key?(:'peer_subnets')
    if (value = attributes[:'peer_subnets']).is_a?(Array)
      self.peer_subnets = value
    end
  end

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

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

Instance Attribute Details

#dead_peer_detection ⇒ Object

Returns the value of attribute dead_peer_detection.



18
19
20
 
# File 'lib/ibm_cloud_power/models/vpn_connection.rb', line 18

def dead_peer_detection
  @dead_peer_detection
end

#id ⇒ Object

unique identifier for VPN Connection



21
22
23
 
# File 'lib/ibm_cloud_power/models/vpn_connection.rb', line 21

def id
  @id
end

#ike_policy ⇒ Object

Returns the value of attribute ike_policy.



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

def ike_policy
  @ike_policy
end

#ip_sec_policy ⇒ Object

Returns the value of attribute ip_sec_policy.



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

def ip_sec_policy
  @ip_sec_policy
end

#local_gateway_address ⇒ Object

local Gateway address, only in ‘route’ mode.



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

def local_gateway_address
  @local_gateway_address
end

#mode ⇒ Object

Mode used by this VPNConnection, either policy-based, or route-based, this attribute is set at the creation and cannot be updated later.



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

def mode
  @mode
end

#name ⇒ Object

VPN Connection name



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

def name
  @name
end

#network_ids ⇒ Object

an array of network IDs



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

def network_ids
  @network_ids
end

#peer_gateway_address ⇒ Object

IP address of the Peer Gateway attached to this VPNConnection



40
41
42
 
# File 'lib/ibm_cloud_power/models/vpn_connection.rb', line 40

def peer_gateway_address
  @peer_gateway_address
end

#peer_subnets ⇒ Object

an array of strings containing CIDR of peer subnets



43
44
45
 
# File 'lib/ibm_cloud_power/models/vpn_connection.rb', line 43

def peer_subnets
  @peer_subnets
end

#status ⇒ Object

status of the VPN connection



46
47
48
 
# File 'lib/ibm_cloud_power/models/vpn_connection.rb', line 46

def status
  @status
end

#vpn_gateway_address ⇒ Object

public IP address of the VPN Gateway (vSRX) attached to this VPNConnection



49
50
51
 
# File 'lib/ibm_cloud_power/models/vpn_connection.rb', line 49

def vpn_gateway_address
  @vpn_gateway_address
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



92
93
94
 
# File 'lib/ibm_cloud_power/models/vpn_connection.rb', line 92

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/ibm_cloud_power/models/vpn_connection.rb', line 74

def self.attribute_map
  {
    :'dead_peer_detection' => :'deadPeerDetection',
    :'id' => :'id',
    :'ike_policy' => :'ikePolicy',
    :'ip_sec_policy' => :'ipSecPolicy',
    :'local_gateway_address' => :'localGatewayAddress',
    :'mode' => :'mode',
    :'name' => :'name',
    :'network_ids' => :'networkIDs',
    :'peer_gateway_address' => :'peerGatewayAddress',
    :'peer_subnets' => :'peerSubnets',
    :'status' => :'status',
    :'vpn_gateway_address' => :'vpnGatewayAddress'
  }
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



319
320
321
 
# File 'lib/ibm_cloud_power/models/vpn_connection.rb', line 319

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



115
116
117
118
 
# File 'lib/ibm_cloud_power/models/vpn_connection.rb', line 115

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

.openapi_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/ibm_cloud_power/models/vpn_connection.rb', line 97

def self.openapi_types
  {
    :'dead_peer_detection' => :'DeadPeerDetection',
    :'id' => :'String',
    :'ike_policy' => :'IKEPolicyRef',
    :'ip_sec_policy' => :'IPSecPolicyRef',
    :'local_gateway_address' => :'String',
    :'mode' => :'String',
    :'name' => :'String',
    :'network_ids' => :'Array<String>',
    :'peer_gateway_address' => :'String',
    :'peer_subnets' => :'Array<String>',
    :'status' => :'String',
    :'vpn_gateway_address' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/ibm_cloud_power/models/vpn_connection.rb', line 287

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      dead_peer_detection == o.dead_peer_detection &&
      id == o.id &&
      ike_policy == o.ike_policy &&
      ip_sec_policy == o.ip_sec_policy &&
      local_gateway_address == o.local_gateway_address &&
      mode == o.mode &&
      name == o.name &&
      network_ids == o.network_ids &&
      peer_gateway_address == o.peer_gateway_address &&
      peer_subnets == o.peer_subnets &&
      status == o.status &&
      vpn_gateway_address == o.vpn_gateway_address
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



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
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/ibm_cloud_power/models/vpn_connection.rb', line 350

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



421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/ibm_cloud_power/models/vpn_connection.rb', line 421

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



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/ibm_cloud_power/models/vpn_connection.rb', line 326

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



312
313
314
 
# File 'lib/ibm_cloud_power/models/vpn_connection.rb', line 312

def hash
  [dead_peer_detection, id, ike_policy, ip_sec_policy, local_gateway_address, mode, name, network_ids, peer_gateway_address, peer_subnets, status, vpn_gateway_address].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



190
191
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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/ibm_cloud_power/models/vpn_connection.rb', line 190

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

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

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

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

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

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

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

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

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

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

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

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



397
398
399
 
# File 'lib/ibm_cloud_power/models/vpn_connection.rb', line 397

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



403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/ibm_cloud_power/models/vpn_connection.rb', line 403

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



391
392
393
 
# File 'lib/ibm_cloud_power/models/vpn_connection.rb', line 391

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



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/vpn_connection.rb', line 245

def valid?
  return false if @dead_peer_detection.nil?
  return false if @id.nil?
  return false if @ike_policy.nil?
  return false if @ip_sec_policy.nil?
  return false if @local_gateway_address.nil?
  return false if @mode.nil?
  mode_validator = EnumAttributeValidator.new('String', ["policy", "route"])
  return false unless mode_validator.valid?(@mode)
  return false if @name.nil?
  return false if @network_ids.nil?
  return false if @peer_gateway_address.nil?
  return false if @peer_subnets.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["active", "warning", "disabled"])
  return false unless status_validator.valid?(@status)
  return false if @vpn_gateway_address.nil?
  true
end