class OCI::Healthchecks::Models::Geolocation

Geographic information about a vantage point.

Attributes

admin_div_code[RW]

The ISO 3166-2 code for this location's first-level administrative division, either a US state or Canadian province. Only included for locations in the US or Canada. For a list of codes, see [Country Codes](www.iso.org/obp/ui/#search).

@return [String]

city_name[RW]

Common English-language name for the city.

@return [String]

country_code[RW]

The ISO 3166-1 alpha-2 country code. For a list of codes, see [Country Codes](www.iso.org/obp/ui/#search).

@return [String]

country_name[RW]

The common English-language name for the country.

@return [String]

geo_key[RW]

An opaque identifier for the geographic location of the vantage point. @return [String]

latitude[RW]

Degrees north of the Equator.

@return [Float]

longitude[RW]

Degrees east of the prime meridian.

@return [Float]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/healthchecks/models/geolocation.rb, line 49
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'geo_key': :'geoKey',
    'admin_div_code': :'adminDivCode',
    'city_name': :'cityName',
    'country_code': :'countryCode',
    'country_name': :'countryName',
    'latitude': :'latitude',
    'longitude': :'longitude'
    # 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] :geo_key The value to assign to the {#geo_key} property @option attributes [String] :admin_div_code The value to assign to the {#admin_div_code} property @option attributes [String] :city_name The value to assign to the {#city_name} property @option attributes [String] :country_code The value to assign to the {#country_code} property @option attributes [String] :country_name The value to assign to the {#country_name} property @option attributes [Float] :latitude The value to assign to the {#latitude} property @option attributes [Float] :longitude The value to assign to the {#longitude} property

# File lib/oci/healthchecks/models/geolocation.rb, line 91
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.geo_key = attributes[:'geoKey'] if attributes[:'geoKey']

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

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

  self.admin_div_code = attributes[:'adminDivCode'] if attributes[:'adminDivCode']

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

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

  self.city_name = attributes[:'cityName'] if attributes[:'cityName']

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

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

  self.country_code = attributes[:'countryCode'] if attributes[:'countryCode']

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

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

  self.country_name = attributes[:'countryName'] if attributes[:'countryName']

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

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

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

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

Attribute type mapping.

# File lib/oci/healthchecks/models/geolocation.rb, line 64
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'geo_key': :'String',
    'admin_div_code': :'String',
    'city_name': :'String',
    'country_code': :'String',
    'country_name': :'String',
    'latitude': :'Float',
    'longitude': :'Float'
    # 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/geolocation.rb, line 139
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    geo_key == other.geo_key &&
    admin_div_code == other.admin_div_code &&
    city_name == other.city_name &&
    country_code == other.country_code &&
    country_name == other.country_name &&
    latitude == other.latitude &&
    longitude == other.longitude
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/geolocation.rb, line 175
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/geolocation.rb, line 155
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/geolocation.rb, line 164
def hash
  [geo_key, admin_div_code, city_name, country_code, country_name, latitude, longitude].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/geolocation.rb, line 208
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/geolocation.rb, line 202
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/geolocation.rb, line 225
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