Class: OracleBMC::Core::Models::IPSecConnection

Inherits:
Object
  • Object
show all
Defined in:
lib/oraclebmc/core/models/ip_sec_connection.rb

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

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IPSecConnection

Initializes the object

Parameters:

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

    Model attributes in the form of hash



56
57
58
59
60
61
62
63
64
65
66
67
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
 
# File 'lib/oraclebmc/core/models/ip_sec_connection.rb', line 56

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
  
  if attributes[:'cpeId']
    self.cpe_id = attributes[:'cpeId']
  end
  
  if attributes[:'displayName']
    self.display_name = attributes[:'displayName']
  end
  
  if attributes[:'drgId']
    self.drg_id = attributes[:'drgId']
  end
  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'lifecycleState']
    self.lifecycle_state = attributes[:'lifecycleState']
  end
  
  if attributes[:'staticRoutes']
    self.static_routes = attributes[:'staticRoutes']
  end
  
  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end
  
end

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the compartment containing the IPSec connection.

Returns:

  • (String) 


16
17
18
 
# File 'lib/oraclebmc/core/models/ip_sec_connection.rb', line 16

def compartment_id
  @compartment_id
end

#cpe_id ⇒ String

The OCID of the CPE.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oraclebmc/core/models/ip_sec_connection.rb', line 20

def cpe_id
  @cpe_id
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it’s changeable.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oraclebmc/core/models/ip_sec_connection.rb', line 24

def display_name
  @display_name
end

#drg_id ⇒ String

The OCID of the DRG.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oraclebmc/core/models/ip_sec_connection.rb', line 28

def drg_id
  @drg_id
end

#id ⇒ String

The IPSec connection’s Oracle ID (OCID).

Returns:

  • (String) 


32
33
34
 
# File 'lib/oraclebmc/core/models/ip_sec_connection.rb', line 32

def id
  @id
end

#lifecycle_state ⇒ String

The IPSec connection’s current state.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oraclebmc/core/models/ip_sec_connection.rb', line 36

def lifecycle_state
  @lifecycle_state
end

#static_routes ⇒ Array<String>

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`

Returns:

  • (Array<String>) 


44
45
46
 
# File 'lib/oraclebmc/core/models/ip_sec_connection.rb', line 44

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) 


51
52
53
 
# File 'lib/oraclebmc/core/models/ip_sec_connection.rb', line 51

def time_created
  @time_created
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/oraclebmc/core/models/ip_sec_connection.rb', line 109

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/oraclebmc/core/models/ip_sec_connection.rb', line 137

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.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| OracleBMC::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", OracleBMC::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

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


124
125
126
 
# File 'lib/oraclebmc/core/models/ip_sec_connection.rb', line 124

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



130
131
132
 
# File 'lib/oraclebmc/core/models/ip_sec_connection.rb', line 130

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

Returns:

  • (Hash) —

    Returns the object in the form of hash



162
163
164
165
166
167
168
169
170
 
# File 'lib/oraclebmc/core/models/ip_sec_connection.rb', line 162

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



156
157
158
 
# File 'lib/oraclebmc/core/models/ip_sec_connection.rb', line 156

def to_s
  to_hash.to_s
end