Class: OCI::Core::Models::TunnelConfig

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

Overview

Specific connection details for an IPSec tunnel.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TunnelConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :ip_address (String)

    The value to assign to the #ip_address property

  • :shared_secret (String)

    The value to assign to the #shared_secret property

  • :time_created (DateTime)

    The value to assign to the #time_created property



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'lib/oci/core/models/tunnel_config.rb', line 61

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

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

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

  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.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']
end

Instance Attribute Details

#ip_addressString

[Required] The IP address of Oracle’s VPN headend.

Example: ‘129.146.17.50`

Returns:

  • (String)


14
15
16
# File 'lib/oci/core/models/tunnel_config.rb', line 14

def ip_address
  @ip_address
end

#shared_secretString

[Required] The shared secret of the IPSec tunnel.

Example: ‘vFG2IF6TWq4UToUiLSRDoJEUs6j1c.p8G.dVQxiMfMO0yXMLi.lZTbYIWhGu4V8o`

Returns:

  • (String)


21
22
23
# File 'lib/oci/core/models/tunnel_config.rb', line 21

def shared_secret
  @shared_secret
end

#time_createdDateTime

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

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

Returns:

  • (DateTime)


28
29
30
# File 'lib/oci/core/models/tunnel_config.rb', line 28

def time_created
  @time_created
end

Class Method Details

.attribute_mapObject

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



31
32
33
34
35
36
37
38
39
# File 'lib/oci/core/models/tunnel_config.rb', line 31

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'ip_address': :'ipAddress',
    'shared_secret': :'sharedSecret',
    'time_created': :'timeCreated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



42
43
44
45
46
47
48
49
50
# File 'lib/oci/core/models/tunnel_config.rb', line 42

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'ip_address': :'String',
    'shared_secret': :'String',
    'time_created': :'DateTime'
    # 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



93
94
95
96
97
98
99
100
# File 'lib/oci/core/models/tunnel_config.rb', line 93

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

  self.class == other.class &&
    ip_address == other.ip_address &&
    shared_secret == other.shared_secret &&
    time_created == other.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



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

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


105
106
107
# File 'lib/oci/core/models/tunnel_config.rb', line 105

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



114
115
116
# File 'lib/oci/core/models/tunnel_config.rb', line 114

def hash
  [ip_address, shared_secret, time_created].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



158
159
160
161
162
163
164
165
166
167
# File 'lib/oci/core/models/tunnel_config.rb', line 158

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



152
153
154
# File 'lib/oci/core/models/tunnel_config.rb', line 152

def to_s
  to_hash.to_s
end