Class: Google::Maps::FleetEngine::V1::SearchTripsRequest

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

SearchTrips request message.

Instance Attribute Summary collapse

Instance Attribute Details

#active_trips_only ⇒ ::Boolean

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

Returns:

  • (::Boolean) —

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



275
276
277
278
 
# File 'proto_docs/google/maps/fleetengine/v1/trip_api.rb', line 275

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

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

Returns The standard Fleet Engine request header.

Returns:



275
276
277
278
 
# File 'proto_docs/google/maps/fleetengine/v1/trip_api.rb', line 275

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

#minimum_staleness ⇒ ::Google::Protobuf::Duration

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

Returns:

  • (::Google::Protobuf::Duration) —

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



275
276
277
278
 
# File 'proto_docs/google/maps/fleetengine/v1/trip_api.rb', line 275

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

#page_size ⇒ ::Integer

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

Returns:

  • (::Integer) —

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



275
276
277
278
 
# File 'proto_docs/google/maps/fleetengine/v1/trip_api.rb', line 275

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

#page_token ⇒ ::String

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

Returns:

  • (::String) —

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



275
276
277
278
 
# File 'proto_docs/google/maps/fleetengine/v1/trip_api.rb', line 275

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

#parent ⇒ ::String

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

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



275
276
277
278
 
# File 'proto_docs/google/maps/fleetengine/v1/trip_api.rb', line 275

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

#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

Returns:

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


275
276
277
278
 
# File 'proto_docs/google/maps/fleetengine/v1/trip_api.rb', line 275

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