class OCI::Core::Models::FastConnectProviderServiceKey

A provider service key and its details. A provider service key is an identifier for a provider's virtual circuit.

Attributes

bandwidth_shape_name[RW]

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 list_fast_connect_provider_virtual_circuit_bandwidth_shapes}.

Example: `10 Gbps`

@return [String]

name[RW]

[Required] The service key that the provider gives you when you set up a virtual circuit connection from the provider to Oracle Cloud Infrastructure. Use this value as the `providerServiceKeyName` query parameter for {#get_fast_connect_provider_service_key get_fast_connect_provider_service_key}.

@return [String]

peering_location[RW]

The provider's peering location. @return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/core/models/fast_connect_provider_service_key.rb, line 34
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'bandwidth_shape_name': :'bandwidthShapeName',
    'peering_location': :'peeringLocation'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :name The value to assign to the {#name} property @option attributes [String] :bandwidth_shape_name The value to assign to the {#bandwidth_shape_name} property @option attributes [String] :peering_location The value to assign to the {#peering_location} property

# File lib/oci/core/models/fast_connect_provider_service_key.rb, line 64
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.name = attributes[:'name'] if attributes[:'name']

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

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

  self.peering_location = attributes[:'peering_location'] if attributes[:'peering_location']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/core/models/fast_connect_provider_service_key.rb, line 45
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'bandwidth_shape_name': :'String',
    'peering_location': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/core/models/fast_connect_provider_service_key.rb, line 92
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    name == other.name &&
    bandwidth_shape_name == other.bandwidth_shape_name &&
    peering_location == other.peering_location
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/core/models/fast_connect_provider_service_key.rb, line 124
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/core/models/fast_connect_provider_service_key.rb, line 104
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/core/models/fast_connect_provider_service_key.rb, line 113
def hash
  [name, bandwidth_shape_name, peering_location].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/core/models/fast_connect_provider_service_key.rb, line 157
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/core/models/fast_connect_provider_service_key.rb, line 151
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/core/models/fast_connect_provider_service_key.rb, line 174
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end