Google Maps FleetEngine V1 Client - Class SearchTripsRequest (0.2.0)

Reference documentation and code samples for the Google Maps FleetEngine V1 Client class SearchTripsRequest.

SearchTrips request message.

Generated from protobuf message maps.fleetengine.v1.SearchTripsRequest

Namespace

Google \ Maps \ FleetEngine \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ header
RequestHeader

The standard Fleet Engine request header.

↳ parent
string

Required. Must be in the format providers/{provider} . The provider must be the Project ID (for example, sample-cloud-project ) of the Google Cloud Project of which the service account making this call is a member.

↳ vehicle_id
string

The vehicle associated with the trips in the request. If unspecified, the returned trips do not contain: * * current_route_segment * * remaining_waypoints * * remaining_distance_meters * * eta_to_first_waypoint

↳ active_trips_only
bool

If set to true, the response includes Trips that influence a driver's route.

↳ page_size
int

If not set, the server decides the number of results to return.

↳ page_token
string

Set this to a value previously returned in the SearchTripsResponse to continue from previous results.

↳ minimum_staleness
Google\Protobuf\Duration

If specified, returns the trips that have not been updated after the time (current - minimum_staleness) .

getHeader

The standard Fleet Engine request header.

Returns
Type
Description

hasHeader

clearHeader

setHeader

The standard Fleet Engine request header.

Parameter
Name
Description
Returns
Type
Description
$this

getParent

Required. Must be in the format providers/{provider} .

The provider must be the Project ID (for example, sample-cloud-project ) of the Google Cloud Project of which the service account making this call is a member.

Returns
Type
Description
string

setParent

Required. Must be in the format providers/{provider} .

The provider must be the Project ID (for example, sample-cloud-project ) of the Google Cloud Project of which the service account making this call is a member.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getVehicleId

The vehicle associated with the trips in the request. If unspecified, the returned trips do not contain:

  • current_route_segment
  • remaining_waypoints
  • remaining_distance_meters
  • eta_to_first_waypoint
Returns
Type
Description
string

setVehicleId

The vehicle associated with the trips in the request. If unspecified, the returned trips do not contain:

  • current_route_segment
  • remaining_waypoints
  • remaining_distance_meters
  • eta_to_first_waypoint
Parameter
Name
Description
var
string
Returns
Type
Description
$this

getActiveTripsOnly

If set to true, the response includes Trips that influence a driver's route.

Returns
Type
Description
bool

setActiveTripsOnly

If set to true, the response includes Trips that influence a driver's route.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getPageSize

If not set, the server decides the number of results to return.

Returns
Type
Description
int

setPageSize

If not set, the server decides the number of results to return.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getPageToken

Set this to a value previously returned in the SearchTripsResponse to continue from previous results.

Returns
Type
Description
string

setPageToken

Set this to a value previously returned in the SearchTripsResponse to continue from previous results.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getMinimumStaleness

If specified, returns the trips that have not been updated after the time (current - minimum_staleness) .

Returns
Type
Description

hasMinimumStaleness

clearMinimumStaleness

setMinimumStaleness

If specified, returns the trips that have not been updated after the time (current - minimum_staleness) .

Parameter
Name
Description
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: