Class: OCI::Core::Models::CreateVirtualCircuitDetails

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

Overview

CreateVirtualCircuitDetails model.

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_PUBLIC = 'PUBLIC'.freeze,
  TYPE_PRIVATE = 'PRIVATE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateVirtualCircuitDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/oci/core/models/create_virtual_circuit_details.rb', line 159

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

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

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

  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_mappings = attributes[:'crossConnectMappings'] if attributes[:'crossConnectMappings']

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

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

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

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

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

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

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

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

  self.provider_name = attributes[:'providerName'] if attributes[:'providerName']

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

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

  self.provider_service_id = attributes[:'providerServiceId'] if attributes[:'providerServiceId']

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

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

  self.provider_service_key_name = attributes[:'providerServiceKeyName'] if attributes[:'providerServiceKeyName']

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

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

  self.provider_service_name = attributes[:'providerServiceName'] if attributes[:'providerServiceName']

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

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

  self.public_prefixes = attributes[:'publicPrefixes'] if attributes[:'publicPrefixes']

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

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

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

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

Example: ‘10 Gbps`

Returns:

  • (String) 


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

def bandwidth_shape_name
  @bandwidth_shape_name
end

#compartment_id ⇒ String

[Required] The OCID of the compartment to contain the virtual circuit.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/core/models/create_virtual_circuit_details.rb', line 26

def compartment_id
  @compartment_id
end

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

Create a ‘CrossConnectMapping` for each cross-connect or cross-connect group this virtual circuit will run on.

Returns:



32
33
34
 
# File 'lib/oci/core/models/create_virtual_circuit_details.rb', line 32

def cross_connect_mappings
  @cross_connect_mappings
end

#customer_bgp_asn ⇒ Integer

Your BGP ASN (either public or private). Provide this value only if there’s a BGP session that goes from your edge router to Oracle. Otherwise, leave this empty or null.

Returns:

  • (Integer) 


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

def customer_bgp_asn
  @customer_bgp_asn
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

def display_name
  @display_name
end

#gateway_id ⇒ String

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

Returns:

  • (String) 


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

def gateway_id
  @gateway_id
end

#provider_name ⇒ String

Deprecated. Instead use ‘providerServiceId`. To get a list of the provider names, see list_fast_connect_provider_services.

Returns:

  • (String) 


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

def provider_name
  @provider_name
end

#provider_service_id ⇒ String

The OCID of the service offered by the provider (if you’re connecting via a provider). To get a list of the available service offerings, see list_fast_connect_provider_services.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/core/models/create_virtual_circuit_details.rb', line 64

def provider_service_id
  @provider_service_id
end

#provider_service_key_name ⇒ String

The service key name offered by the provider (if the customer is connecting via a provider).

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/core/models/create_virtual_circuit_details.rb', line 69

def provider_service_key_name
  @provider_service_key_name
end

#provider_service_name ⇒ String

Deprecated. Instead use ‘providerServiceId`. To get a list of the provider names, see list_fast_connect_provider_services.

Returns:

  • (String) 


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

def provider_service_name
  @provider_service_name
end

#public_prefixes ⇒ Array<OCI::Core::Models::CreateVirtualCircuitPublicPrefixDetails>

For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to advertise across the connection.

Returns:



82
83
84
 
# File 'lib/oci/core/models/create_virtual_circuit_details.rb', line 82

def public_prefixes
  @public_prefixes
end

#region ⇒ String

The Oracle Cloud Infrastructure region where this virtual circuit is located. Example: ‘phx`

Returns:

  • (String) 


89
90
91
 
# File 'lib/oci/core/models/create_virtual_circuit_details.rb', line 89

def region
  @region
end

#type ⇒ String

[Required] The type of IP addresses used in this virtual circuit. PRIVATE means [RFC 1918](tools.ietf.org/html/rfc1918) addresses (10.0.0.0/8, 172.16/12, and 192.168/16). Only PRIVATE is supported.

Returns:

  • (String) 


96
97
98
 
# File 'lib/oci/core/models/create_virtual_circuit_details.rb', line 96

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/core/models/create_virtual_circuit_details.rb', line 99

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'bandwidth_shape_name': :'bandwidthShapeName',
    'compartment_id': :'compartmentId',
    'cross_connect_mappings': :'crossConnectMappings',
    'customer_bgp_asn': :'customerBgpAsn',
    'display_name': :'displayName',
    'gateway_id': :'gatewayId',
    'provider_name': :'providerName',
    'provider_service_id': :'providerServiceId',
    'provider_service_key_name': :'providerServiceKeyName',
    'provider_service_name': :'providerServiceName',
    'public_prefixes': :'publicPrefixes',
    'region': :'region',
    'type': :'type'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/oci/core/models/create_virtual_circuit_details.rb', line 120

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'bandwidth_shape_name': :'String',
    'compartment_id': :'String',
    'cross_connect_mappings': :'Array<OCI::Core::Models::CrossConnectMapping>',
    'customer_bgp_asn': :'Integer',
    'display_name': :'String',
    'gateway_id': :'String',
    'provider_name': :'String',
    'provider_service_id': :'String',
    'provider_service_key_name': :'String',
    'provider_service_name': :'String',
    'public_prefixes': :'Array<OCI::Core::Models::CreateVirtualCircuitPublicPrefixDetails>',
    'region': :'String',
    'type': :'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



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/oci/core/models/create_virtual_circuit_details.rb', line 251

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

  self.class == other.class &&
    bandwidth_shape_name == other.bandwidth_shape_name &&
    compartment_id == other.compartment_id &&
    cross_connect_mappings == other.cross_connect_mappings &&
    customer_bgp_asn == other.customer_bgp_asn &&
    display_name == other.display_name &&
    gateway_id == other.gateway_id &&
    provider_name == other.provider_name &&
    provider_service_id == other.provider_service_id &&
    provider_service_key_name == other.provider_service_key_name &&
    provider_service_name == other.provider_service_name &&
    public_prefixes == other.public_prefixes &&
    region == other.region &&
    type == other.type
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



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/oci/core/models/create_virtual_circuit_details.rb', line 293

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


273
274
275
 
# File 'lib/oci/core/models/create_virtual_circuit_details.rb', line 273

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



282
283
284
 
# File 'lib/oci/core/models/create_virtual_circuit_details.rb', line 282

def hash
  [bandwidth_shape_name, compartment_id, cross_connect_mappings, customer_bgp_asn, display_name, gateway_id, provider_name, provider_service_id, provider_service_key_name, provider_service_name, public_prefixes, region, type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



326
327
328
329
330
331
332
333
334
335
 
# File 'lib/oci/core/models/create_virtual_circuit_details.rb', line 326

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



320
321
322
 
# File 'lib/oci/core/models/create_virtual_circuit_details.rb', line 320

def to_s
  to_hash.to_s
end