Class: Google::Cloud::Talent::V4::LocationFilter

Inherits:

Object

Object
Google::Cloud::Talent::V4::LocationFilter

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/talent/v4/filters.rb

Overview

Geographic region of the search.

Defined Under Namespace

Modules: TelecommutePreference

Instance Attribute Summary collapse

#address ⇒ ::String
The address name, such as "Mountain View" or "Bay Area".
#distance_in_miles ⇒ ::Float
The distance_in_miles is applied when the location being searched for is identified as a city or smaller.
#lat_lng ⇒ ::Google::Type::LatLng
The latitude and longitude of the geographic center to search from.
#region_code ⇒ ::String
CLDR region code of the country/region.
#telecommute_preference ⇒ ::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).

Instance Attribute Details

#address ⇒ `::String`

Returns The address name, such as "Mountain View" or "Bay Area".

Returns:

(::String) —
The address name, such as "Mountain View" or "Bay Area".

# File 'proto_docs/google/cloud/talent/v4/filters.rb', line 255

class LocationFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specify whether to include telecommute jobs.
  module TelecommutePreference
    # Default value if the telecommute preference isn't specified.
    TELECOMMUTE_PREFERENCE_UNSPECIFIED = 0

    # Deprecated: Ignore telecommute status of jobs. Use
    # TELECOMMUTE_JOBS_EXCLUDED if want to exclude telecommute jobs.
    TELECOMMUTE_EXCLUDED = 1

    # Allow telecommute jobs.
    TELECOMMUTE_ALLOWED = 2

    # Exclude telecommute jobs.
    TELECOMMUTE_JOBS_EXCLUDED = 3
  end
end

#distance_in_miles ⇒ `::Float`

Returns 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.

# File 'proto_docs/google/cloud/talent/v4/filters.rb', line 255

class LocationFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specify whether to include telecommute jobs.
  module TelecommutePreference
    # Default value if the telecommute preference isn't specified.
    TELECOMMUTE_PREFERENCE_UNSPECIFIED = 0

    # Deprecated: Ignore telecommute status of jobs. Use
    # TELECOMMUTE_JOBS_EXCLUDED if want to exclude telecommute jobs.
    TELECOMMUTE_EXCLUDED = 1

    # Allow telecommute jobs.
    TELECOMMUTE_ALLOWED = 2

    # Exclude telecommute jobs.
    TELECOMMUTE_JOBS_EXCLUDED = 3
  end
end

#lat_lng ⇒ `::Google::Type::LatLng`

Returns 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.

# File 'proto_docs/google/cloud/talent/v4/filters.rb', line 255

class LocationFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specify whether to include telecommute jobs.
  module TelecommutePreference
    # Default value if the telecommute preference isn't specified.
    TELECOMMUTE_PREFERENCE_UNSPECIFIED = 0

    # Deprecated: Ignore telecommute status of jobs. Use
    # TELECOMMUTE_JOBS_EXCLUDED if want to exclude telecommute jobs.
    TELECOMMUTE_EXCLUDED = 1

    # Allow telecommute jobs.
    TELECOMMUTE_ALLOWED = 2

    # Exclude telecommute jobs.
    TELECOMMUTE_JOBS_EXCLUDED = 3
  end
end

#region_code ⇒ `::String`

Returns 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.

# File 'proto_docs/google/cloud/talent/v4/filters.rb', line 255

class LocationFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specify whether to include telecommute jobs.
  module TelecommutePreference
    # Default value if the telecommute preference isn't specified.
    TELECOMMUTE_PREFERENCE_UNSPECIFIED = 0

    # Deprecated: Ignore telecommute status of jobs. Use
    # TELECOMMUTE_JOBS_EXCLUDED if want to exclude telecommute jobs.
    TELECOMMUTE_EXCLUDED = 1

    # Allow telecommute jobs.
    TELECOMMUTE_ALLOWED = 2

    # Exclude telecommute jobs.
    TELECOMMUTE_JOBS_EXCLUDED = 3
  end
end

#telecommute_preference ⇒ `::Google::Cloud::Talent::V4::LocationFilter::TelecommutePreference`

Returns 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:

(::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.

# File 'proto_docs/google/cloud/talent/v4/filters.rb', line 255

class LocationFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specify whether to include telecommute jobs.
  module TelecommutePreference
    # Default value if the telecommute preference isn't specified.
    TELECOMMUTE_PREFERENCE_UNSPECIFIED = 0

    # Deprecated: Ignore telecommute status of jobs. Use
    # TELECOMMUTE_JOBS_EXCLUDED if want to exclude telecommute jobs.
    TELECOMMUTE_EXCLUDED = 1

    # Allow telecommute jobs.
    TELECOMMUTE_ALLOWED = 2

    # Exclude telecommute jobs.
    TELECOMMUTE_JOBS_EXCLUDED = 3
  end
end

Class: Google::Cloud::Talent::V4::LocationFilter

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#address ⇒ ::String

#distance_in_miles ⇒ ::Float

#lat_lng ⇒ ::Google::Type::LatLng

#region_code ⇒ ::String

#telecommute_preference ⇒ ::Google::Cloud::Talent::V4::LocationFilter::TelecommutePreference

#address ⇒ `::String`

#distance_in_miles ⇒ `::Float`

#lat_lng ⇒ `::Google::Type::LatLng`

#region_code ⇒ `::String`

#telecommute_preference ⇒ `::Google::Cloud::Talent::V4::LocationFilter::TelecommutePreference`