Google Maps FleetEngine V1 Client - Class GetTripRequest (0.1.2)

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

GetTrip request message.

Generated from protobuf message maps.fleetengine.v1.GetTripRequest

Namespace

Google \ Maps \ FleetEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ header Google\Maps\FleetEngine\V1\RequestHeader

The standard Fleet Engine request header.
↳ name string

Required. Must be in the format providers/{provider}/trips/{trip}. 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.
↳ view int

The subset of Trip fields that should be returned and their interpretation.
↳ current_route_segment_version Google\Protobuf\Timestamp

Indicates the minimum timestamp (exclusive) for which Trip.route or Trip.current_route_segment data are retrieved. If route data are unchanged since this timestamp, the route field is not set in the response. If a minimum is unspecified, the route data are always retrieved.
↳ remaining_waypoints_version Google\Protobuf\Timestamp

Indicates the minimum timestamp (exclusive) for which Trip.remaining_waypoints are retrieved. If they are unchanged since this timestamp, the remaining_waypoints are not set in the response. If this field is unspecified, remaining_waypoints is always retrieved.
↳ route_format_type int

The returned current route format, LAT_LNG_LIST_TYPE (in Trip.route), or ENCODED_POLYLINE_TYPE (in Trip.current_route_segment). The default is LAT_LNG_LIST_TYPE.
↳ current_route_segment_traffic_version Google\Protobuf\Timestamp

Indicates the minimum timestamp (exclusive) for which Trip.current_route_segment_traffic is retrieved. If traffic data are unchanged since this timestamp, the current_route_segment_traffic field is not set in the response. If a minimum is unspecified, the traffic data are always retrieved. Note that traffic is only available for On-Demand Rides and Deliveries Solution customers.
↳ remaining_waypoints_route_version Google\Protobuf\Timestamp

Indicates the minimum timestamp (exclusive) for which Trip.remaining_waypoints.traffic_to_waypoint and Trip.remaining_waypoints.path_to_waypoint data are retrieved. If data are unchanged since this timestamp, the fields above are not set in the response. If remaining_waypoints_route_version is unspecified, traffic and path are always retrieved.

getHeader

The standard Fleet Engine request header.

Returns
Type Description
Google\Maps\FleetEngine\V1\RequestHeader|null

hasHeader

clearHeader

setHeader

The standard Fleet Engine request header.

Parameter
Name Description
var Google\Maps\FleetEngine\V1\RequestHeader
Returns
Type Description
$this

getName

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

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

setName

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

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

getView

The subset of Trip fields that should be returned and their interpretation.

Returns
Type Description
int

setView

The subset of Trip fields that should be returned and their interpretation.

Parameter
Name Description
var int
Returns
Type Description
$this

getCurrentRouteSegmentVersion

Indicates the minimum timestamp (exclusive) for which Trip.route or Trip.current_route_segment data are retrieved. If route data are unchanged since this timestamp, the route field is not set in the response.

If a minimum is unspecified, the route data are always retrieved.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCurrentRouteSegmentVersion

clearCurrentRouteSegmentVersion

setCurrentRouteSegmentVersion

Indicates the minimum timestamp (exclusive) for which Trip.route or Trip.current_route_segment data are retrieved. If route data are unchanged since this timestamp, the route field is not set in the response.

If a minimum is unspecified, the route data are always retrieved.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getRemainingWaypointsVersion

Indicates the minimum timestamp (exclusive) for which Trip.remaining_waypoints are retrieved. If they are unchanged since this timestamp, the remaining_waypoints are not set in the response. If this field is unspecified, remaining_waypoints is always retrieved.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasRemainingWaypointsVersion

clearRemainingWaypointsVersion

setRemainingWaypointsVersion

Indicates the minimum timestamp (exclusive) for which Trip.remaining_waypoints are retrieved. If they are unchanged since this timestamp, the remaining_waypoints are not set in the response. If this field is unspecified, remaining_waypoints is always retrieved.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getRouteFormatType

The returned current route format, LAT_LNG_LIST_TYPE (in Trip.route), or ENCODED_POLYLINE_TYPE (in Trip.current_route_segment). The default is LAT_LNG_LIST_TYPE.

Returns
Type Description
int

setRouteFormatType

The returned current route format, LAT_LNG_LIST_TYPE (in Trip.route), or ENCODED_POLYLINE_TYPE (in Trip.current_route_segment). The default is LAT_LNG_LIST_TYPE.

Parameter
Name Description
var int
Returns
Type Description
$this

getCurrentRouteSegmentTrafficVersion

Indicates the minimum timestamp (exclusive) for which Trip.current_route_segment_traffic is retrieved. If traffic data are unchanged since this timestamp, the current_route_segment_traffic field is not set in the response. If a minimum is unspecified, the traffic data are always retrieved. Note that traffic is only available for On-Demand Rides and Deliveries Solution customers.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCurrentRouteSegmentTrafficVersion

clearCurrentRouteSegmentTrafficVersion

setCurrentRouteSegmentTrafficVersion

Indicates the minimum timestamp (exclusive) for which Trip.current_route_segment_traffic is retrieved. If traffic data are unchanged since this timestamp, the current_route_segment_traffic field is not set in the response. If a minimum is unspecified, the traffic data are always retrieved. Note that traffic is only available for On-Demand Rides and Deliveries Solution customers.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getRemainingWaypointsRouteVersion

Indicates the minimum timestamp (exclusive) for which Trip.remaining_waypoints.traffic_to_waypoint and Trip.remaining_waypoints.path_to_waypoint data are retrieved. If data are unchanged since this timestamp, the fields above are not set in the response. If remaining_waypoints_route_version is unspecified, traffic and path are always retrieved.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasRemainingWaypointsRouteVersion

clearRemainingWaypointsRouteVersion

setRemainingWaypointsRouteVersion

Indicates the minimum timestamp (exclusive) for which Trip.remaining_waypoints.traffic_to_waypoint and Trip.remaining_waypoints.path_to_waypoint data are retrieved. If data are unchanged since this timestamp, the fields above are not set in the response. If remaining_waypoints_route_version is unspecified, traffic and path are always retrieved.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this