Class: OCI::Core::Models::BgpSessionInfo

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

Overview

Information for establishing a BGP session for the IPSec tunnel.

Constant Summary collapse

BGP_STATE_ENUM = 
[
  BGP_STATE_UP = 'UP'.freeze,
  BGP_STATE_DOWN = 'DOWN'.freeze,
  BGP_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BgpSessionInfo

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :oracle_interface_ip (String) —

    The value to assign to the #oracle_interface_ip property

  • :customer_interface_ip (String) —

    The value to assign to the #customer_interface_ip property

  • :oracle_bgp_asn (String) —

    The value to assign to the #oracle_bgp_asn property

  • :customer_bgp_asn (String) —

    The value to assign to the #customer_bgp_asn property

  • :bgp_state (String) —

    The value to assign to the #bgp_state property



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
 
# File 'lib/oci/core/models/bgp_session_info.rb', line 107

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

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

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

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

  self.bgp_state = attributes[:'bgpState'] if attributes[:'bgpState']

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

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

Instance Attribute Details

#bgp_state ⇒ String

The state of the BGP session.

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/core/models/bgp_session_info.rb', line 68

def bgp_state
  @bgp_state
end

#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 uses static routing, the ‘customerBgpAsn` must be null.

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

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/core/models/bgp_session_info.rb', line 63

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 so you can troubleshoot or monitor the tunnel.

The value must be a /30 or /31.

Example: ‘10.0.0.5/31`

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/core/models/bgp_session_info.rb', line 46

def customer_interface_ip
  @customer_interface_ip
end

#oracle_bgp_asn ⇒ String

The Oracle BGP ASN.

Returns:

  • (String) 


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

def oracle_bgp_asn
  @oracle_bgp_asn
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 so you can troubleshoot or monitor the tunnel.

The value must be a /30 or /31.

Example: ‘10.0.0.4/31`

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/core/models/bgp_session_info.rb', line 30

def oracle_interface_ip
  @oracle_interface_ip
end

Class Method Details

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/oci/core/models/bgp_session_info.rb', line 71

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

.swagger_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/oci/core/models/bgp_session_info.rb', line 84

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



164
165
166
167
168
169
170
171
172
173
 
# File 'lib/oci/core/models/bgp_session_info.rb', line 164

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 &&
    oracle_bgp_asn == other.oracle_bgp_asn &&
    customer_bgp_asn == other.customer_bgp_asn &&
    bgp_state == other.bgp_state
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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/oci/core/models/bgp_session_info.rb', line 198

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


178
179
180
 
# File 'lib/oci/core/models/bgp_session_info.rb', line 178

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



187
188
189
 
# File 'lib/oci/core/models/bgp_session_info.rb', line 187

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



231
232
233
234
235
236
237
238
239
240
 
# File 'lib/oci/core/models/bgp_session_info.rb', line 231

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



225
226
227
 
# File 'lib/oci/core/models/bgp_session_info.rb', line 225

def to_s
  to_hash.to_s
end