Class: OCI::Core::Models::CrossConnect

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

Overview

For use with Oracle Cloud Infrastructure FastConnect. A cross-connect represents a physical connection between an existing network and Oracle. Customers who are colocated with Oracle in a FastConnect location create and use cross-connects. For more information, see FastConnect Overview.

Oracle recommends you create each cross-connect in a CrossConnectGroup so you can use link aggregation with the connection.

Note: If you're a provider who is setting up a physical connection to Oracle so customers can use FastConnect over the connection, be aware that your connection is modeled the same way as a colocated customer's (with CrossConnect and CrossConnectGroup objects, and so on).

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_PENDING_CUSTOMER = 'PENDING_CUSTOMER'.freeze,
  LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'.freeze,
  LIFECYCLE_STATE_PROVISIONED = 'PROVISIONED'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_TERMINATING = 'TERMINATING'.freeze,
  LIFECYCLE_STATE_TERMINATED = 'TERMINATED'.freeze,
  LIFECYCLE_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 = {}) ⇒ CrossConnect

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/oci/core/models/cross_connect.rb', line 216

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

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

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

  self.cross_connect_group_id = attributes[:'crossConnectGroupId'] if attributes[:'crossConnectGroupId']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.location_name = attributes[:'locationName'] if attributes[:'locationName']

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

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

  self.port_name = attributes[:'portName'] if attributes[:'portName']

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

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

  self.port_speed_shape_name = attributes[:'portSpeedShapeName'] if attributes[:'portSpeedShapeName']

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

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

  self.customer_reference_name = attributes[:'customerReferenceName'] if attributes[:'customerReferenceName']

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

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

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

  self.macsec_properties = attributes[:'macsecProperties'] if attributes[:'macsecProperties']

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

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

  self.oci_physical_device_name = attributes[:'ociPhysicalDeviceName'] if attributes[:'ociPhysicalDeviceName']

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

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

  self.oci_logical_device_name = attributes[:'ociLogicalDeviceName'] if attributes[:'ociLogicalDeviceName']

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

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

  self.is_interface_hold_timer_enabled = attributes[:'isInterfaceHoldTimerEnabled'] unless attributes[:'isInterfaceHoldTimerEnabled'].nil?

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

  self.is_interface_hold_timer_enabled = attributes[:'is_interface_hold_timer_enabled'] unless attributes[:'is_interface_hold_timer_enabled'].nil?

  self.interface_down_timer_value_in_milliseconds = attributes[:'interfaceDownTimerValueInMilliseconds'] if attributes[:'interfaceDownTimerValueInMilliseconds']

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

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

  self.is_qos_enabled = attributes[:'isQosEnabled'] unless attributes[:'isQosEnabled'].nil?

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

  self.is_qos_enabled = attributes[:'is_qos_enabled'] unless attributes[:'is_qos_enabled'].nil?

  self.interface_name = attributes[:'interfaceName'] if attributes[:'interfaceName']

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

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

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the compartment containing the cross-connect group.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/core/models/cross_connect.rb', line 40

def compartment_id
  @compartment_id
end

#cross_connect_group_id ⇒ String

The OCID of the cross-connect group this cross-connect belongs to (if any).

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/core/models/cross_connect.rb', line 45

def cross_connect_group_id
  @cross_connect_group_id
end

#customer_reference_name ⇒ String

A reference name or identifier for the physical fiber connection that this cross-connect uses.

Returns:

  • (String) 


97
98
99
 
# File 'lib/oci/core/models/cross_connect.rb', line 97

def customer_reference_name
  @customer_reference_name
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


53
54
55
 
# File 'lib/oci/core/models/cross_connect.rb', line 53

def defined_tags
  @defined_tags
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


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

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


67
68
69
 
# File 'lib/oci/core/models/cross_connect.rb', line 67

def freeform_tags
  @freeform_tags
end

#id ⇒ String

The cross-connect's Oracle ID (OCID).

Returns:

  • (String) 


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

def id
  @id
end

#interface_down_timer_value_in_milliseconds ⇒ Integer

The duration of the interface down timer in milliseconds between 0 and 3000 in multiples of 500.

Returns:

  • (Integer) 


126
127
128
 
# File 'lib/oci/core/models/cross_connect.rb', line 126

def interface_down_timer_value_in_milliseconds
  @interface_down_timer_value_in_milliseconds
end

#interface_name ⇒ String

The name of the FastConnect interface where this cross-connect is installed.

Returns:

  • (String) 


135
136
137
 
# File 'lib/oci/core/models/cross_connect.rb', line 135

def interface_name
  @interface_name
end

#is_interface_hold_timer_enabled ⇒ BOOLEAN

The flag to enable or disable the down timer for the interface.

Returns:

  • (BOOLEAN) 


122
123
124
 
# File 'lib/oci/core/models/cross_connect.rb', line 122

def is_interface_hold_timer_enabled
  @is_interface_hold_timer_enabled
end

#is_qos_enabled ⇒ BOOLEAN

The flag to enable or disable the Qos for the cross-connect.

Returns:

  • (BOOLEAN) 


130
131
132
 
# File 'lib/oci/core/models/cross_connect.rb', line 130

def is_qos_enabled
  @is_qos_enabled
end

#lifecycle_state ⇒ String

