Class: OCI::Core::Models::CreateCrossConnectDetails

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

Overview

CreateCrossConnectDetails model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateCrossConnectDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
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
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 178

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

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

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

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

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

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

  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.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.is_interface_hold_timer_enabled = attributes[:'isInterfaceHoldTimerEnabled'] unless attributes[:'isInterfaceHoldTimerEnabled'].nil?
  self.is_interface_hold_timer_enabled = false if is_interface_hold_timer_enabled.nil? && !attributes.key?(:'isInterfaceHoldTimerEnabled') # rubocop:disable Style/StringLiterals

  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.is_interface_hold_timer_enabled = false if is_interface_hold_timer_enabled.nil? && !attributes.key?(:'isInterfaceHoldTimerEnabled') && !attributes.key?(:'is_interface_hold_timer_enabled') # rubocop:disable Style/StringLiterals

  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?
  self.is_qos_enabled = false if is_qos_enabled.nil? && !attributes.key?(:'isQosEnabled') # rubocop:disable Style/StringLiterals

  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.is_qos_enabled = false if is_qos_enabled.nil? && !attributes.key?(:'isQosEnabled') && !attributes.key?(:'is_qos_enabled') # rubocop:disable Style/StringLiterals

  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.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

[Required] The OCID of the compartment to contain the cross-connect.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 13

def compartment_id
  @compartment_id
end

#cross_connect_group_id ⇒ String

The OCID of the cross-connect group to put this cross-connect in.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 18

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) 


78
79
80
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 78

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>>) 


26
27
28
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 26

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) 


32
33
34
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 32

def display_name
  @display_name
end

#far_cross_connect_or_cross_connect_group_id ⇒ String

If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on a different router (for the purposes of redundancy), provide the OCID of that existing cross-connect or cross-connect group.

Returns:

  • (String) 


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

def far_cross_connect_or_cross_connect_group_id
  @far_cross_connect_or_cross_connect_group_id
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>) 


48
49
50
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 48

def freeform_tags
  @freeform_tags
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) 


89
90
91
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 89

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) 


106
107
108
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 106

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) 


85
86
87
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 85

def is_interface_hold_timer_enabled
  @is_interface_hold_timer_enabled
end

#is_qos_enabled ⇒ BOOLEAN

When true, restricts placement so cross-connects lands only on QoS-capable devices. When false (default), placement may use any supported device. If no QoS-capable devices are available in the selected location, the request fails.

Returns:

  • (BOOLEAN) 


96
97
98
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 96

def is_qos_enabled
  @is_qos_enabled
end

#location_name ⇒ String

[Required] The name of the FastConnect location where this cross-connect will be installed. To get a list of the available locations, see list_cross_connect_locations.

Example: CyrusOne, Chandler, AZ

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 57

def location_name
  @location_name
end

#macsec_properties ⇒ OCI::Core::Models::CreateMacsecProperties

Returns:



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

def macsec_properties
  @macsec_properties
end

#near_cross_connect_or_cross_connect_group_id ⇒ String

If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on the same router, provide the OCID of that existing cross-connect or cross-connect group.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 64

def near_cross_connect_or_cross_connect_group_id
  @near_cross_connect_or_cross_connect_group_id
end

#oci_physical_device_name ⇒ String

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

Returns:

  • (String) 


101
102
103
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 101

def oci_physical_device_name
  @oci_physical_device_name
end

#port_speed_shape_name ⇒ String

[Required] The port speed for this cross-connect. To get a list of the available port speeds, see list_crossconnect_port_speed_shapes.

Example: 10 Gbps

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 72

def port_speed_shape_name
  @port_speed_shape_name
end

Class Method Details

.attribute_map ⇒ Object

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



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 109

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'cross_connect_group_id': :'crossConnectGroupId',
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'far_cross_connect_or_cross_connect_group_id': :'farCrossConnectOrCrossConnectGroupId',
    'freeform_tags': :'freeformTags',
    'location_name': :'locationName',
    'near_cross_connect_or_cross_connect_group_id': :'nearCrossConnectOrCrossConnectGroupId',
    'port_speed_shape_name': :'portSpeedShapeName',
    'customer_reference_name': :'customerReferenceName',
    'macsec_properties': :'macsecProperties',
    'is_interface_hold_timer_enabled': :'isInterfaceHoldTimerEnabled',
    'interface_down_timer_value_in_milliseconds': :'interfaceDownTimerValueInMilliseconds',
    'is_qos_enabled': :'isQosEnabled',
    'oci_physical_device_name': :'ociPhysicalDeviceName',
    'interface_name': :'interfaceName'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 133

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',
    'far_cross_connect_or_cross_connect_group_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'location_name': :'String',
    'near_cross_connect_or_cross_connect_group_id': :'String',
    'port_speed_shape_name': :'String',
    'customer_reference_name': :'String',
    'macsec_properties': :'OCI::Core::Models::CreateMacsecProperties',
    'is_interface_hold_timer_enabled': :'BOOLEAN',
    'interface_down_timer_value_in_milliseconds': :'Integer',
    'is_qos_enabled': :'BOOLEAN',
    'oci_physical_device_name': :'String',
    '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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 292

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 &&
    far_cross_connect_or_cross_connect_group_id == other.far_cross_connect_or_cross_connect_group_id &&
    freeform_tags == other.freeform_tags &&
    location_name == other.location_name &&
    near_cross_connect_or_cross_connect_group_id == other.near_cross_connect_or_cross_connect_group_id &&
    port_speed_shape_name == other.port_speed_shape_name &&
    customer_reference_name == other.customer_reference_name &&
    macsec_properties == other.macsec_properties &&
    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 &&
    oci_physical_device_name == other.oci_physical_device_name &&
    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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 337

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


317
318
319
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 317

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



326
327
328
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 326

def hash
  [compartment_id, cross_connect_group_id, defined_tags, display_name, far_cross_connect_or_cross_connect_group_id, freeform_tags, location_name, near_cross_connect_or_cross_connect_group_id, port_speed_shape_name, customer_reference_name, macsec_properties, is_interface_hold_timer_enabled, interface_down_timer_value_in_milliseconds, is_qos_enabled, oci_physical_device_name, 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



370
371
372
373
374
375
376
377
378
379
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 370

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



364
365
366
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 364

def to_s
  to_hash.to_s
end