class OCI::Healthchecks::Models::HealthChecksVantagePointSummary

Information about a vantage point.

Attributes

display_name[RW]

The display name for the vantage point. Display names are determined by the best information available and may change over time.

@return [String]

geo[RW]

@return [OCI::Healthchecks::Models::Geolocation]

name[RW]

The unique, permanent name for the vantage point. @return [String]

provider_name[RW]

The organization on whose infrastructure this vantage point resides. Provider names are not unique, as Oracle Cloud Infrastructure maintains many vantage points in each major provider.

@return [String]

routing[RW]

An array of objects that describe how traffic to this vantage point is routed, including which prefixes and ASNs connect it to the internet.

The addresses are sorted from the most-specific to least-specific prefix (the smallest network to largest network). When a prefix has multiple origin ASNs (MOAS routing), they are sorted by weight (highest to lowest). Weight is determined by the total percentage of peers observing the prefix originating from an ASN. Only present if `fields` includes `routing`. The field will be null if the address's routing information is unknown.

@return [Array<OCI::Healthchecks::Models::Routing>]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/healthchecks/models/health_checks_vantage_point_summary.rb, line 45
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'provider_name': :'providerName',
    'name': :'name',
    'geo': :'geo',
    'routing': :'routing'
    # 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] :display_name The value to assign to the {#display_name} property @option attributes [String] :provider_name The value to assign to the {#provider_name} property @option attributes [String] :name The value to assign to the {#name} property @option attributes [OCI::Healthchecks::Models::Geolocation] :geo The value to assign to the {#geo} property @option attributes [Array<OCI::Healthchecks::Models::Routing>] :routing The value to assign to the {#routing} property

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

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

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

Attribute type mapping.

# File lib/oci/healthchecks/models/health_checks_vantage_point_summary.rb, line 58
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'provider_name': :'String',
    'name': :'String',
    'geo': :'OCI::Healthchecks::Models::Geolocation',
    'routing': :'Array<OCI::Healthchecks::Models::Routing>'
    # 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/healthchecks/models/health_checks_vantage_point_summary.rb, line 113
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    display_name == other.display_name &&
    provider_name == other.provider_name &&
    name == other.name &&
    geo == other.geo &&
    routing == other.routing
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/healthchecks/models/health_checks_vantage_point_summary.rb, line 147
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/healthchecks/models/health_checks_vantage_point_summary.rb, line 127
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/healthchecks/models/health_checks_vantage_point_summary.rb, line 136
def hash
  [display_name, provider_name, name, geo, routing].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/healthchecks/models/health_checks_vantage_point_summary.rb, line 180
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/healthchecks/models/health_checks_vantage_point_summary.rb, line 174
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/healthchecks/models/health_checks_vantage_point_summary.rb, line 197
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