# Google Cloud Talent Solution V4 Client - Class LocationFilter (2.3.0)

2.3.0 (latest) 2.2.1 2.1.3 2.0.2 1.3.5 1.2.2 1.1.1 1.0.5 Reference documentation and code samples for the Google Cloud Talent Solution V4 Client class LocationFilter.

Geographic region of the search.

Generated from protobuf message `google.cloud.talent.v4.LocationFilter`

## Namespace

Google \\ Cloud \\ Talent \\ V4

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ address` | `string` The address name, such as "Mountain View" or "Bay Area". |
| `↳ region_code` | `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. |
| `↳ lat_lng` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Type.LatLng.html` The latitude and longitude of the geographic center to search from. This field is ignored if `address` is provided. |
| `↳ distance_in_miles` | `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. |
| `↳ telecommute_preference` | `int` 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](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.Job#_Google_Cloud_Talent_V4_Job__getPostingRegion__) indicates if a job permits telecommuting. If this field is set to [TelecommutePreference.TELECOMMUTE_ALLOWED](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.LocationFilter.TelecommutePreference#_Google_Cloud_Talent_V4_LocationFilter_TelecommutePreference__TELECOMMUTE_ALLOWED), telecommuting jobs are searched, and [address](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.LocationFilter#_Google_Cloud_Talent_V4_LocationFilter__getAddress__) and [lat_lng](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.LocationFilter#_Google_Cloud_Talent_V4_LocationFilter__getLatLng__) are ignored. If not set or set to [TelecommutePreference.TELECOMMUTE_EXCLUDED](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.LocationFilter.TelecommutePreference#_Google_Cloud_Talent_V4_LocationFilter_TelecommutePreference__TELECOMMUTE_EXCLUDED), the telecommute status of the jobs is ignored. Jobs that have [PostingRegion.TELECOMMUTE](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.PostingRegion#_Google_Cloud_Talent_V4_PostingRegion__TELECOMMUTE) and have additional [Job.addresses](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.Job#_Google_Cloud_Talent_V4_Job__getAddresses__) may still be matched based on other location filters using [address](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.LocationFilter#_Google_Cloud_Talent_V4_LocationFilter__getAddress__) or [lat_lng](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.LocationFilter#_Google_Cloud_Talent_V4_LocationFilter__getLatLng__). 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. |

### getAddress

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setAddress

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getRegionCode

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** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setRegionCode

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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getLatLng

The latitude and longitude of the geographic center to search from. This
field is ignored if `address` is provided.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Type.LatLng.html|null` |   |

### hasLatLng

### clearLatLng

### setLatLng

The latitude and longitude of the geographic center to search from. This
field is ignored if `address` is provided.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Type.LatLng.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getDistanceInMiles

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** ||
|---|---|
| **Type** | **Description** |
| `float` |   |

### setDistanceInMiles

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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `float` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getTelecommutePreference

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](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.Job#_Google_Cloud_Talent_V4_Job__getPostingRegion__) indicates
if a job permits telecommuting. If this field is set to
[TelecommutePreference.TELECOMMUTE_ALLOWED](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.LocationFilter.TelecommutePreference#_Google_Cloud_Talent_V4_LocationFilter_TelecommutePreference__TELECOMMUTE_ALLOWED),
telecommuting jobs are searched, and
[address](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.LocationFilter#_Google_Cloud_Talent_V4_LocationFilter__getAddress__) and
[lat_lng](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.LocationFilter#_Google_Cloud_Talent_V4_LocationFilter__getLatLng__) are ignored. If
not set or set to
[TelecommutePreference.TELECOMMUTE_EXCLUDED](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.LocationFilter.TelecommutePreference#_Google_Cloud_Talent_V4_LocationFilter_TelecommutePreference__TELECOMMUTE_EXCLUDED),
the telecommute status of the jobs is ignored. Jobs that have
[PostingRegion.TELECOMMUTE](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.PostingRegion#_Google_Cloud_Talent_V4_PostingRegion__TELECOMMUTE)
and have additional [Job.addresses](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.Job#_Google_Cloud_Talent_V4_Job__getAddresses__)
may still be matched based on other location filters using
[address](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.LocationFilter#_Google_Cloud_Talent_V4_LocationFilter__getAddress__) or
[lat_lng](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.LocationFilter#_Google_Cloud_Talent_V4_LocationFilter__getLatLng__).
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** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [TelecommutePreference](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.LocationFilter.TelecommutePreference). |

### setTelecommutePreference

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](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.Job#_Google_Cloud_Talent_V4_Job__getPostingRegion__) indicates
if a job permits telecommuting. If this field is set to
[TelecommutePreference.TELECOMMUTE_ALLOWED](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.LocationFilter.TelecommutePreference#_Google_Cloud_Talent_V4_LocationFilter_TelecommutePreference__TELECOMMUTE_ALLOWED),
telecommuting jobs are searched, and
[address](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.LocationFilter#_Google_Cloud_Talent_V4_LocationFilter__getAddress__) and
[lat_lng](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.LocationFilter#_Google_Cloud_Talent_V4_LocationFilter__getLatLng__) are ignored. If
not set or set to
[TelecommutePreference.TELECOMMUTE_EXCLUDED](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.LocationFilter.TelecommutePreference#_Google_Cloud_Talent_V4_LocationFilter_TelecommutePreference__TELECOMMUTE_EXCLUDED),
the telecommute status of the jobs is ignored. Jobs that have
[PostingRegion.TELECOMMUTE](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.PostingRegion#_Google_Cloud_Talent_V4_PostingRegion__TELECOMMUTE)
and have additional [Job.addresses](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.Job#_Google_Cloud_Talent_V4_Job__getAddresses__)
may still be matched based on other location filters using
[address](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.LocationFilter#_Google_Cloud_Talent_V4_LocationFilter__getAddress__) or
[lat_lng](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.LocationFilter#_Google_Cloud_Talent_V4_LocationFilter__getLatLng__).
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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [TelecommutePreference](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.LocationFilter.TelecommutePreference). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |