class OCI::Core::Models::BgpSessionInfo
Information for establishing a BGP session for the IPSec tunnel.
Constants
- BGP_IPV6_STATE_ENUM
- BGP_STATE_ENUM
Attributes
The state of the BGP IPv6 session.
@return [String]
The state of the BGP session.
@return [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)
@return [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`
@return [String]
The IPv6 address for the CPE end of the inside tunnel interface. This IP address is optional.
If the tunnel's `routing` attribute is set to `BGP` (see {IPSecConnectionTunnel}), this IP address is used for the tunnel's BGP session.
If `routing` is instead set to `STATIC`, you can set this IP address to troubleshoot or monitor the tunnel.
Only subnet masks from /64 up to /127 are allowed.
Example: `2001:db8::1/64`
@return [String]
The Oracle BGP ASN.
@return [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`
@return [String]
The IPv6 address for the Oracle end of the inside tunnel interface. This IP address is optional.
If the tunnel's `routing` attribute is set to `BGP` (see {IPSecConnectionTunnel}), this IP address is used for the tunnel's BGP session.
If `routing` is instead set to `STATIC`, you can set this IP address to troubleshoot or monitor the tunnel.
Only subnet masks from /64 up to /127 are allowed.
Example: `2001:db8::1/64`
@return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/core/models/bgp_session_info.rb, line 115 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'oracle_interface_ip': :'oracleInterfaceIp', 'customer_interface_ip': :'customerInterfaceIp', 'oracle_interface_ipv6': :'oracleInterfaceIpv6', 'customer_interface_ipv6': :'customerInterfaceIpv6', 'oracle_bgp_asn': :'oracleBgpAsn', 'customer_bgp_asn': :'customerBgpAsn', 'bgp_state': :'bgpState', 'bgp_ipv6_state': :'bgpIpv6State' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :oracle_interface_ip The value to assign to the {#oracle_interface_ip} property @option attributes [String] :customer_interface_ip The value to assign to the {#customer_interface_ip} property @option attributes [String] :oracle_interface_ipv6 The value to assign to the {#oracle_interface_ipv6} property @option attributes [String] :customer_interface_ipv6 The value to assign to the {#customer_interface_ipv6} property @option attributes [String] :oracle_bgp_asn The value to assign to the {#oracle_bgp_asn} property @option attributes [String] :customer_bgp_asn The value to assign to the {#customer_bgp_asn} property @option attributes [String] :bgp_state The value to assign to the {#bgp_state} property @option attributes [String] :bgp_ipv6_state The value to assign to the {#bgp_ipv6_state} property
# File lib/oci/core/models/bgp_session_info.rb, line 160 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_interface_ipv6 = attributes[:'oracleInterfaceIpv6'] if attributes[:'oracleInterfaceIpv6'] raise 'You cannot provide both :oracleInterfaceIpv6 and :oracle_interface_ipv6' if attributes.key?(:'oracleInterfaceIpv6') && attributes.key?(:'oracle_interface_ipv6') self.oracle_interface_ipv6 = attributes[:'oracle_interface_ipv6'] if attributes[:'oracle_interface_ipv6'] self.customer_interface_ipv6 = attributes[:'customerInterfaceIpv6'] if attributes[:'customerInterfaceIpv6'] raise 'You cannot provide both :customerInterfaceIpv6 and :customer_interface_ipv6' if attributes.key?(:'customerInterfaceIpv6') && attributes.key?(:'customer_interface_ipv6') self.customer_interface_ipv6 = attributes[:'customer_interface_ipv6'] if attributes[:'customer_interface_ipv6'] 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'] self.bgp_ipv6_state = attributes[:'bgpIpv6State'] if attributes[:'bgpIpv6State'] raise 'You cannot provide both :bgpIpv6State and :bgp_ipv6_state' if attributes.key?(:'bgpIpv6State') && attributes.key?(:'bgp_ipv6_state') self.bgp_ipv6_state = attributes[:'bgp_ipv6_state'] if attributes[:'bgp_ipv6_state'] end
Attribute type mapping.
# File lib/oci/core/models/bgp_session_info.rb, line 131 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'oracle_interface_ip': :'String', 'customer_interface_ip': :'String', 'oracle_interface_ipv6': :'String', 'customer_interface_ipv6': :'String', 'oracle_bgp_asn': :'String', 'customer_bgp_asn': :'String', 'bgp_state': :'String', 'bgp_ipv6_state': :'String' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/core/models/bgp_session_info.rb, line 248 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_interface_ipv6 == other.oracle_interface_ipv6 && customer_interface_ipv6 == other.customer_interface_ipv6 && oracle_bgp_asn == other.oracle_bgp_asn && customer_bgp_asn == other.customer_bgp_asn && bgp_state == other.bgp_state && bgp_ipv6_state == other.bgp_ipv6_state end
Custom attribute writer method checking allowed values (enum). @param [Object] bgp_ipv6_state
Object
to be assigned
# File lib/oci/core/models/bgp_session_info.rb, line 232 def bgp_ipv6_state=(bgp_ipv6_state) # rubocop:disable Style/ConditionalAssignment if bgp_ipv6_state && !BGP_IPV6_STATE_ENUM.include?(bgp_ipv6_state) OCI.logger.debug("Unknown value for 'bgp_ipv6_state' [" + bgp_ipv6_state + "]. Mapping to 'BGP_IPV6_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger @bgp_ipv6_state = BGP_IPV6_STATE_UNKNOWN_ENUM_VALUE else @bgp_ipv6_state = bgp_ipv6_state end # rubocop:enable Style/ConditionalAssignment end
Custom attribute writer method checking allowed values (enum). @param [Object] bgp_state
Object
to be assigned
# File lib/oci/core/models/bgp_session_info.rb, line 219 def bgp_state=(bgp_state) # rubocop:disable Style/ConditionalAssignment if bgp_state && !BGP_STATE_ENUM.include?(bgp_state) OCI.logger.debug("Unknown value for 'bgp_state' [" + bgp_state + "]. Mapping to 'BGP_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger @bgp_state = BGP_STATE_UNKNOWN_ENUM_VALUE else @bgp_state = bgp_state end # rubocop:enable Style/ConditionalAssignment end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/core/models/bgp_session_info.rb, line 285 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/core/models/bgp_session_info.rb, line 265 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/core/models/bgp_session_info.rb, line 274 def hash [oracle_interface_ip, customer_interface_ip, oracle_interface_ipv6, customer_interface_ipv6, oracle_bgp_asn, customer_bgp_asn, bgp_state, bgp_ipv6_state].hash end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/core/models/bgp_session_info.rb, line 318 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/core/models/bgp_session_info.rb, line 312 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/core/models/bgp_session_info.rb, line 335 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end