Class: Google::Maps::FleetEngine::V1::GetTripRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/maps/fleetengine/v1/trip_api.rb

Overview

GetTrip request message.

Instance Attribute Summary collapse

Instance Attribute Details

#current_route_segment_traffic_version ⇒ ::Google::Protobuf::Timestamp

Returns 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:

  • (::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.



133
134
135
136
 
# File 'proto_docs/google/maps/fleetengine/v1/trip_api.rb', line 133

class GetTripRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#current_route_segment_version ⇒ ::Google::Protobuf::Timestamp

Returns 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:

  • (::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.



133
134
135
136
 
# File 'proto_docs/google/maps/fleetengine/v1/trip_api.rb', line 133

class GetTripRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#header ⇒ ::Google::Maps::FleetEngine::V1::RequestHeader

Returns The standard Fleet Engine request header.

Returns:



133
134
135
136
 
# File 'proto_docs/google/maps/fleetengine/v1/trip_api.rb', line 133

class GetTripRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns 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:

  • (::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.



133
134
135
136
 
# File 'proto_docs/google/maps/fleetengine/v1/trip_api.rb', line 133

class GetTripRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#remaining_waypoints_route_version ⇒ ::Google::Protobuf::Timestamp

Returns 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:

  • (::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.



133
134
135
136
 
# File 'proto_docs/google/maps/fleetengine/v1/trip_api.rb', line 133

class GetTripRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#remaining_waypoints_version ⇒ ::Google::Protobuf::Timestamp

Returns 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:

  • (::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.



133
134
135
136
 
# File 'proto_docs/google/maps/fleetengine/v1/trip_api.rb', line 133

class GetTripRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#route_format_type ⇒ ::Google::Maps::FleetEngine::V1::PolylineFormatType

Returns 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:



133
134
135
136
 
# File 'proto_docs/google/maps/fleetengine/v1/trip_api.rb', line 133

class GetTripRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#view ⇒ ::Google::Maps::FleetEngine::V1::TripView

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

Returns:



133
134
135
136
 
# File 'proto_docs/google/maps/fleetengine/v1/trip_api.rb', line 133

class GetTripRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end