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

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

Overview

Input only. Geographic region of the search.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ LocationFilter

Returns a new instance of LocationFilter.



1710
1711
1712
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1710

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) 


1660
1661
1662
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1660

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) 


1667
1668
1669
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1667

def distance_in_miles
  @distance_in_miles
end

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

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

Returns:



1675
1676
1677
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1675

def lat_lng
  @lat_lng
end

#region_code ⇒ String

Optional. CLDR region code of the country/region. This field may be used in two ways: 1) If telecommute preference is not set, this field is used address ambiguity of the user-input address. For example, "Liverpool" may refer to " Liverpool, NY, US" or "Liverpool, UK". This region code biases the address resolution toward a specific country or territory. If this field is not set, address resolution is biased toward the United States by default. 2) If telecommute preference is set to TELECOMMUTE_ALLOWED, the telecommute location filter will be limited to the region specified in this field. If this field is not set, the telecommute job locations will not be limited. See https:// unicode-org.github.io/cldr-staging/charts/latest/supplemental/ territory_information.html for details. Example: "CH" for Switzerland. Corresponds to the JSON property regionCode

Returns:

  • (String) 


1690
1691
1692
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1690

def region_code
  @region_code
end

#telecommute_preference ⇒ String

Optional. Allows the client to return jobs without a set location, specifically, telecommuting jobs (telecommuting 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, the telecommute status of the jobs is ignored. Jobs that have PostingRegion. TELECOMMUTE and have additional Job.addresses may still be matched based on other location filters using address or latlng. 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) 


1708
1709
1710
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1708

def telecommute_preference
  @telecommute_preference
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1715
1716
1717
1718
1719
1720
1721
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1715

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