Class: OCI::VnMonitoring::Models::IPSecConnection

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/vn_monitoring/models/ip_sec_connection.rb

Overview

A connection between a DRG and CPE. This connection consists of multiple IPSec tunnels. Creating this connection is one of the steps required when setting up a Site-to-Site VPN. For more information, see Site-to-Site VPN Overview.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'.freeze,
  LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'.freeze,
  LIFECYCLE_STATE_TERMINATING = 'TERMINATING'.freeze,
  LIFECYCLE_STATE_TERMINATED = 'TERMINATED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
TRANSPORT_TYPE_ENUM = 
[
  TRANSPORT_TYPE_INTERNET = 'INTERNET'.freeze,
  TRANSPORT_TYPE_FASTCONNECT = 'FASTCONNECT'.freeze,
  TRANSPORT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IPSecConnection

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :cpe_id (String) —

    The value to assign to the #cpe_id property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :drg_id (String) —

    The value to assign to the #drg_id property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :id (String) —

    The value to assign to the #id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :static_routes (Array<String>) —

    The value to assign to the #static_routes property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :transport_type (String) —

    The value to assign to the #transport_type property



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
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
 
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 148

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.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.cpe_id = attributes[:'cpeId'] if attributes[:'cpeId']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  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.drg_id = attributes[:'drgId'] if attributes[:'drgId']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.static_routes = attributes[:'staticRoutes'] if attributes[:'staticRoutes']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.transport_type = attributes[:'transportType'] if attributes[:'transportType']
  self.transport_type = "INTERNET" if transport_type.nil? && !attributes.key?(:'transportType') # rubocop:disable Style/StringLiterals

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

  self.transport_type = attributes[:'transport_type'] if attributes[:'transport_type']
  self.transport_type = "INTERNET" if transport_type.nil? && !attributes.key?(:'transportType') && !attributes.key?(:'transport_type') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the IPSec connection.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 35

def compartment_id
  @compartment_id
end

#cpe_id ⇒ String

[Required] The OCID of the Cpe object.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 39

def cpe_id
  @cpe_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


45
46
47
 
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 45

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 51

def display_name
  @display_name
end

#drg_id ⇒ String

[Required] The OCID of the DRG.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 55

def drg_id
  @drg_id
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


61
62
63
 
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 61

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The IPSec connection's Oracle ID (OCID).

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 65

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The IPSec connection's current state.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 69

def lifecycle_state
  @lifecycle_state
end

#static_routes ⇒ Array<String>

Static routes to the CPE. The CIDR must not be a multicast address or class E address.

Example: 10.0.1.0/24

Returns:

  • (Array<String>) 


79
80
81
 
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 79

def static_routes
  @static_routes
end

#time_created ⇒ DateTime

The date and time the IPSec connection was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


86
87
88
 
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 86

def time_created
  @time_created
end

#transport_type ⇒ String

The transport type used for the IPSec connection.

Returns:

  • (String) 


91
92
93
 
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 91

def transport_type
  @transport_type
end

Class Method Details

.attribute_map ⇒ Object

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



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 94

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'cpe_id': :'cpeId',
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'drg_id': :'drgId',
    'freeform_tags': :'freeformTags',
    'id': :'id',
    'lifecycle_state': :'lifecycleState',
    'static_routes': :'staticRoutes',
    'time_created': :'timeCreated',
    'transport_type': :'transportType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 113

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'cpe_id': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'drg_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'id': :'String',
    'lifecycle_state': :'String',
    'static_routes': :'Array<String>',
    'time_created': :'DateTime',
    'transport_type': :'String'
    # 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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 252

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    cpe_id == other.cpe_id &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    drg_id == other.drg_id &&
    freeform_tags == other.freeform_tags &&
    id == other.id &&
    lifecycle_state == other.lifecycle_state &&
    static_routes == other.static_routes &&
    time_created == other.time_created &&
    transport_type == other.transport_type
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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 292

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


272
273
274
 
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 272

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



281
282
283
 
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 281

def hash
  [compartment_id, cpe_id, defined_tags, display_name, drg_id, freeform_tags, id, lifecycle_state, static_routes, time_created, transport_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



325
326
327
328
329
330
331
332
333
334
 
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 325

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



319
320
321
 
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 319

def to_s
  to_hash.to_s
end