# Google Cloud Talent Solution V4 Client - Class CommuteFilter (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 CommuteFilter.

Parameters needed for commute search.

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

## Namespace

Google \\ Cloud \\ Talent \\ V4

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ commute_method` | `int` Required. The method of transportation to calculate the commute time for. |
| `↳ start_coordinates` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Type.LatLng.html` Required. The latitude and longitude of the location to calculate the commute time from. |
| `↳ travel_duration` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Duration` Required. The maximum travel time in seconds. The maximum allowed value is `3600s` (one hour). Format is `123s`. |
| `↳ allow_imprecise_addresses` | `bool` If `true`, jobs without street level addresses may also be returned. For city level addresses, the city center is used. For state and coarser level addresses, text matching is used. If this field is set to `false` or isn't specified, only jobs that include street level addresses will be returned by commute search. |
| `↳ road_traffic` | `int` Specifies the traffic density to use when calculating commute time. |
| `↳ departure_time` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Type.TimeOfDay.html` The departure time used to calculate traffic impact, represented as [google.type.TimeOfDay](https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Type.TimeOfDay.html) in local time zone. Currently traffic model is restricted to hour level resolution. |

### getCommuteMethod

Required. The method of transportation to calculate the commute time for.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [CommuteMethod](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.CommuteMethod). |

### setCommuteMethod

Required. The method of transportation to calculate the commute time for.

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

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

### getStartCoordinates

Required. The latitude and longitude of the location to calculate the
commute time from.

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

### hasStartCoordinates

### clearStartCoordinates

### setStartCoordinates

Required. The latitude and longitude of the location to calculate the
commute time from.

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

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

### getTravelDuration

Required. The maximum travel time in seconds. The maximum allowed value is
`3600s` (one hour). Format is `123s`.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Duration|null` |   |

### hasTravelDuration

### clearTravelDuration

### setTravelDuration

Required. The maximum travel time in seconds. The maximum allowed value is
`3600s` (one hour). Format is `123s`.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Duration` |

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

### getAllowImpreciseAddresses

If `true`, jobs without street level addresses may also be returned.

For city level addresses, the city center is used. For state and coarser
level addresses, text matching is used.
If this field is set to `false` or isn't specified, only jobs that include
street level addresses will be returned by commute search.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### setAllowImpreciseAddresses

If `true`, jobs without street level addresses may also be returned.

For city level addresses, the city center is used. For state and coarser
level addresses, text matching is used.
If this field is set to `false` or isn't specified, only jobs that include
street level addresses will be returned by commute search.

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

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

### getRoadTraffic

Specifies the traffic density to use when calculating commute time.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [RoadTraffic](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.CommuteFilter.RoadTraffic). |

### hasRoadTraffic

### setRoadTraffic

Specifies the traffic density to use when calculating commute time.

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

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

### getDepartureTime

The departure time used to calculate traffic impact, represented as
[google.type.TimeOfDay](https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Type.TimeOfDay.html) in local time zone.

Currently traffic model is restricted to hour level resolution.

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

### hasDepartureTime

### setDepartureTime

The departure time used to calculate traffic impact, represented as
[google.type.TimeOfDay](https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Type.TimeOfDay.html) in local time zone.

Currently traffic model is restricted to hour level resolution.

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

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

### getTrafficOption

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