Class: OCI::ApmSynthetics::Models::GeoSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/apm_synthetics/models/geo_summary.rb

Overview

Geographic summary of a vantage point.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GeoSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/oci/apm_synthetics/models/geo_summary.rb', line 77

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

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/apm_synthetics/models/geo_summary.rb', line 15

def admin_div_code
  @admin_div_code
end

#city_name ⇒ String

Common English-language name for the city.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/apm_synthetics/models/geo_summary.rb', line 19

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.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/apm_synthetics/models/geo_summary.rb', line 23

def country_code
  @country_code
end

#country_name ⇒ String

The common English-language name for the country.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/apm_synthetics/models/geo_summary.rb', line 27

def country_name
  @country_name
end

#latitude ⇒ Float

Degrees north of the equator.

Returns:

  • (Float) 


31
32
33
 
# File 'lib/oci/apm_synthetics/models/geo_summary.rb', line 31

def latitude
  @latitude
end

#longitude ⇒ Float

Degrees east of the prime meridian.

Returns:

  • (Float) 


35
36
37
 
# File 'lib/oci/apm_synthetics/models/geo_summary.rb', line 35

def longitude
  @longitude
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/oci/apm_synthetics/models/geo_summary.rb', line 38

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    '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.



52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/oci/apm_synthetics/models/geo_summary.rb', line 52

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    '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



119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/oci/apm_synthetics/models/geo_summary.rb', line 119

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/oci/apm_synthetics/models/geo_summary.rb', line 154

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


134
135
136
 
# File 'lib/oci/apm_synthetics/models/geo_summary.rb', line 134

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



143
144
145
 
# File 'lib/oci/apm_synthetics/models/geo_summary.rb', line 143

def hash
  [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



187
188
189
190
191
192
193
194
195
196
 
# File 'lib/oci/apm_synthetics/models/geo_summary.rb', line 187

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



181
182
183
 
# File 'lib/oci/apm_synthetics/models/geo_summary.rb', line 181

def to_s
  to_hash.to_s
end