Class: OCI::Core::Models::CreateCrossConnectGroupDetails

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

Overview

CreateCrossConnectGroupDetails model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateCrossConnectGroupDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/oci/core/models/create_cross_connect_group_details.rb', line 121

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

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

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

  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
end

Instance Attribute Details

#compartment_id ⇒ String

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

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#customer_reference_name ⇒ String

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

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/core/models/create_cross_connect_group_details.rb', line 33

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


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

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) 


27
28
29
 
# File 'lib/oci/core/models/create_cross_connect_group_details.rb', line 27

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


41
42
43
 
# File 'lib/oci/core/models/create_cross_connect_group_details.rb', line 41

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) 


60
61
62
 
# File 'lib/oci/core/models/create_cross_connect_group_details.rb', line 60

def interface_down_timer_value_in_milliseconds
  @interface_down_timer_value_in_milliseconds
end

#is_interface_hold_timer_enabled ⇒ BOOLEAN

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

Returns:

  • (BOOLEAN) 


56
57
58
 
# File 'lib/oci/core/models/create_cross_connect_group_details.rb', line 56

def is_interface_hold_timer_enabled
  @is_interface_hold_timer_enabled
end

#is_qos_enabled ⇒ BOOLEAN

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


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

def is_qos_enabled
  @is_qos_enabled
end

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

Returns:



44
45
46
 
# File 'lib/oci/core/models/create_cross_connect_group_details.rb', line 44

def macsec_properties
  @macsec_properties
end

#minimum_links ⇒ Integer

(Optional) Minimum number of active cross-connects required for the cross-connect group to be considered operational. During create cross-connect-group operation this value can only be set to 1 (If not specified, this value defaults to 1) and can be edited using the update cross-connect group operation. Value must not exceed the total number of cross-connects in the cross-connect group.

Returns:

  • (Integer) 


52
53
54
 
# File 'lib/oci/core/models/create_cross_connect_group_details.rb', line 52

def minimum_links
  @minimum_links
end

Class Method Details

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/oci/core/models/create_cross_connect_group_details.rb', line 70

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'customer_reference_name': :'customerReferenceName',
    'freeform_tags': :'freeformTags',
    'macsec_properties': :'macsecProperties',
    'minimum_links': :'minimumLinks',
    'is_interface_hold_timer_enabled': :'isInterfaceHoldTimerEnabled',
    'interface_down_timer_value_in_milliseconds': :'interfaceDownTimerValueInMilliseconds',
    'is_qos_enabled': :'isQosEnabled'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/oci/core/models/create_cross_connect_group_details.rb', line 88

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'customer_reference_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'macsec_properties': :'OCI::Core::Models::CreateMacsecProperties',
    'minimum_links': :'Integer',
    'is_interface_hold_timer_enabled': :'BOOLEAN',
    'interface_down_timer_value_in_milliseconds': :'Integer',
    'is_qos_enabled': :'BOOLEAN'
    # 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



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/oci/core/models/create_cross_connect_group_details.rb', line 199

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    customer_reference_name == other.customer_reference_name &&
    freeform_tags == other.freeform_tags &&
    macsec_properties == other.macsec_properties &&
    minimum_links == other.minimum_links &&
    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
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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/oci/core/models/create_cross_connect_group_details.rb', line 238

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


218
219
220
 
# File 'lib/oci/core/models/create_cross_connect_group_details.rb', line 218

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



227
228
229
 
# File 'lib/oci/core/models/create_cross_connect_group_details.rb', line 227

def hash
  [compartment_id, defined_tags, display_name, customer_reference_name, freeform_tags, macsec_properties, minimum_links, is_interface_hold_timer_enabled, interface_down_timer_value_in_milliseconds, is_qos_enabled].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



271
272
273
274
275
276
277
278
279
280
 
# File 'lib/oci/core/models/create_cross_connect_group_details.rb', line 271

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



265
266
267
 
# File 'lib/oci/core/models/create_cross_connect_group_details.rb', line 265

def to_s
  to_hash.to_s
end