Class: OCI::Core::Models::CrossConnectMapping

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

Overview

For use with Oracle Cloud Infrastructure FastConnect. Each VirtualCircuit runs on one or more cross-connects or cross-connect groups. A ‘CrossConnectMapping` contains the properties for an individual cross-connect or cross-connect group associated with a given virtual circuit.

The mapping includes information about the cross-connect or cross-connect group, the VLAN, and the BGP peering session.

If you’re a customer who is colocated with Oracle, that means you own both the virtual circuit and the physical connection it runs on (cross-connect or cross-connect group), so you specify all the information in the mapping. There’s one exception: for a public virtual circuit, Oracle specifies the BGP IP addresses.

If you’re a provider, then you own the physical connection that the customer’s virtual circuit runs on, so you contribute information about the cross-connect or cross-connect group and VLAN.

Who specifies the BGP peering information in the case of customer connection via provider? If the BGP session goes from Oracle to the provider’s edge router, then the provider also specifies the BGP peering information. If the BGP session instead goes from Oracle to the customer’s edge router, then the customer specifies the BGP peering information. There’s one exception: for a public virtual circuit, Oracle specifies the BGP IP addresses.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CrossConnectMapping

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
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
 
# File 'lib/oci/core/models/cross_connect_mapping.rb', line 91

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[:'bgpMd5AuthKey']
    self.bgp_md5_auth_key = attributes[:'bgpMd5AuthKey']
  end

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

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

  if attributes[:'crossConnectOrCrossConnectGroupId']
    self.cross_connect_or_cross_connect_group_id = attributes[:'crossConnectOrCrossConnectGroupId']
  end

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

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

  if attributes[:'customerBgpPeeringIp']
    self.customer_bgp_peering_ip = attributes[:'customerBgpPeeringIp']
  end

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

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

  if attributes[:'oracleBgpPeeringIp']
    self.oracle_bgp_peering_ip = attributes[:'oracleBgpPeeringIp']
  end

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

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

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

end

Instance Attribute Details

#bgp_md5_auth_key ⇒ String

The key for BGP MD5 authentication. Only applicable if your system requires MD5 authentication. If empty or not set (null), that means you don’t use BGP MD5 authentication.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/core/models/cross_connect_mapping.rb', line 38

def bgp_md5_auth_key
  @bgp_md5_auth_key
end

#cross_connect_or_cross_connect_group_id ⇒ String

The OCID of the cross-connect or cross-connect group for this mapping. Specified by the owner of the cross-connect or cross-connect group (the customer if the customer is colocated with Oracle, or the provider if the customer is connecting via provider).

Returns:

  • (String) 


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

def cross_connect_or_cross_connect_group_id
  @cross_connect_or_cross_connect_group_id
end

#customer_bgp_peering_ip ⇒ String

The BGP IP address for the router on the other end of the BGP session from Oracle. Specified by the owner of that router. If the session goes from Oracle to a customer, this is the BGP IP address of the customer’s edge router. If the session goes from Oracle to a provider, this is the BGP IP address of the provider’s edge router. Must use a /30 or /31 subnet mask.

There’s one exception: for a public virtual circuit, Oracle specifies the BGP IP addresses.

Example: ‘10.0.0.18/31`

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/core/models/cross_connect_mapping.rb', line 59

def customer_bgp_peering_ip
  @customer_bgp_peering_ip
end

#oracle_bgp_peering_ip ⇒ String

The IP address for Oracle’s end of the BGP session. Must use a /30 or /31 subnet mask. If the session goes from Oracle to a customer’s edge router, the customer specifies this information. If the session goes from Oracle to a provider’s edge router, the provider specifies this.

There’s one exception: for a public virtual circuit, Oracle specifies the BGP IP addresses.

Example: ‘10.0.0.19/31`

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/core/models/cross_connect_mapping.rb', line 71

def oracle_bgp_peering_ip
  @oracle_bgp_peering_ip
end

#vlan ⇒ Integer

The number of the specific VLAN (on the cross-connect or cross-connect group) that is assigned to this virtual circuit. Specified by the owner of the cross-connect or cross-connect group (the customer if the customer is colocated with Oracle, or the provider if the customer is connecting via provider).

Example: ‘200`

Returns:

  • (Integer) 


81
82
83
 
# File 'lib/oci/core/models/cross_connect_mapping.rb', line 81

def vlan
  @vlan
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/core/models/cross_connect_mapping.rb', line 145

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      bgp_md5_auth_key == other_object.bgp_md5_auth_key &&
      cross_connect_or_cross_connect_group_id == other_object.cross_connect_or_cross_connect_group_id &&
      customer_bgp_peering_ip == other_object.customer_bgp_peering_ip &&
      oracle_bgp_peering_ip == other_object.oracle_bgp_peering_ip &&
      vlan == other_object.vlan
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



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/oci/core/models/cross_connect_mapping.rb', line 170

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

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


157
158
159
 
# File 'lib/oci/core/models/cross_connect_mapping.rb', line 157

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



163
164
165
 
# File 'lib/oci/core/models/cross_connect_mapping.rb', line 163

def hash
  [bgp_md5_auth_key, cross_connect_or_cross_connect_group_id, customer_bgp_peering_ip, oracle_bgp_peering_ip, vlan].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



195
196
197
198
199
200
201
202
203
 
# File 'lib/oci/core/models/cross_connect_mapping.rb', line 195

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



189
190
191
 
# File 'lib/oci/core/models/cross_connect_mapping.rb', line 189

def to_s
  to_hash.to_s
end