Cloud Talent Solution V4 API - Class Google::Cloud::Talent::V4::LocationFilter (v0.13.0)

Reference documentation and code samples for the Cloud Talent Solution V4 API class Google::Cloud::Talent::V4::LocationFilter.

Geographic region of the search.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#address

def address() -> ::String
Returns
  • (::String) — The address name, such as "Mountain View" or "Bay Area".

#address=

def address=(value) -> ::String
Parameter
  • value (::String) — The address name, such as "Mountain View" or "Bay Area".
Returns
  • (::String) — The address name, such as "Mountain View" or "Bay Area".

#distance_in_miles

def distance_in_miles() -> ::Float
Returns
  • (::Float) — The distance_in_miles is applied when the location being searched for is identified as a city or smaller. This field is ignored if the location being searched for is a state or larger.

#distance_in_miles=

def distance_in_miles=(value) -> ::Float
Parameter
  • value (::Float) — The distance_in_miles is applied when the location being searched for is identified as a city or smaller. This field is ignored if the location being searched for is a state or larger.
Returns
  • (::Float) — The distance_in_miles is applied when the location being searched for is identified as a city or smaller. This field is ignored if the location being searched for is a state or larger.

#lat_lng

def lat_lng() -> ::Google::Type::LatLng
Returns
  • (::Google::Type::LatLng) — The latitude and longitude of the geographic center to search from. This field is ignored if address is provided.

#lat_lng=

def lat_lng=(value) -> ::Google::Type::LatLng
Parameter
  • value (::Google::Type::LatLng) — The latitude and longitude of the geographic center to search from. This field is ignored if address is provided.
Returns
  • (::Google::Type::LatLng) — The latitude and longitude of the geographic center to search from. This field is ignored if address is provided.

#region_code

def region_code() -> ::String
Returns
  • (::String) — 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

    See https://unicode-org.github.io/cldr-staging/charts/latest/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

#region_code=

def region_code=(value) -> ::String
Parameter
  • value (::String) — 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

    See https://unicode-org.github.io/cldr-staging/charts/latest/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

Returns
  • (::String) — 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

    See https://unicode-org.github.io/cldr-staging/charts/latest/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

#telecommute_preference

def telecommute_preference() -> ::Google::Cloud::Talent::V4::LocationFilter::TelecommutePreference
Returns

#telecommute_preference=

def telecommute_preference=(value) -> ::Google::Cloud::Talent::V4::LocationFilter::TelecommutePreference
Parameter
  • value (::Google::Cloud::Talent::V4::LocationFilter::TelecommutePreference) — 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.

    This field is only used for job search requests.

Returns