Class: Google::Apis::JobsV3::LocationFilter

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/jobs_v3/classes.rb,
generated/google/apis/jobs_v3/representations.rb,
generated/google/apis/jobs_v3/representations.rb

Overview

Input only. Geographic region of the search.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ LocationFilter

Returns a new instance of LocationFilter



1861
1862
1863
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 1861

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#address ⇒ String

Optional. The address name, such as "Mountain View" or "Bay Area". Corresponds to the JSON property address

Returns:

  • (String) 


1809
1810
1811
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 1809

def address
  @address
end

#distance_in_miles ⇒ Float

Optional. The distance_in_miles is applied when the location being searched for is identified as a city or smaller. When the location being searched for is a state or larger, this field is ignored. Corresponds to the JSON property distanceInMiles

Returns:

  • (Float) 


1817
1818
1819
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 1817

def distance_in_miles
  @distance_in_miles
end

#lat_lng ⇒ Google::Apis::JobsV3::LatLng

An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. Corresponds to the JSON property latLng

Returns:



1826
1827
1828
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 1826

def lat_lng
  @lat_lng
end

#region_code ⇒ String

Optional. CLDR region code of the country/region of the address. This is used to address ambiguity of the user-input location, for example, "Liverpool" against "Liverpool, NY, US" or "Liverpool, UK". Set this field if all the jobs to search against are from a same region, or jobs are world-wide, but the job seeker is from a specific region. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. Corresponds to the JSON property regionCode

Returns:

  • (String) 


1839
1840
1841
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 1839

def region_code
  @region_code
end

#telecommute_preference ⇒ String

Optional. Allows the client to return jobs without a set location, specifically, telecommuting jobs (telecomuting is considered by the service as a special location. Job.posting_region indicates if a job permits telecommuting. If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED, telecommuting jobs are searched, and address and lat_lng are ignored. If not set or set to TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not searched. This filter can be used by itself to search exclusively for telecommuting jobs, or it can be combined with another location filter to search for a combination of job locations, such as "Mountain View" or "telecommuting" jobs. However, when used in combination with other location filters, telecommuting jobs can be treated as less relevant than other jobs in the search response. Corresponds to the JSON property telecommutePreference

Returns:

  • (String) 


1859
1860
1861
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 1859

def telecommute_preference
  @telecommute_preference
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1866
1867
1868
1869
1870
1871
1872
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 1866

def update!(**args)
  @address = args[:address] if args.key?(:address)
  @distance_in_miles = args[:distance_in_miles] if args.key?(:distance_in_miles)
  @lat_lng = args[:lat_lng] if args.key?(:lat_lng)
  @region_code = args[:region_code] if args.key?(:region_code)
  @telecommute_preference = args[:telecommute_preference] if args.key?(:telecommute_preference)
end