Class: OCI::Core::Models::CreateIPSecTunnelBgpSessionDetails

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

Overview

CreateIPSecTunnelBgpSessionDetails model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateIPSecTunnelBgpSessionDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/core/models/create_ip_sec_tunnel_bgp_session_details.rb', line 84

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

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

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

  self.customer_interface_ip = attributes[:'customerInterfaceIp'] if attributes[:'customerInterfaceIp']

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

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

  self.customer_bgp_asn = attributes[:'customerBgpAsn'] if attributes[:'customerBgpAsn']

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

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

Instance Attribute Details

#customer_bgp_asn ⇒ String

If the tunnel’s ‘routing` attribute is set to `BGP` (see IPSecConnectionTunnel), this ASN is required and used for the tunnel’s BGP session. This is the ASN of the network on the CPE end of the BGP session. Can be a 2-byte or 4-byte ASN. Uses "asplain" format.

If the tunnel’s ‘routing` attribute is set to `STATIC`, the `customerBgpAsn` must be null.

Example: ‘12345` (2-byte) or `1587232876` (4-byte)

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/core/models/create_ip_sec_tunnel_bgp_session_details.rb', line 51

def customer_bgp_asn
  @customer_bgp_asn
end

#customer_interface_ip ⇒ String

The IP address for the CPE end of the inside tunnel interface.

If the tunnel’s ‘routing` attribute is set to `BGP` (see IPSecConnectionTunnel), this IP address is required and used for the tunnel’s BGP session.

If ‘routing` is instead set to `STATIC`, this IP address is optional. You can set this IP address to troubleshoot or monitor the tunnel.

The value must be a /30 or /31.

Example: ‘10.0.0.5/31`

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/core/models/create_ip_sec_tunnel_bgp_session_details.rb', line 39

def customer_interface_ip
  @customer_interface_ip
end

#oracle_interface_ip ⇒ String

The IP address for the Oracle end of the inside tunnel interface.

If the tunnel’s ‘routing` attribute is set to `BGP` (see IPSecConnectionTunnel), this IP address is required and used for the tunnel’s BGP session.

If ‘routing` is instead set to `STATIC`, this IP address is optional. You can set this IP address to troubleshoot or monitor the tunnel.

The value must be a /30 or /31.

Example: ‘10.0.0.4/31`

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/core/models/create_ip_sec_tunnel_bgp_session_details.rb', line 23

def oracle_interface_ip
  @oracle_interface_ip
end

Class Method Details

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
 
# File 'lib/oci/core/models/create_ip_sec_tunnel_bgp_session_details.rb', line 54

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'oracle_interface_ip': :'oracleInterfaceIp',
    'customer_interface_ip': :'customerInterfaceIp',
    'customer_bgp_asn': :'customerBgpAsn'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
 
# File 'lib/oci/core/models/create_ip_sec_tunnel_bgp_session_details.rb', line 65

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'oracle_interface_ip': :'String',
    'customer_interface_ip': :'String',
    'customer_bgp_asn': :'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



116
117
118
119
120
121
122
123
 
# File 'lib/oci/core/models/create_ip_sec_tunnel_bgp_session_details.rb', line 116

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

  self.class == other.class &&
    oracle_interface_ip == other.oracle_interface_ip &&
    customer_interface_ip == other.customer_interface_ip &&
    customer_bgp_asn == other.customer_bgp_asn
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



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/oci/core/models/create_ip_sec_tunnel_bgp_session_details.rb', line 148

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


128
129
130
 
# File 'lib/oci/core/models/create_ip_sec_tunnel_bgp_session_details.rb', line 128

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



137
138
139
 
# File 'lib/oci/core/models/create_ip_sec_tunnel_bgp_session_details.rb', line 137

def hash
  [oracle_interface_ip, customer_interface_ip, customer_bgp_asn].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



181
182
183
184
185
186
187
188
189
190
 
# File 'lib/oci/core/models/create_ip_sec_tunnel_bgp_session_details.rb', line 181

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



175
176
177
 
# File 'lib/oci/core/models/create_ip_sec_tunnel_bgp_session_details.rb', line 175

def to_s
  to_hash.to_s
end