Class: OCI::Core::Models::UpdateCrossConnectGroupDetails

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

Overview

UpdateCrossConnectGroupDetails model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateCrossConnectGroupDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

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

Instance Attribute Details

#customer_reference_name ⇒ String

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

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/core/models/update_cross_connect_group_details.rb', line 28

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


17
18
19
 
# File 'lib/oci/core/models/update_cross_connect_group_details.rb', line 17

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) 


23
24
25
 
# File 'lib/oci/core/models/update_cross_connect_group_details.rb', line 23

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


36
37
38
 
# File 'lib/oci/core/models/update_cross_connect_group_details.rb', line 36

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) 


54
55
56
 
# File 'lib/oci/core/models/update_cross_connect_group_details.rb', line 54

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) 


50
51
52
 
# File 'lib/oci/core/models/update_cross_connect_group_details.rb', line 50

def is_interface_hold_timer_enabled
  @is_interface_hold_timer_enabled
end

#macsec_properties ⇒ OCI::Core::Models::UpdateMacsecProperties

Returns:



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

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. If not specified, this value defaults to 1. Value must not exceed the total number of cross-connects in the cross-connect group.

Returns:

  • (Integer) 


46
47
48
 
# File 'lib/oci/core/models/update_cross_connect_group_details.rb', line 46

def minimum_links
  @minimum_links
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/oci/core/models/update_cross_connect_group_details.rb', line 57

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    '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'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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



164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/oci/core/models/update_cross_connect_group_details.rb', line 164

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

  self.class == other.class &&
    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
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



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/oci/core/models/update_cross_connect_group_details.rb', line 201

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


181
182
183
 
# File 'lib/oci/core/models/update_cross_connect_group_details.rb', line 181

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



190
191
192
 
# File 'lib/oci/core/models/update_cross_connect_group_details.rb', line 190

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



234
235
236
237
238
239
240
241
242
243
 
# File 'lib/oci/core/models/update_cross_connect_group_details.rb', line 234

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



228
229
230
 
# File 'lib/oci/core/models/update_cross_connect_group_details.rb', line 228

def to_s
  to_hash.to_s
end