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 \ V4Methods
__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 |
Google\Type\LatLng
Required. The latitude and longitude of the location to calculate the commute time from. |
↳ travel_duration |
Google\Protobuf\Duration
Required. The maximum travel time in seconds. The maximum allowed value is |
↳ allow_imprecise_addresses |
bool
If |
↳ road_traffic |
int
Specifies the traffic density to use when calculating commute time. |
↳ departure_time |
Google\Type\TimeOfDay
The departure time used to calculate traffic impact, represented as google.type.TimeOfDay 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 |
setCommuteMethod
Required. The method of transportation to calculate the commute time for.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getStartCoordinates
Required. The latitude and longitude of the location to calculate the commute time from.
Returns | |
---|---|
Type | Description |
Google\Type\LatLng|null |
hasStartCoordinates
clearStartCoordinates
setStartCoordinates
Required. The latitude and longitude of the location to calculate the commute time from.
Parameter | |
---|---|
Name | Description |
var |
Google\Type\LatLng
|
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 |
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 |
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 |
hasRoadTraffic
setRoadTraffic
Specifies the traffic density to use when calculating commute time.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getDepartureTime
The departure time used to calculate traffic impact, represented as google.type.TimeOfDay in local time zone.
Currently traffic model is restricted to hour level resolution.
Returns | |
---|---|
Type | Description |
Google\Type\TimeOfDay|null |
hasDepartureTime
setDepartureTime
The departure time used to calculate traffic impact, represented as google.type.TimeOfDay in local time zone.
Currently traffic model is restricted to hour level resolution.
Parameter | |
---|---|
Name | Description |
var |
Google\Type\TimeOfDay
|
Returns | |
---|---|
Type | Description |
$this |
getTrafficOption
Returns | |
---|---|
Type | Description |
string |