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](docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm).

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](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[LIFECYCLE_STATE_PENDING_CUSTOMER = 'PENDING_CUSTOMER',
LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING',
LIFECYCLE_STATE_PROVISIONED = 'PROVISIONED',
LIFECYCLE_STATE_INACTIVE = 'INACTIVE',
LIFECYCLE_STATE_TERMINATING = 'TERMINATING',
LIFECYCLE_STATE_TERMINATED = 'TERMINATED',
LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']

Instance Attribute 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):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :cross_connect_group_id (String) —

    The value to assign to the #cross_connect_group_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :id (String) —

    The value to assign to the #id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :location_name (String) —

    The value to assign to the #location_name property

  • :port_name (String) —

    The value to assign to the #port_name property

  • :port_speed_shape_name (String) —

    The value to assign to the #port_speed_shape_name property

  • :time_created (DateTime) —

    The value to assign to the #time_created property



89
90
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/oci/core/models/cross_connect.rb', line 89

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end

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

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

end

Instance Attribute Details

#compartment_id ⇒ String

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

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/core/models/cross_connect.rb', line 35

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) 


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

def cross_connect_group_id
  @cross_connect_group_id
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

def display_name
  @display_name
end

#id ⇒ String

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

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/core/models/cross_connect.rb', line 49

def id
  @id
end

#lifecycle_state ⇒ String

The cross-connect’s current state.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#location_name ⇒ String

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

Returns:

  • (String) 


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

def location_name
  @location_name
end

#port_name ⇒ String

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

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/core/models/cross_connect.rb', line 61

def port_name
  @port_name
end

#port_speed_shape_name ⇒ String

The port speed for this cross-connect.

Example: ‘10 Gbps`

Returns:

  • (String) 


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

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) 


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

def time_created
  @time_created
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/oci/core/models/cross_connect.rb', line 193

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      compartment_id == other_object.compartment_id &&
      cross_connect_group_id == other_object.cross_connect_group_id &&
      display_name == other_object.display_name &&
      id == other_object.id &&
      lifecycle_state == other_object.lifecycle_state &&
      location_name == other_object.location_name &&
      port_name == other_object.port_name &&
      port_speed_shape_name == other_object.port_speed_shape_name &&
      time_created == other_object.time_created
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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/oci/core/models/cross_connect.rb', line 222

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


209
210
211
 
# File 'lib/oci/core/models/cross_connect.rb', line 209

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



215
216
217
 
# File 'lib/oci/core/models/cross_connect.rb', line 215

def hash
  [compartment_id, cross_connect_group_id, display_name, id, lifecycle_state, location_name, port_name, port_speed_shape_name, time_created].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



247
248
249
250
251
252
253
254
255
 
# File 'lib/oci/core/models/cross_connect.rb', line 247

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



241
242
243
 
# File 'lib/oci/core/models/cross_connect.rb', line 241

def to_s
  to_hash.to_s
end