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



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
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 107

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

Instance Attribute Details

#compartment_id ⇒ String

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

Returns:

  • (String) 


11
12
13
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 11

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) 


15
16
17
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 15

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) 


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

def customer_reference_name
  @customer_reference_name
end

#display_name ⇒ String

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

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 21

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) 


29
30
31
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 29

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


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

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


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

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


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

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.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 62

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'cross_connect_group_id': :'crossConnectGroupId',
    'display_name': :'displayName',
    'far_cross_connect_or_cross_connect_group_id': :'farCrossConnectOrCrossConnectGroupId',
    'location_name': :'locationName',
    'near_cross_connect_or_cross_connect_group_id': :'nearCrossConnectOrCrossConnectGroupId',
    'port_speed_shape_name': :'portSpeedShapeName',
    'customer_reference_name': :'customerReferenceName'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 78

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'cross_connect_group_id': :'String',
    'display_name': :'String',
    'far_cross_connect_or_cross_connect_group_id': :'String',
    'location_name': :'String',
    'near_cross_connect_or_cross_connect_group_id': :'String',
    'port_speed_shape_name': :'String',
    'customer_reference_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



169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 169

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 &&
    display_name == other.display_name &&
    far_cross_connect_or_cross_connect_group_id == other.far_cross_connect_or_cross_connect_group_id &&
    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
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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 206

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


186
187
188
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 186

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



195
196
197
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 195

def hash
  [compartment_id, cross_connect_group_id, display_name, far_cross_connect_or_cross_connect_group_id, location_name, near_cross_connect_or_cross_connect_group_id, port_speed_shape_name, customer_reference_name].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



239
240
241
242
243
244
245
246
247
248
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 239

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



233
234
235
 
# File 'lib/oci/core/models/create_cross_connect_details.rb', line 233

def to_s
  to_hash.to_s
end