Class: OCI::Core::Models::CreateIPSecConnectionTunnelDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/create_ip_sec_connection_tunnel_details.rb

Overview

CreateIPSecConnectionTunnelDetails model.

Constant Summary collapse

ROUTING_ENUM = 
[
  ROUTING_BGP = 'BGP'.freeze,
  ROUTING_STATIC = 'STATIC'.freeze,
  ROUTING_POLICY = 'POLICY'.freeze
].freeze
IKE_VERSION_ENUM = 
[
  IKE_VERSION_V1 = 'V1'.freeze,
  IKE_VERSION_V2 = 'V2'.freeze
].freeze
ORACLE_INITIATION_ENUM = 
[
  ORACLE_INITIATION_INITIATOR_OR_RESPONDER = 'INITIATOR_OR_RESPONDER'.freeze,
  ORACLE_INITIATION_RESPONDER_ONLY = 'RESPONDER_ONLY'.freeze
].freeze
NAT_TRANSLATION_ENABLED_ENUM = 
[
  NAT_TRANSLATION_ENABLED_ENABLED = 'ENABLED'.freeze,
  NAT_TRANSLATION_ENABLED_DISABLED = 'DISABLED'.freeze,
  NAT_TRANSLATION_ENABLED_AUTO = 'AUTO'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateIPSecConnectionTunnelDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/oci/core/models/create_ip_sec_connection_tunnel_details.rb', line 170

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']

  self.routing = attributes[:'routing'] if attributes[:'routing']

  self.ike_version = attributes[:'ikeVersion'] if attributes[:'ikeVersion']

  raise 'You cannot provide both :ikeVersion and :ike_version' if attributes.key?(:'ikeVersion') && attributes.key?(:'ike_version')

  self.ike_version = attributes[:'ike_version'] if attributes[:'ike_version']

  self.shared_secret = attributes[:'sharedSecret'] if attributes[:'sharedSecret']

  raise 'You cannot provide both :sharedSecret and :shared_secret' if attributes.key?(:'sharedSecret') && attributes.key?(:'shared_secret')

  self.shared_secret = attributes[:'shared_secret'] if attributes[:'shared_secret']

  self.bgp_session_config = attributes[:'bgpSessionConfig'] if attributes[:'bgpSessionConfig']

  raise 'You cannot provide both :bgpSessionConfig and :bgp_session_config' if attributes.key?(:'bgpSessionConfig') && attributes.key?(:'bgp_session_config')

  self.bgp_session_config = attributes[:'bgp_session_config'] if attributes[:'bgp_session_config']

  self.oracle_initiation = attributes[:'oracleInitiation'] if attributes[:'oracleInitiation']

  raise 'You cannot provide both :oracleInitiation and :oracle_initiation' if attributes.key?(:'oracleInitiation') && attributes.key?(:'oracle_initiation')

  self.oracle_initiation = attributes[:'oracle_initiation'] if attributes[:'oracle_initiation']

  self.nat_translation_enabled = attributes[:'natTranslationEnabled'] if attributes[:'natTranslationEnabled']

  raise 'You cannot provide both :natTranslationEnabled and :nat_translation_enabled' if attributes.key?(:'natTranslationEnabled') && attributes.key?(:'nat_translation_enabled')

  self.nat_translation_enabled = attributes[:'nat_translation_enabled'] if attributes[:'nat_translation_enabled']

  self.phase_one_config = attributes[:'phaseOneConfig'] if attributes[:'phaseOneConfig']

  raise 'You cannot provide both :phaseOneConfig and :phase_one_config' if attributes.key?(:'phaseOneConfig') && attributes.key?(:'phase_one_config')

  self.phase_one_config = attributes[:'phase_one_config'] if attributes[:'phase_one_config']

  self.phase_two_config = attributes[:'phaseTwoConfig'] if attributes[:'phaseTwoConfig']

  raise 'You cannot provide both :phaseTwoConfig and :phase_two_config' if attributes.key?(:'phaseTwoConfig') && attributes.key?(:'phase_two_config')

  self.phase_two_config = attributes[:'phase_two_config'] if attributes[:'phase_two_config']

  self.dpd_config = attributes[:'dpdConfig'] if attributes[:'dpdConfig']

  raise 'You cannot provide both :dpdConfig and :dpd_config' if attributes.key?(:'dpdConfig') && attributes.key?(:'dpd_config')

  self.dpd_config = attributes[:'dpd_config'] if attributes[:'dpd_config']

  self.oracle_tunnel_ip = attributes[:'oracleTunnelIp'] if attributes[:'oracleTunnelIp']

  raise 'You cannot provide both :oracleTunnelIp and :oracle_tunnel_ip' if attributes.key?(:'oracleTunnelIp') && attributes.key?(:'oracle_tunnel_ip')

  self.oracle_tunnel_ip = attributes[:'oracle_tunnel_ip'] if attributes[:'oracle_tunnel_ip']

  self.associated_virtual_circuits = attributes[:'associatedVirtualCircuits'] if attributes[:'associatedVirtualCircuits']

  raise 'You cannot provide both :associatedVirtualCircuits and :associated_virtual_circuits' if attributes.key?(:'associatedVirtualCircuits') && attributes.key?(:'associated_virtual_circuits')

  self.associated_virtual_circuits = attributes[:'associated_virtual_circuits'] if attributes[:'associated_virtual_circuits']

  self.drg_route_table_id = attributes[:'drgRouteTableId'] if attributes[:'drgRouteTableId']

  raise 'You cannot provide both :drgRouteTableId and :drg_route_table_id' if attributes.key?(:'drgRouteTableId') && attributes.key?(:'drg_route_table_id')

  self.drg_route_table_id = attributes[:'drg_route_table_id'] if attributes[:'drg_route_table_id']

  self.encryption_domain_config = attributes[:'encryptionDomainConfig'] if attributes[:'encryptionDomainConfig']

  raise 'You cannot provide both :encryptionDomainConfig and :encryption_domain_config' if attributes.key?(:'encryptionDomainConfig') && attributes.key?(:'encryption_domain_config')

  self.encryption_domain_config = attributes[:'encryption_domain_config'] if attributes[:'encryption_domain_config']
end

Instance Attribute Details

#associated_virtual_circuits ⇒ Array<String>

The list of virtual circuit OCID[https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm]s over which your network can reach this tunnel.

Returns:

  • (Array<String>) 


94
95
96
 
# File 'lib/oci/core/models/create_ip_sec_connection_tunnel_details.rb', line 94

def associated_virtual_circuits
  @associated_virtual_circuits
end

#bgp_session_config ⇒ OCI::Core::Models::CreateIPSecTunnelBgpSessionDetails

Returns:



58
59
60
 
# File 'lib/oci/core/models/create_ip_sec_connection_tunnel_details.rb', line 58

def bgp_session_config
  @bgp_session_config
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/core/models/create_ip_sec_connection_tunnel_details.rb', line 37

def display_name
  @display_name
end

#dpd_config ⇒ OCI::Core::Models::DpdConfig

Returns:



84
85
86
 
# File 'lib/oci/core/models/create_ip_sec_connection_tunnel_details.rb', line 84

def dpd_config
  @dpd_config
end

#drg_route_table_id ⇒ String

The OCID of the DRG route table assigned to this attachment.

The DRG route table manages traffic inside the DRG.

Returns:

  • (String) 


101
102
103
 
# File 'lib/oci/core/models/create_ip_sec_connection_tunnel_details.rb', line 101

def drg_route_table_id
  @drg_route_table_id
end

#encryption_domain_config ⇒ OCI::Core::Models::CreateIPSecTunnelEncryptionDomainDetails

Returns:



104
105
106
 
# File 'lib/oci/core/models/create_ip_sec_connection_tunnel_details.rb', line 104

def encryption_domain_config
  @encryption_domain_config
end

#ike_version ⇒ String

Internet Key Exchange protocol version.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/core/models/create_ip_sec_connection_tunnel_details.rb', line 47

def ike_version
  @ike_version
end

#nat_translation_enabled ⇒ String

By default (the AUTO setting), IKE sends packets with a source and destination port set to 500, and when it detects that the port used to forward packets has changed (most likely because a NAT device is between the CPE device and the Oracle VPN headend) it will try to negotiate the use of NAT-T.

The ENABLED option sets the IKE protocol to use port 4500 instead of 500 and forces encapsulating traffic with the ESP protocol inside UDP packets.

The DISABLED option directs IKE to completely refuse to negotiate NAT-T even if it senses there may be a NAT device in use.

Returns:

  • (String) 


75
76
77
 
# File 'lib/oci/core/models/create_ip_sec_connection_tunnel_details.rb', line 75

def nat_translation_enabled
  @nat_translation_enabled
end

#oracle_initiation ⇒ String

Indicates whether the Oracle end of the IPSec connection is able to initiate starting up the IPSec tunnel.

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/core/models/create_ip_sec_connection_tunnel_details.rb', line 63

def oracle_initiation
  @oracle_initiation
end

#oracle_tunnel_ip ⇒ String

The headend IP that you can choose on the Oracle side to terminate your private IPSec tunnel.

Returns:

  • (String) 


89
90
91
 
# File 'lib/oci/core/models/create_ip_sec_connection_tunnel_details.rb', line 89

def oracle_tunnel_ip
  @oracle_tunnel_ip
end

#phase_one_config ⇒ OCI::Core::Models::PhaseOneConfigDetails

Returns:



78
79
80
 
# File 'lib/oci/core/models/create_ip_sec_connection_tunnel_details.rb', line 78

def phase_one_config
  @phase_one_config
end

#phase_two_config ⇒ OCI::Core::Models::PhaseTwoConfigDetails

Returns:



81
82
83
 
# File 'lib/oci/core/models/create_ip_sec_connection_tunnel_details.rb', line 81

def phase_two_config
  @phase_two_config
end

#routing ⇒ String

The type of routing to use for this tunnel (BGP dynamic routing, static routing, or policy-based routing).

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/core/models/create_ip_sec_connection_tunnel_details.rb', line 42

def routing
  @routing
end

#shared_secret ⇒ String

The shared secret (pre-shared key) to use for the IPSec tunnel. Only numbers, letters, and spaces are allowed. If you don't provide a value, Oracle generates a value for you. You can specify your own shared secret later if you like with update_ip_sec_connection_tunnel_shared_secret.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/core/models/create_ip_sec_connection_tunnel_details.rb', line 55

def shared_secret
  @shared_secret
end

Class Method Details

.attribute_map ⇒ Object

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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/oci/core/models/create_ip_sec_connection_tunnel_details.rb', line 107

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'routing': :'routing',
    'ike_version': :'ikeVersion',
    'shared_secret': :'sharedSecret',
    'bgp_session_config': :'bgpSessionConfig',
    'oracle_initiation': :'oracleInitiation',
    'nat_translation_enabled': :'natTranslationEnabled',
    'phase_one_config': :'phaseOneConfig',
    'phase_two_config': :'phaseTwoConfig',
    'dpd_config': :'dpdConfig',
    'oracle_tunnel_ip': :'oracleTunnelIp',
    'associated_virtual_circuits': :'associatedVirtualCircuits',
    'drg_route_table_id': :'drgRouteTableId',
    'encryption_domain_config': :'encryptionDomainConfig'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/core/models/create_ip_sec_connection_tunnel_details.rb', line 129

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'routing': :'String',
    'ike_version': :'String',
    'shared_secret': :'String',
    'bgp_session_config': :'OCI::Core::Models::CreateIPSecTunnelBgpSessionDetails',
    'oracle_initiation': :'String',
    'nat_translation_enabled': :'String',
    'phase_one_config': :'OCI::Core::Models::PhaseOneConfigDetails',
    'phase_two_config': :'OCI::Core::Models::PhaseTwoConfigDetails',
    'dpd_config': :'OCI::Core::Models::DpdConfig',
    'oracle_tunnel_ip': :'String',
    'associated_virtual_circuits': :'Array<String>',
    'drg_route_table_id': :'String',
    'encryption_domain_config': :'OCI::Core::Models::CreateIPSecTunnelEncryptionDomainDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/oci/core/models/create_ip_sec_connection_tunnel_details.rb', line 296

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    display_name == other.display_name &&
    routing == other.routing &&
    ike_version == other.ike_version &&
    shared_secret == other.shared_secret &&
    bgp_session_config == other.bgp_session_config &&
    oracle_initiation == other.oracle_initiation &&
    nat_translation_enabled == other.nat_translation_enabled &&
    phase_one_config == other.phase_one_config &&
    phase_two_config == other.phase_two_config &&
    dpd_config == other.dpd_config &&
    oracle_tunnel_ip == other.oracle_tunnel_ip &&
    associated_virtual_circuits == other.associated_virtual_circuits &&
    drg_route_table_id == other.drg_route_table_id &&
    encryption_domain_config == other.encryption_domain_config
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



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/oci/core/models/create_ip_sec_connection_tunnel_details.rb', line 339

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


319
320
321
 
# File 'lib/oci/core/models/create_ip_sec_connection_tunnel_details.rb', line 319

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



328
329
330
 
# File 'lib/oci/core/models/create_ip_sec_connection_tunnel_details.rb', line 328

def hash
  [display_name, routing, ike_version, shared_secret, bgp_session_config, oracle_initiation, nat_translation_enabled, phase_one_config, phase_two_config, dpd_config, oracle_tunnel_ip, associated_virtual_circuits, drg_route_table_id, encryption_domain_config].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



372
373
374
375
376
377
378
379
380
381
 
# File 'lib/oci/core/models/create_ip_sec_connection_tunnel_details.rb', line 372

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    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



366
367
368
 
# File 'lib/oci/core/models/create_ip_sec_connection_tunnel_details.rb', line 366

def to_s
  to_hash.to_s
end