Class: OCI::Core::Models::FastConnectProviderService

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

Overview

A service offering from a supported provider. For more information, see FastConnect Overview.

Constant Summary collapse

PRIVATE_PEERING_BGP_MANAGEMENT_ENUM =
[
  PRIVATE_PEERING_BGP_MANAGEMENT_CUSTOMER_MANAGED = 'CUSTOMER_MANAGED'.freeze,
  PRIVATE_PEERING_BGP_MANAGEMENT_PROVIDER_MANAGED = 'PROVIDER_MANAGED'.freeze,
  PRIVATE_PEERING_BGP_MANAGEMENT_ORACLE_MANAGED = 'ORACLE_MANAGED'.freeze,
  PRIVATE_PEERING_BGP_MANAGEMENT_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
PUBLIC_PEERING_BGP_MANAGEMENT_ENUM =
[
  PUBLIC_PEERING_BGP_MANAGEMENT_CUSTOMER_MANAGED = 'CUSTOMER_MANAGED'.freeze,
  PUBLIC_PEERING_BGP_MANAGEMENT_PROVIDER_MANAGED = 'PROVIDER_MANAGED'.freeze,
  PUBLIC_PEERING_BGP_MANAGEMENT_ORACLE_MANAGED = 'ORACLE_MANAGED'.freeze,
  PUBLIC_PEERING_BGP_MANAGEMENT_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SUPPORTED_VIRTUAL_CIRCUIT_TYPES_ENUM =
[
  SUPPORTED_VIRTUAL_CIRCUIT_TYPES_PUBLIC = 'PUBLIC'.freeze,
  SUPPORTED_VIRTUAL_CIRCUIT_TYPES_PRIVATE = 'PRIVATE'.freeze,
  SUPPORTED_VIRTUAL_CIRCUIT_TYPES_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
CUSTOMER_ASN_MANAGEMENT_ENUM =
[
  CUSTOMER_ASN_MANAGEMENT_CUSTOMER_MANAGED = 'CUSTOMER_MANAGED'.freeze,
  CUSTOMER_ASN_MANAGEMENT_PROVIDER_MANAGED = 'PROVIDER_MANAGED'.freeze,
  CUSTOMER_ASN_MANAGEMENT_ORACLE_MANAGED = 'ORACLE_MANAGED'.freeze,
  CUSTOMER_ASN_MANAGEMENT_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
PROVIDER_SERVICE_KEY_MANAGEMENT_ENUM =
[
  PROVIDER_SERVICE_KEY_MANAGEMENT_CUSTOMER_MANAGED = 'CUSTOMER_MANAGED'.freeze,
  PROVIDER_SERVICE_KEY_MANAGEMENT_PROVIDER_MANAGED = 'PROVIDER_MANAGED'.freeze,
  PROVIDER_SERVICE_KEY_MANAGEMENT_ORACLE_MANAGED = 'ORACLE_MANAGED'.freeze,
  PROVIDER_SERVICE_KEY_MANAGEMENT_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
BANDWITH_SHAPE_MANAGEMENT_ENUM =
[
  BANDWITH_SHAPE_MANAGEMENT_CUSTOMER_MANAGED = 'CUSTOMER_MANAGED'.freeze,
  BANDWITH_SHAPE_MANAGEMENT_PROVIDER_MANAGED = 'PROVIDER_MANAGED'.freeze,
  BANDWITH_SHAPE_MANAGEMENT_ORACLE_MANAGED = 'ORACLE_MANAGED'.freeze,
  BANDWITH_SHAPE_MANAGEMENT_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
TYPE_ENUM =
[
  TYPE_LAYER2 = 'LAYER2'.freeze,
  TYPE_LAYER3 = 'LAYER3'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FastConnectProviderService

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
# File 'lib/oci/core/models/fast_connect_provider_service.rb', line 184

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

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

  self.private_peering_bgp_management = attributes[:'privatePeeringBgpManagement'] if attributes[:'privatePeeringBgpManagement']

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

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

  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_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_peering_bgp_management = attributes[:'publicPeeringBgpManagement'] if attributes[:'publicPeeringBgpManagement']

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

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

  self.supported_virtual_circuit_types = attributes[:'supportedVirtualCircuitTypes'] if attributes[:'supportedVirtualCircuitTypes']

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

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

  self.customer_asn_management = attributes[:'customerAsnManagement'] if attributes[:'customerAsnManagement']

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

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

  self.provider_service_key_management = attributes[:'providerServiceKeyManagement'] if attributes[:'providerServiceKeyManagement']

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

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

  self.bandwith_shape_management = attributes[:'bandwithShapeManagement'] if attributes[:'bandwithShapeManagement']

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

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

  self.required_total_cross_connects = attributes[:'requiredTotalCrossConnects'] if attributes[:'requiredTotalCrossConnects']

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

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

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

Instance Attribute Details

#bandwith_shape_managementString

[Required] Who is responsible for managing the virtual circuit bandwidth.

Returns:

  • (String)


114
115
116
# File 'lib/oci/core/models/fast_connect_provider_service.rb', line 114

def bandwith_shape_management
  @bandwith_shape_management
end

#customer_asn_managementString

[Required] Who is responsible for managing the ASN information for the network at the other end of the connection from Oracle.

Returns:

  • (String)


104
105
106
# File 'lib/oci/core/models/fast_connect_provider_service.rb', line 104

def customer_asn_management
  @customer_asn_management
end

#descriptionString

The location of the provider's website or portal. This portal is where you can get information about the provider service, create a virtual circuit connection from the provider to Oracle Cloud Infrastructure, and retrieve your provider service key for that virtual circuit connection.

Example: https://example.com

Returns:

  • (String)


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

def description
  @description
end

#idString

[Required] The OCID of the service offered by the provider.

Returns:

  • (String)


73
74
75
# File 'lib/oci/core/models/fast_connect_provider_service.rb', line 73

def id
  @id
end

#private_peering_bgp_managementString

[Required] Who is responsible for managing the private peering BGP information.

Returns:

  • (String)


78
79
80
# File 'lib/oci/core/models/fast_connect_provider_service.rb', line 78

def private_peering_bgp_management
  @private_peering_bgp_management
end

#provider_nameString

[Required] The name of the provider.

Returns:

  • (String)


83
84
85
# File 'lib/oci/core/models/fast_connect_provider_service.rb', line 83

def provider_name
  @provider_name
end

#provider_service_key_managementString

[Required] Who is responsible for managing the provider service key.

Returns:

  • (String)


109
110
111
# File 'lib/oci/core/models/fast_connect_provider_service.rb', line 109

def provider_service_key_management
  @provider_service_key_management
end

#provider_service_nameString

[Required] The name of the service offered by the provider.

Returns:

  • (String)


88
89
90
# File 'lib/oci/core/models/fast_connect_provider_service.rb', line 88

def provider_service_name
  @provider_service_name
end

#public_peering_bgp_managementString

[Required] Who is responsible for managing the public peering BGP information.

Returns:

  • (String)


93
94
95
# File 'lib/oci/core/models/fast_connect_provider_service.rb', line 93

def public_peering_bgp_management
  @public_peering_bgp_management
end

#required_total_cross_connectsInteger

[Required] Total number of cross-connect or cross-connect groups required for the virtual circuit.

Returns:

  • (Integer)


119
120
121
# File 'lib/oci/core/models/fast_connect_provider_service.rb', line 119

def required_total_cross_connects
  @required_total_cross_connects
end

#supported_virtual_circuit_typesArray<String>

An array of virtual circuit types supported by this service.

Returns:

  • (Array<String>)


98
99
100
# File 'lib/oci/core/models/fast_connect_provider_service.rb', line 98

def supported_virtual_circuit_types
  @supported_virtual_circuit_types
end

#typeString

[Required] Provider service type.

Returns:

  • (String)


124
125
126
# File 'lib/oci/core/models/fast_connect_provider_service.rb', line 124

def type
  @type
end

Class Method Details

.attribute_mapObject

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



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
# File 'lib/oci/core/models/fast_connect_provider_service.rb', line 127

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'description': :'description',
    'id': :'id',
    'private_peering_bgp_management': :'privatePeeringBgpManagement',
    'provider_name': :'providerName',
    'provider_service_name': :'providerServiceName',
    'public_peering_bgp_management': :'publicPeeringBgpManagement',
    'supported_virtual_circuit_types': :'supportedVirtualCircuitTypes',
    'customer_asn_management': :'customerAsnManagement',
    'provider_service_key_management': :'providerServiceKeyManagement',
    'bandwith_shape_management': :'bandwithShapeManagement',
    'required_total_cross_connects': :'requiredTotalCrossConnects',
    'type': :'type'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# File 'lib/oci/core/models/fast_connect_provider_service.rb', line 147

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'description': :'String',
    'id': :'String',
    'private_peering_bgp_management': :'String',
    'provider_name': :'String',
    'provider_service_name': :'String',
    'public_peering_bgp_management': :'String',
    'supported_virtual_circuit_types': :'Array<String>',
    'customer_asn_management': :'String',
    'provider_service_key_management': :'String',
    'bandwith_shape_management': :'String',
    'required_total_cross_connects': :'Integer',
    '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



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
# File 'lib/oci/core/models/fast_connect_provider_service.rb', line 356

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

  self.class == other.class &&
    description == other.description &&
    id == other.id &&
    private_peering_bgp_management == other.private_peering_bgp_management &&
    provider_name == other.provider_name &&
    provider_service_name == other.provider_service_name &&
    public_peering_bgp_management == other.public_peering_bgp_management &&
    supported_virtual_circuit_types == other.supported_virtual_circuit_types &&
    customer_asn_management == other.customer_asn_management &&
    provider_service_key_management == other.provider_service_key_management &&
    bandwith_shape_management == other.bandwith_shape_management &&
    required_total_cross_connects == other.required_total_cross_connects &&
    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



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
# File 'lib/oci/core/models/fast_connect_provider_service.rb', line 397

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


377
378
379
# File 'lib/oci/core/models/fast_connect_provider_service.rb', line 377

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



386
387
388
# File 'lib/oci/core/models/fast_connect_provider_service.rb', line 386

def hash
  [description, id, private_peering_bgp_management, provider_name, provider_service_name, public_peering_bgp_management, supported_virtual_circuit_types, customer_asn_management, provider_service_key_management, bandwith_shape_management, required_total_cross_connects, type].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



430
431
432
433
434
435
436
437
438
439
# File 'lib/oci/core/models/fast_connect_provider_service.rb', line 430

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



424
425
426
# File 'lib/oci/core/models/fast_connect_provider_service.rb', line 424

def to_s
  to_hash.to_s
end