Class: OCI::Core::Models::IPSecConnection
- Inherits:
-
Object
- Object
- OCI::Core::Models::IPSecConnection
- Defined in:
- lib/oci/core/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 an IPSec VPN. For more information, see [Overview of the Networking Service](docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm).
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](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING', LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE', LIFECYCLE_STATE_TERMINATING = 'TERMINATING', LIFECYCLE_STATE_TERMINATED = 'TERMINATED', LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the IPSec connection.
-
#cpe_id ⇒ String
[Required] The OCID of the CPE.
-
#display_name ⇒ String
A user-friendly name.
-
#drg_id ⇒ String
[Required] The OCID of the DRG.
-
#id ⇒ String
[Required] The IPSec connection’s Oracle ID (OCID).
-
#lifecycle_state ⇒ String
[Required] The IPSec connection’s current state.
-
#static_routes ⇒ Array<String>
[Required] Static routes to the CPE.
-
#time_created ⇒ DateTime
The date and time the IPSec connection was created, in the format defined by RFC3339.
Instance Method Summary collapse
-
#==(other_object) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other_object) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ IPSecConnection
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ IPSecConnection
Initializes the object
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 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 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 |
# File 'lib/oci/core/models/ip_sec_connection.rb', line 75 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} if attributes[:'compartmentId'] self.compartment_id = attributes[:'compartmentId'] end raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id') if attributes[:'compartment_id'] self.compartment_id = attributes[:'compartment_id'] end if attributes[:'cpeId'] self.cpe_id = attributes[:'cpeId'] end raise 'You cannot provide both :cpeId and :cpe_id' if attributes.key?(:'cpeId') && attributes.key?(:'cpe_id') if attributes[:'cpe_id'] self.cpe_id = attributes[:'cpe_id'] end if attributes[:'displayName'] self.display_name = attributes[:'displayName'] end raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name') if attributes[:'display_name'] self.display_name = attributes[:'display_name'] end if attributes[:'drgId'] self.drg_id = attributes[:'drgId'] end raise 'You cannot provide both :drgId and :drg_id' if attributes.key?(:'drgId') && attributes.key?(:'drg_id') if attributes[:'drg_id'] self.drg_id = attributes[:'drg_id'] end if attributes[:'id'] self.id = attributes[:'id'] end if attributes[:'lifecycleState'] self.lifecycle_state = attributes[:'lifecycleState'] end raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state') if attributes[:'lifecycle_state'] self.lifecycle_state = attributes[:'lifecycle_state'] end if attributes[:'staticRoutes'] self.static_routes = attributes[:'staticRoutes'] end raise 'You cannot provide both :staticRoutes and :static_routes' if attributes.key?(:'staticRoutes') && attributes.key?(:'static_routes') if attributes[:'static_routes'] self.static_routes = attributes[:'static_routes'] end if attributes[:'timeCreated'] self.time_created = attributes[:'timeCreated'] end raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') if attributes[:'time_created'] self.time_created = attributes[:'time_created'] end end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the IPSec connection.
25 26 27 |
# File 'lib/oci/core/models/ip_sec_connection.rb', line 25 def compartment_id @compartment_id end |
#cpe_id ⇒ String
[Required] The OCID of the CPE.
29 30 31 |
# File 'lib/oci/core/models/ip_sec_connection.rb', line 29 def cpe_id @cpe_id end |
#display_name ⇒ String
A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
35 36 37 |
# File 'lib/oci/core/models/ip_sec_connection.rb', line 35 def display_name @display_name end |
#drg_id ⇒ String
[Required] The OCID of the DRG.
39 40 41 |
# File 'lib/oci/core/models/ip_sec_connection.rb', line 39 def drg_id @drg_id end |
#id ⇒ String
[Required] The IPSec connection’s Oracle ID (OCID).
43 44 45 |
# File 'lib/oci/core/models/ip_sec_connection.rb', line 43 def id @id end |
#lifecycle_state ⇒ String
[Required] The IPSec connection’s current state.
47 48 49 |
# File 'lib/oci/core/models/ip_sec_connection.rb', line 47 def lifecycle_state @lifecycle_state end |
#static_routes ⇒ Array<String>
[Required] Static routes to the CPE. At least one route must be included. The CIDR must not be a multicast address or class E address.
Example: ‘10.0.1.0/24`
55 56 57 |
# File 'lib/oci/core/models/ip_sec_connection.rb', line 55 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`
62 63 64 |
# File 'lib/oci/core/models/ip_sec_connection.rb', line 62 def time_created @time_created end |
Instance Method Details
#==(other_object) ⇒ Object
Checks equality by comparing each attribute.
169 170 171 172 173 174 175 176 177 178 179 180 |
# File 'lib/oci/core/models/ip_sec_connection.rb', line 169 def ==(other_object) return true if self.equal?(other_object) self.class == other_object.class && compartment_id == other_object.compartment_id && cpe_id == other_object.cpe_id && display_name == other_object.display_name && drg_id == other_object.drg_id && id == other_object.id && lifecycle_state == other_object.lifecycle_state && static_routes == other_object.static_routes && time_created == other_object.time_created end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 |
# File 'lib/oci/core/models/ip_sec_connection.rb', line 197 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) self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? self.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_object) ⇒ Boolean
184 185 186 |
# File 'lib/oci/core/models/ip_sec_connection.rb', line 184 def eql?(other_object) self == other_object end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
190 191 192 |
# File 'lib/oci/core/models/ip_sec_connection.rb', line 190 def hash [compartment_id, cpe_id, display_name, drg_id, id, lifecycle_state, static_routes, time_created].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
222 223 224 225 226 227 228 229 230 |
# File 'lib/oci/core/models/ip_sec_connection.rb', line 222 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
216 217 218 |
# File 'lib/oci/core/models/ip_sec_connection.rb', line 216 def to_s to_hash.to_s end |