Class: Google::Apis::JobsV2::LocationFilter

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/jobs_v2/classes.rb,
generated/google/apis/jobs_v2/representations.rb,
generated/google/apis/jobs_v2/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



2641
2642
2643
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2641

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

Instance Attribute Details

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


2592
2593
2594
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2592

def distance_in_miles
  @distance_in_miles
end

#is_telecommute ⇒ Boolean Also known as: is_telecommute?

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.allow_telecommute indicates if a job permits telecommuting. If this field is true, telecommuting jobs are searched, and name and lat_lng are ignored. 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 isTelecommute

Returns:

  • (Boolean) 


2610
2611
2612
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2610

def is_telecommute
  @is_telecommute
end

#lat_lng ⇒ Google::Apis::JobsV2::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:



2620
2621
2622
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2620

def lat_lng
  @lat_lng
end

#name ⇒ String

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

Returns:

  • (String) 


2626
2627
2628
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2626

def name
  @name
end

#region_code ⇒ String

Optional. CLDR region code of the country/region of the address. This will be used to address ambiguity of the user-input location, e.g. "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) 


2639
2640
2641
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2639

def region_code
  @region_code
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2646
2647
2648
2649
2650
2651
2652
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 2646

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