Class: OCI::Core::Models::UpdateVirtualCircuitDetails

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

Constant Summary collapse

PROVIDER_STATE_ENUM = 
[PROVIDER_STATE_ACTIVE = 'ACTIVE',
PROVIDER_STATE_INACTIVE = 'INACTIVE']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateVirtualCircuitDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

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

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

  if attributes[:'crossConnectMappings']
    self.cross_connect_mappings = attributes[:'crossConnectMappings']
  end

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

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

  if attributes[:'customerBgpAsn']
    self.customer_bgp_asn = attributes[:'customerBgpAsn']
  end

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

  if attributes[:'customer_bgp_asn']
    self.customer_bgp_asn = attributes[:'customer_bgp_asn']
  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[:'gatewayId']
    self.gateway_id = attributes[:'gatewayId']
  end

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

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

  if attributes[:'providerState']
    self.provider_state = attributes[:'providerState']
  end

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

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

  if attributes[:'referenceComment']
    self.reference_comment = attributes[:'referenceComment']
  end

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

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

end

Instance Attribute Details

#bandwidth_shape_name ⇒ String

The provisioned data rate of the connection. To get a list of the available bandwidth levels (that is, shapes), see list_fast_connect_provider_virtual_circuit_bandwidth_shapes. To be updated only by the customer who owns the virtual circuit.

Returns:

  • (String) 


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

def bandwidth_shape_name
  @bandwidth_shape_name
end

#cross_connect_mappings ⇒ Array<OCI::Core::Models::CrossConnectMapping>

An array of mappings, each containing properties for a cross-connect or cross-connect group associated with this virtual circuit.

The customer and provider can update different properties in the mapping depending on the situation. See the description of the CrossConnectMapping.

Returns:



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

def cross_connect_mappings
  @cross_connect_mappings
end

#customer_bgp_asn ⇒ Integer

The BGP ASN of the network at the other end of the BGP session from Oracle.

If the BGP session is from the customer’s edge router to Oracle, the required value is the customer’s ASN, and it can be updated only by the customer.

If the BGP session is from the provider’s edge router to Oracle, the required value is the provider’s ASN, and it can be updated only by the provider.

Returns:

  • (Integer) 


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

def customer_bgp_asn
  @customer_bgp_asn
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique. Avoid entering confidential information.

To be updated only by the customer who owns the virtual circuit.

Returns:

  • (String) 


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

def display_name
  @display_name
end

#gateway_id ⇒ String

The OCID of the Drg that this private virtual circuit uses.

To be updated only by the customer who owns the virtual circuit.

Returns:

  • (String) 


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

def gateway_id
  @gateway_id
end

#provider_state ⇒ String

The provider’s state in relation to this virtual circuit. Relevant only if the customer is using FastConnect via a provider. ACTIVE means the provider has provisioned the virtual circuit from their end. INACTIVE means the provider has not yet provisioned the virtual circuit, or has de-provisioned it.

To be updated only by the provider.

Returns:

  • (String) 


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

def provider_state
  @provider_state
end

#reference_comment ⇒ String

Provider-supplied reference information about this virtual circuit. Relevant only if the customer is using FastConnect via a provider.

To be updated only by the provider.

Returns:

  • (String) 


76
77
78
 
# File 'lib/oci/core/models/update_virtual_circuit_details.rb', line 76

def reference_comment
  @reference_comment
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/oci/core/models/update_virtual_circuit_details.rb', line 178

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      bandwidth_shape_name == other_object.bandwidth_shape_name &&
      cross_connect_mappings == other_object.cross_connect_mappings &&
      customer_bgp_asn == other_object.customer_bgp_asn &&
      display_name == other_object.display_name &&
      gateway_id == other_object.gateway_id &&
      provider_state == other_object.provider_state &&
      reference_comment == other_object.reference_comment
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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/oci/core/models/update_virtual_circuit_details.rb', line 205

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


192
193
194
 
# File 'lib/oci/core/models/update_virtual_circuit_details.rb', line 192

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



198
199
200
 
# File 'lib/oci/core/models/update_virtual_circuit_details.rb', line 198

def hash
  [bandwidth_shape_name, cross_connect_mappings, customer_bgp_asn, display_name, gateway_id, provider_state, reference_comment].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



230
231
232
233
234
235
236
237
238
 
# File 'lib/oci/core/models/update_virtual_circuit_details.rb', line 230

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



224
225
226
 
# File 'lib/oci/core/models/update_virtual_circuit_details.rb', line 224

def to_s
  to_hash.to_s
end