Class: OCI::GenerativeAiInference::Models::ApproximateLocation

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/generative_ai_inference/models/approximate_location.rb

Overview

To refine search results based on geography, you can specify an approximate user location using any of the following: - city and region are free-text strings, like "Minneapolis" and "Minnesota". - country is a two-letter ISO country code, like "US". - timezone is an IANA timezone string, like "America/Chicago".

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ApproximateLocation

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :city (String) —

    The value to assign to the #city property

  • :region (String) —

    The value to assign to the #region property

  • :country (String) —

    The value to assign to the #country property

  • :timezone (String) —

    The value to assign to the #timezone property



65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/generative_ai_inference/models/approximate_location.rb', line 65

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.city = attributes[:'city'] if attributes[:'city']

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

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

  self.timezone = attributes[:'timezone'] if attributes[:'timezone']
end

Instance Attribute Details

#city ⇒ String

Approximate city name, like "Minneapolis".

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/generative_ai_inference/models/approximate_location.rb', line 17

def city
  @city
end

#country ⇒ String

Two-letter ISO country code.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/generative_ai_inference/models/approximate_location.rb', line 25

def country
  @country
end

#region ⇒ String

Approximate region or state, like "Minnesota".

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/generative_ai_inference/models/approximate_location.rb', line 21

def region
  @region
end

#timezone ⇒ String

IANA timezone string.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/generative_ai_inference/models/approximate_location.rb', line 29

def timezone
  @timezone
end

Class Method Details

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
40
41
 
# File 'lib/oci/generative_ai_inference/models/approximate_location.rb', line 32

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'city': :'city',
    'region': :'region',
    'country': :'country',
    'timezone': :'timezone'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
52
53
 
# File 'lib/oci/generative_ai_inference/models/approximate_location.rb', line 44

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'city': :'String',
    'region': :'String',
    'country': :'String',
    'timezone': :'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



87
88
89
90
91
92
93
94
95
 
# File 'lib/oci/generative_ai_inference/models/approximate_location.rb', line 87

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

  self.class == other.class &&
    city == other.city &&
    region == other.region &&
    country == other.country &&
    timezone == other.timezone
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



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/oci/generative_ai_inference/models/approximate_location.rb', line 120

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


100
101
102
 
# File 'lib/oci/generative_ai_inference/models/approximate_location.rb', line 100

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



109
110
111
 
# File 'lib/oci/generative_ai_inference/models/approximate_location.rb', line 109

def hash
  [city, region, country, timezone].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



153
154
155
156
157
158
159
160
161
162
 
# File 'lib/oci/generative_ai_inference/models/approximate_location.rb', line 153

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



147
148
149
 
# File 'lib/oci/generative_ai_inference/models/approximate_location.rb', line 147

def to_s
  to_hash.to_s
end