The cross-connect's current state.

Returns:

  • (String) 


75
76
77
 
# File 'lib/oci/core/models/cross_connect.rb', line 75

def lifecycle_state
  @lifecycle_state
end

#location_name ⇒ String

The name of the FastConnect location where this cross-connect is installed.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/core/models/cross_connect.rb', line 80

def location_name
  @location_name
end

#macsec_properties ⇒ OCI::Core::Models::MacsecProperties

Returns:



107
108
109
 
# File 'lib/oci/core/models/cross_connect.rb', line 107

def macsec_properties
  @macsec_properties
end

#oci_logical_device_name ⇒ String

The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.

Returns:

  • (String) 


118
119
120
 
# File 'lib/oci/core/models/cross_connect.rb', line 118

def oci_logical_device_name
  @oci_logical_device_name
end

#oci_physical_device_name ⇒ String

The FastConnect device that terminates the physical connection.

Returns:

  • (String) 


112
113
114
 
# File 'lib/oci/core/models/cross_connect.rb', line 112

def oci_physical_device_name
  @oci_physical_device_name
end

#port_name ⇒ String

A string identifying the meet-me room port for this cross-connect.

Returns:

  • (String) 


84
85
86
 
# File 'lib/oci/core/models/cross_connect.rb', line 84

def port_name
  @port_name
end

#port_speed_shape_name ⇒ String

The port speed for this cross-connect.

Example: 10 Gbps

Returns:

  • (String) 


91
92
93
 
# File 'lib/oci/core/models/cross_connect.rb', line 91

def port_speed_shape_name
  @port_speed_shape_name
end

#time_created ⇒ DateTime

The date and time the cross-connect was created, in the format defined by RFC3339.

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

Returns:

  • (DateTime) 


104
105
106
 
# File 'lib/oci/core/models/cross_connect.rb', line 104

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/oci/core/models/cross_connect.rb', line 138

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'cross_connect_group_id': :'crossConnectGroupId',
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'freeform_tags': :'freeformTags',
    'id': :'id',
    'lifecycle_state': :'lifecycleState',
    'location_name': :'locationName',
    'port_name': :'portName',
    'port_speed_shape_name': :'portSpeedShapeName',
    'customer_reference_name': :'customerReferenceName',
    'time_created': :'timeCreated',
    'macsec_properties': :'macsecProperties',
    'oci_physical_device_name': :'ociPhysicalDeviceName',
    'oci_logical_device_name': :'ociLogicalDeviceName',
    'is_interface_hold_timer_enabled': :'isInterfaceHoldTimerEnabled',
    'interface_down_timer_value_in_milliseconds': :'interfaceDownTimerValueInMilliseconds',
    'is_qos_enabled': :'isQosEnabled',
    'interface_name': :'interfaceName'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/oci/core/models/cross_connect.rb', line 165

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'cross_connect_group_id': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'id': :'String',
    'lifecycle_state': :'String',
    'location_name': :'String',
    'port_name': :'String',
    'port_speed_shape_name': :'String',
    'customer_reference_name': :'String',
    'time_created': :'DateTime',
    'macsec_properties': :'OCI::Core::Models::MacsecProperties',
    'oci_physical_device_name': :'String',
    'oci_logical_device_name': :'String',
    'is_interface_hold_timer_enabled': :'BOOLEAN',
    'interface_down_timer_value_in_milliseconds': :'Integer',
    'is_qos_enabled': :'BOOLEAN',
    'interface_name': :'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



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/oci/core/models/cross_connect.rb', line 353

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    cross_connect_group_id == other.cross_connect_group_id &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    freeform_tags == other.freeform_tags &&
    id == other.id &&
    lifecycle_state == other.lifecycle_state &&
    location_name == other.location_name &&
    port_name == other.port_name &&
    port_speed_shape_name == other.port_speed_shape_name &&
    customer_reference_name == other.customer_reference_name &&
    time_created == other.time_created &&
    macsec_properties == other.macsec_properties &&
    oci_physical_device_name == other.oci_physical_device_name &&
    oci_logical_device_name == other.oci_logical_device_name &&
    is_interface_hold_timer_enabled == other.is_interface_hold_timer_enabled &&
    interface_down_timer_value_in_milliseconds == other.interface_down_timer_value_in_milliseconds &&
    is_qos_enabled == other.is_qos_enabled &&
    interface_name == other.interface_name
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



401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/oci/core/models/cross_connect.rb', line 401

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


381
382
383
 
# File 'lib/oci/core/models/cross_connect.rb', line 381

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



390
391
392
 
# File 'lib/oci/core/models/cross_connect.rb', line 390

def hash
  [compartment_id, cross_connect_group_id, defined_tags, display_name, freeform_tags, id, lifecycle_state, location_name, port_name, port_speed_shape_name, customer_reference_name, time_created, macsec_properties, oci_physical_device_name, oci_logical_device_name, is_interface_hold_timer_enabled, interface_down_timer_value_in_milliseconds, is_qos_enabled, interface_name].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



434
435
436
437
438
439
440
441
442
443
 
# File 'lib/oci/core/models/cross_connect.rb', line 434

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



428
429
430
 
# File 'lib/oci/core/models/cross_connect.rb', line 428

def to_s
  to_hash.to_s
end