Class: OCI::Core::Models::FastConnectProviderServiceKey

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

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FastConnectProviderServiceKey

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String)

    The value to assign to the #name property

  • :bandwidth_shape_name (String)

    The value to assign to the #bandwidth_shape_name property

  • :peering_location (String)

    The value to assign to the #peering_location property



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
# 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

Instance Attribute Details

#bandwidth_shape_nameString

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)


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

def bandwidth_shape_name
  @bandwidth_shape_name
end

#nameString

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

Returns:

  • (String)


18
19
20
# File 'lib/oci/core/models/fast_connect_provider_service_key.rb', line 18

def name
  @name
end

#peering_locationString

The provider's peering location.

Returns:

  • (String)


31
32
33
# File 'lib/oci/core/models/fast_connect_provider_service_key.rb', line 31

def peering_location
  @peering_location
end

Class Method Details

.attribute_mapObject

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



34
35
36
37
38
39
40
41
42
# 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

.swagger_typesObject

Attribute type mapping.



45
46
47
48
49
50
51
52
53
# 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

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object)

    the other object to be compared



92
93
94
95
96
97
98
99
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
# 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) ⇒ Boolean

Parameters:

  • other (Object)

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


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

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



113
114
115
# File 'lib/oci/core/models/fast_connect_provider_service_key.rb', line 113

def hash
  [name, bandwidth_shape_name, peering_location].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



157
158
159
160
161
162
163
164
165
166
# 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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



151
152
153
# File 'lib/oci/core/models/fast_connect_provider_service_key.rb', line 151

def to_s
  to_hash.to_s
end