Class: OCI::Healthchecks::Models::Geolocation

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/healthchecks/models/geolocation.rb

Overview

Geographic information about a vantage point.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Geolocation

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :geo_key (String) —

    The value to assign to the #geo_key property

  • :admin_div_code (String) —

    The value to assign to the #admin_div_code property

  • :city_name (String) —

    The value to assign to the #city_name property

  • :country_code (String) —

    The value to assign to the #country_code property

  • :country_name (String) —

    The value to assign to the #country_name property

  • :latitude (Float) —

    The value to assign to the #latitude property

  • :longitude (Float) —

    The value to assign to the #longitude property



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/oci/healthchecks/models/geolocation.rb', line 90

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

Instance Attribute Details

#admin_div_code ⇒ String

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

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/healthchecks/models/geolocation.rb', line 19

def admin_div_code
  @admin_div_code
end

#city_name ⇒ String

Common English-language name for the city.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/healthchecks/models/geolocation.rb', line 24

def city_name
  @city_name
end

#country_code ⇒ String

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

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/healthchecks/models/geolocation.rb', line 30

def country_code
  @country_code
end

#country_name ⇒ String

The common English-language name for the country.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/healthchecks/models/geolocation.rb', line 35

def country_name
  @country_name
end

#geo_key ⇒ String

An opaque identifier for the geographic location of the vantage point.

Returns:

  • (String) 


11
12
13
 
# File 'lib/oci/healthchecks/models/geolocation.rb', line 11

def geo_key
  @geo_key
end

#latitude ⇒ Float

Degrees north of the Equator.

Returns:

  • (Float) 


40
41
42
 
# File 'lib/oci/healthchecks/models/geolocation.rb', line 40

def latitude
  @latitude
end

#longitude ⇒ Float

Degrees east of the prime meridian.

Returns:

  • (Float) 


45
46
47
 
# File 'lib/oci/healthchecks/models/geolocation.rb', line 45

def longitude
  @longitude
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/oci/healthchecks/models/geolocation.rb', line 48

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

.swagger_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/oci/healthchecks/models/geolocation.rb', line 63

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

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/oci/healthchecks/models/geolocation.rb', line 138

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/oci/healthchecks/models/geolocation.rb', line 174

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


154
155
156
 
# File 'lib/oci/healthchecks/models/geolocation.rb', line 154

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



163
164
165
 
# File 'lib/oci/healthchecks/models/geolocation.rb', line 163

def hash
  [geo_key, admin_div_code, city_name, country_code, country_name, latitude, longitude].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



207
208
209
210
211
212
213
214
215
216
 
# File 'lib/oci/healthchecks/models/geolocation.rb', line 207

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



201
202
203
 
# File 'lib/oci/healthchecks/models/geolocation.rb', line 201

def to_s
  to_hash.to_s
end