Constants
TripService_CreateTrip_FullMethodName, TripService_GetTrip_FullMethodName, TripService_DeleteTrip_FullMethodName, TripService_ReportBillableTrip_FullMethodName, TripService_SearchTrips_FullMethodName, TripService_UpdateTrip_FullMethodName
const (
TripService_CreateTrip_FullMethodName = "/maps.fleetengine.v1.TripService/CreateTrip"
TripService_GetTrip_FullMethodName = "/maps.fleetengine.v1.TripService/GetTrip"
TripService_DeleteTrip_FullMethodName = "/maps.fleetengine.v1.TripService/DeleteTrip"
TripService_ReportBillableTrip_FullMethodName = "/maps.fleetengine.v1.TripService/ReportBillableTrip"
TripService_SearchTrips_FullMethodName = "/maps.fleetengine.v1.TripService/SearchTrips"
TripService_UpdateTrip_FullMethodName = "/maps.fleetengine.v1.TripService/UpdateTrip"
)VehicleService_CreateVehicle_FullMethodName, VehicleService_GetVehicle_FullMethodName, VehicleService_DeleteVehicle_FullMethodName, VehicleService_UpdateVehicle_FullMethodName, VehicleService_UpdateVehicleAttributes_FullMethodName, VehicleService_ListVehicles_FullMethodName, VehicleService_SearchVehicles_FullMethodName
const (
VehicleService_CreateVehicle_FullMethodName = "/maps.fleetengine.v1.VehicleService/CreateVehicle"
VehicleService_GetVehicle_FullMethodName = "/maps.fleetengine.v1.VehicleService/GetVehicle"
VehicleService_DeleteVehicle_FullMethodName = "/maps.fleetengine.v1.VehicleService/DeleteVehicle"
VehicleService_UpdateVehicle_FullMethodName = "/maps.fleetengine.v1.VehicleService/UpdateVehicle"
VehicleService_UpdateVehicleAttributes_FullMethodName = "/maps.fleetengine.v1.VehicleService/UpdateVehicleAttributes"
VehicleService_ListVehicles_FullMethodName = "/maps.fleetengine.v1.VehicleService/ListVehicles"
VehicleService_SearchVehicles_FullMethodName = "/maps.fleetengine.v1.VehicleService/SearchVehicles"
)Variables
TripType_name, TripType_value
var (
TripType_name = map[int32]string{
0: "UNKNOWN_TRIP_TYPE",
1: "SHARED",
2: "EXCLUSIVE",
}
TripType_value = map[string]int32{
"UNKNOWN_TRIP_TYPE": 0,
"SHARED": 1,
"EXCLUSIVE": 2,
}
)Enum value maps for TripType.
WaypointType_name, WaypointType_value
var (
WaypointType_name = map[int32]string{
0: "UNKNOWN_WAYPOINT_TYPE",
1: "PICKUP_WAYPOINT_TYPE",
2: "DROP_OFF_WAYPOINT_TYPE",
3: "INTERMEDIATE_DESTINATION_WAYPOINT_TYPE",
}
WaypointType_value = map[string]int32{
"UNKNOWN_WAYPOINT_TYPE": 0,
"PICKUP_WAYPOINT_TYPE": 1,
"DROP_OFF_WAYPOINT_TYPE": 2,
"INTERMEDIATE_DESTINATION_WAYPOINT_TYPE": 3,
}
)Enum value maps for WaypointType.
PolylineFormatType_name, PolylineFormatType_value
var (
PolylineFormatType_name = map[int32]string{
0: "UNKNOWN_FORMAT_TYPE",
1: "LAT_LNG_LIST_TYPE",
2: "ENCODED_POLYLINE_TYPE",
}
PolylineFormatType_value = map[string]int32{
"UNKNOWN_FORMAT_TYPE": 0,
"LAT_LNG_LIST_TYPE": 1,
"ENCODED_POLYLINE_TYPE": 2,
}
)Enum value maps for PolylineFormatType.
NavigationStatus_name, NavigationStatus_value
var (
NavigationStatus_name = map[int32]string{
0: "UNKNOWN_NAVIGATION_STATUS",
1: "NO_GUIDANCE",
2: "ENROUTE_TO_DESTINATION",
3: "OFF_ROUTE",
4: "ARRIVED_AT_DESTINATION",
}
NavigationStatus_value = map[string]int32{
"UNKNOWN_NAVIGATION_STATUS": 0,
"NO_GUIDANCE": 1,
"ENROUTE_TO_DESTINATION": 2,
"OFF_ROUTE": 3,
"ARRIVED_AT_DESTINATION": 4,
}
)Enum value maps for NavigationStatus.
LocationSensor_name, LocationSensor_value
var (
LocationSensor_name = map[int32]string{
0: "UNKNOWN_SENSOR",
1: "GPS",
2: "NETWORK",
3: "PASSIVE",
4: "ROAD_SNAPPED_LOCATION_PROVIDER",
5: "CUSTOMER_SUPPLIED_LOCATION",
6: "FLEET_ENGINE_LOCATION",
100: "FUSED_LOCATION_PROVIDER",
200: "CORE_LOCATION",
}
LocationSensor_value = map[string]int32{
"UNKNOWN_SENSOR": 0,
"GPS": 1,
"NETWORK": 2,
"PASSIVE": 3,
"ROAD_SNAPPED_LOCATION_PROVIDER": 4,
"CUSTOMER_SUPPLIED_LOCATION": 5,
"FLEET_ENGINE_LOCATION": 6,
"FUSED_LOCATION_PROVIDER": 100,
"CORE_LOCATION": 200,
}
)Enum value maps for LocationSensor.
RequestHeader_SdkType_name, RequestHeader_SdkType_value
var (
RequestHeader_SdkType_name = map[int32]string{
0: "SDK_TYPE_UNSPECIFIED",
1: "CONSUMER",
2: "DRIVER",
3: "JAVASCRIPT",
}
RequestHeader_SdkType_value = map[string]int32{
"SDK_TYPE_UNSPECIFIED": 0,
"CONSUMER": 1,
"DRIVER": 2,
"JAVASCRIPT": 3,
}
)Enum value maps for RequestHeader_SdkType.
RequestHeader_Platform_name, RequestHeader_Platform_value
var (
RequestHeader_Platform_name = map[int32]string{
0: "PLATFORM_UNSPECIFIED",
1: "ANDROID",
2: "IOS",
3: "WEB",
}
RequestHeader_Platform_value = map[string]int32{
"PLATFORM_UNSPECIFIED": 0,
"ANDROID": 1,
"IOS": 2,
"WEB": 3,
}
)Enum value maps for RequestHeader_Platform.
SpeedReadingInterval_Speed_name, SpeedReadingInterval_Speed_value
var (
SpeedReadingInterval_Speed_name = map[int32]string{
0: "SPEED_UNSPECIFIED",
1: "NORMAL",
2: "SLOW",
3: "TRAFFIC_JAM",
}
SpeedReadingInterval_Speed_value = map[string]int32{
"SPEED_UNSPECIFIED": 0,
"NORMAL": 1,
"SLOW": 2,
"TRAFFIC_JAM": 3,
}
)Enum value maps for SpeedReadingInterval_Speed.
ReportBillableTripRequest_SolutionType_name, ReportBillableTripRequest_SolutionType_value
var (
ReportBillableTripRequest_SolutionType_name = map[int32]string{
0: "SOLUTION_TYPE_UNSPECIFIED",
1: "ON_DEMAND_RIDESHARING_AND_DELIVERIES",
}
ReportBillableTripRequest_SolutionType_value = map[string]int32{
"SOLUTION_TYPE_UNSPECIFIED": 0,
"ON_DEMAND_RIDESHARING_AND_DELIVERIES": 1,
}
)Enum value maps for ReportBillableTripRequest_SolutionType.
TripStatus_name, TripStatus_value
var (
TripStatus_name = map[int32]string{
0: "UNKNOWN_TRIP_STATUS",
1: "NEW",
2: "ENROUTE_TO_PICKUP",
3: "ARRIVED_AT_PICKUP",
7: "ARRIVED_AT_INTERMEDIATE_DESTINATION",
8: "ENROUTE_TO_INTERMEDIATE_DESTINATION",
4: "ENROUTE_TO_DROPOFF",
5: "COMPLETE",
6: "CANCELED",
}
TripStatus_value = map[string]int32{
"UNKNOWN_TRIP_STATUS": 0,
"NEW": 1,
"ENROUTE_TO_PICKUP": 2,
"ARRIVED_AT_PICKUP": 3,
"ARRIVED_AT_INTERMEDIATE_DESTINATION": 7,
"ENROUTE_TO_INTERMEDIATE_DESTINATION": 8,
"ENROUTE_TO_DROPOFF": 4,
"COMPLETE": 5,
"CANCELED": 6,
}
)Enum value maps for TripStatus.
BillingPlatformIdentifier_name, BillingPlatformIdentifier_value
var (
BillingPlatformIdentifier_name = map[int32]string{
0: "BILLING_PLATFORM_IDENTIFIER_UNSPECIFIED",
1: "SERVER",
2: "WEB",
3: "ANDROID",
4: "IOS",
5: "OTHERS",
}
BillingPlatformIdentifier_value = map[string]int32{
"BILLING_PLATFORM_IDENTIFIER_UNSPECIFIED": 0,
"SERVER": 1,
"WEB": 2,
"ANDROID": 3,
"IOS": 4,
"OTHERS": 5,
}
)Enum value maps for BillingPlatformIdentifier.
TripView_name, TripView_value
var (
TripView_name = map[int32]string{
0: "TRIP_VIEW_UNSPECIFIED",
1: "SDK",
2: "JOURNEY_SHARING_V1S",
}
TripView_value = map[string]int32{
"TRIP_VIEW_UNSPECIFIED": 0,
"SDK": 1,
"JOURNEY_SHARING_V1S": 2,
}
)Enum value maps for TripView.
SearchVehiclesRequest_VehicleMatchOrder_name, SearchVehiclesRequest_VehicleMatchOrder_value
var (
SearchVehiclesRequest_VehicleMatchOrder_name = map[int32]string{
0: "UNKNOWN_VEHICLE_MATCH_ORDER",
1: "PICKUP_POINT_ETA",
2: "PICKUP_POINT_DISTANCE",
3: "DROPOFF_POINT_ETA",
4: "PICKUP_POINT_STRAIGHT_DISTANCE",
5: "COST",
}
SearchVehiclesRequest_VehicleMatchOrder_value = map[string]int32{
"UNKNOWN_VEHICLE_MATCH_ORDER": 0,
"PICKUP_POINT_ETA": 1,
"PICKUP_POINT_DISTANCE": 2,
"DROPOFF_POINT_ETA": 3,
"PICKUP_POINT_STRAIGHT_DISTANCE": 4,
"COST": 5,
}
)Enum value maps for SearchVehiclesRequest_VehicleMatchOrder.
SearchVehiclesRequest_CurrentTripsPresent_name, SearchVehiclesRequest_CurrentTripsPresent_value
var (
SearchVehiclesRequest_CurrentTripsPresent_name = map[int32]string{
0: "CURRENT_TRIPS_PRESENT_UNSPECIFIED",
1: "NONE",
2: "ANY",
}
SearchVehiclesRequest_CurrentTripsPresent_value = map[string]int32{
"CURRENT_TRIPS_PRESENT_UNSPECIFIED": 0,
"NONE": 1,
"ANY": 2,
}
)Enum value maps for SearchVehiclesRequest_CurrentTripsPresent.
VehicleMatch_VehicleMatchType_name, VehicleMatch_VehicleMatchType_value
var (
VehicleMatch_VehicleMatchType_name = map[int32]string{
0: "UNKNOWN",
1: "EXCLUSIVE",
2: "BACK_TO_BACK",
3: "CARPOOL",
4: "CARPOOL_BACK_TO_BACK",
}
VehicleMatch_VehicleMatchType_value = map[string]int32{
"UNKNOWN": 0,
"EXCLUSIVE": 1,
"BACK_TO_BACK": 2,
"CARPOOL": 3,
"CARPOOL_BACK_TO_BACK": 4,
}
)Enum value maps for VehicleMatch_VehicleMatchType.
VehicleState_name, VehicleState_value
var (
VehicleState_name = map[int32]string{
0: "UNKNOWN_VEHICLE_STATE",
1: "OFFLINE",
2: "ONLINE",
}
VehicleState_value = map[string]int32{
"UNKNOWN_VEHICLE_STATE": 0,
"OFFLINE": 1,
"ONLINE": 2,
}
)Enum value maps for VehicleState.
LocationPowerSaveMode_name, LocationPowerSaveMode_value
var (
LocationPowerSaveMode_name = map[int32]string{
0: "UNKNOWN_LOCATION_POWER_SAVE_MODE",
1: "LOCATION_MODE_NO_CHANGE",
2: "LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF",
3: "LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF",
4: "LOCATION_MODE_FOREGROUND_ONLY",
5: "LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF",
}
LocationPowerSaveMode_value = map[string]int32{
"UNKNOWN_LOCATION_POWER_SAVE_MODE": 0,
"LOCATION_MODE_NO_CHANGE": 1,
"LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF": 2,
"LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF": 3,
"LOCATION_MODE_FOREGROUND_ONLY": 4,
"LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF": 5,
}
)Enum value maps for LocationPowerSaveMode.
BatteryStatus_name, BatteryStatus_value
var (
BatteryStatus_name = map[int32]string{
0: "UNKNOWN_BATTERY_STATUS",
1: "BATTERY_STATUS_CHARGING",
2: "BATTERY_STATUS_DISCHARGING",
3: "BATTERY_STATUS_FULL",
4: "BATTERY_STATUS_NOT_CHARGING",
5: "BATTERY_STATUS_POWER_LOW",
}
BatteryStatus_value = map[string]int32{
"UNKNOWN_BATTERY_STATUS": 0,
"BATTERY_STATUS_CHARGING": 1,
"BATTERY_STATUS_DISCHARGING": 2,
"BATTERY_STATUS_FULL": 3,
"BATTERY_STATUS_NOT_CHARGING": 4,
"BATTERY_STATUS_POWER_LOW": 5,
}
)Enum value maps for BatteryStatus.
PowerSource_name, PowerSource_value
var (
PowerSource_name = map[int32]string{
0: "UNKNOWN_POWER_SOURCE",
1: "POWER_SOURCE_AC",
2: "POWER_SOURCE_USB",
3: "POWER_SOURCE_WIRELESS",
4: "POWER_SOURCE_UNPLUGGED",
}
PowerSource_value = map[string]int32{
"UNKNOWN_POWER_SOURCE": 0,
"POWER_SOURCE_AC": 1,
"POWER_SOURCE_USB": 2,
"POWER_SOURCE_WIRELESS": 3,
"POWER_SOURCE_UNPLUGGED": 4,
}
)Enum value maps for PowerSource.
Vehicle_VehicleType_Category_name, Vehicle_VehicleType_Category_value
var (
Vehicle_VehicleType_Category_name = map[int32]string{
0: "UNKNOWN",
1: "AUTO",
2: "TAXI",
3: "TRUCK",
4: "TWO_WHEELER",
5: "BICYCLE",
6: "PEDESTRIAN",
}
Vehicle_VehicleType_Category_value = map[string]int32{
"UNKNOWN": 0,
"AUTO": 1,
"TAXI": 2,
"TRUCK": 3,
"TWO_WHEELER": 4,
"BICYCLE": 5,
"PEDESTRIAN": 6,
}
)Enum value maps for Vehicle_VehicleType_Category.
VisualTrafficReportPolylineRendering_RoadStretch_Style_name, VisualTrafficReportPolylineRendering_RoadStretch_Style_value
var (
VisualTrafficReportPolylineRendering_RoadStretch_Style_name = map[int32]string{
0: "STYLE_UNSPECIFIED",
1: "SLOWER_TRAFFIC",
2: "TRAFFIC_JAM",
}
VisualTrafficReportPolylineRendering_RoadStretch_Style_value = map[string]int32{
"STYLE_UNSPECIFIED": 0,
"SLOWER_TRAFFIC": 1,
"TRAFFIC_JAM": 2,
}
)Enum value maps for VisualTrafficReportPolylineRendering_RoadStretch_Style.
File_google_maps_fleetengine_v1_fleetengine_proto
var File_google_maps_fleetengine_v1_fleetengine_proto protoreflect.FileDescriptorFile_google_maps_fleetengine_v1_header_proto
var File_google_maps_fleetengine_v1_header_proto protoreflect.FileDescriptorFile_google_maps_fleetengine_v1_traffic_proto
var File_google_maps_fleetengine_v1_traffic_proto protoreflect.FileDescriptorFile_google_maps_fleetengine_v1_trip_api_proto
var File_google_maps_fleetengine_v1_trip_api_proto protoreflect.FileDescriptorFile_google_maps_fleetengine_v1_trips_proto
var File_google_maps_fleetengine_v1_trips_proto protoreflect.FileDescriptorFile_google_maps_fleetengine_v1_vehicle_api_proto
var File_google_maps_fleetengine_v1_vehicle_api_proto protoreflect.FileDescriptorFile_google_maps_fleetengine_v1_vehicles_proto
var File_google_maps_fleetengine_v1_vehicles_proto protoreflect.FileDescriptorTripService_ServiceDesc
var TripService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "maps.fleetengine.v1.TripService",
HandlerType: (*TripServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "CreateTrip",
Handler: _TripService_CreateTrip_Handler,
},
{
MethodName: "GetTrip",
Handler: _TripService_GetTrip_Handler,
},
{
MethodName: "DeleteTrip",
Handler: _TripService_DeleteTrip_Handler,
},
{
MethodName: "ReportBillableTrip",
Handler: _TripService_ReportBillableTrip_Handler,
},
{
MethodName: "SearchTrips",
Handler: _TripService_SearchTrips_Handler,
},
{
MethodName: "UpdateTrip",
Handler: _TripService_UpdateTrip_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/maps/fleetengine/v1/trip_api.proto",
}TripService_ServiceDesc is the grpc.ServiceDesc for TripService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
VehicleService_ServiceDesc
var VehicleService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "maps.fleetengine.v1.VehicleService",
HandlerType: (*VehicleServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "CreateVehicle",
Handler: _VehicleService_CreateVehicle_Handler,
},
{
MethodName: "GetVehicle",
Handler: _VehicleService_GetVehicle_Handler,
},
{
MethodName: "DeleteVehicle",
Handler: _VehicleService_DeleteVehicle_Handler,
},
{
MethodName: "UpdateVehicle",
Handler: _VehicleService_UpdateVehicle_Handler,
},
{
MethodName: "UpdateVehicleAttributes",
Handler: _VehicleService_UpdateVehicleAttributes_Handler,
},
{
MethodName: "ListVehicles",
Handler: _VehicleService_ListVehicles_Handler,
},
{
MethodName: "SearchVehicles",
Handler: _VehicleService_SearchVehicles_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/maps/fleetengine/v1/vehicle_api.proto",
}VehicleService_ServiceDesc is the grpc.ServiceDesc for VehicleService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions
func RegisterTripServiceServer
func RegisterTripServiceServer(s grpc.ServiceRegistrar, srv TripServiceServer)func RegisterVehicleServiceServer
func RegisterVehicleServiceServer(s grpc.ServiceRegistrar, srv VehicleServiceServer)BatteryInfo
type BatteryInfo struct {
// Status of the battery, whether full or charging etc.
BatteryStatus BatteryStatus `protobuf:"varint,1,opt,name=battery_status,json=batteryStatus,proto3,enum=maps.fleetengine.v1.BatteryStatus" json:"battery_status,omitempty"`
// Status of battery power source.
PowerSource PowerSource `protobuf:"varint,2,opt,name=power_source,json=powerSource,proto3,enum=maps.fleetengine.v1.PowerSource" json:"power_source,omitempty"`
// Current battery percentage [0-100].
BatteryPercentage float32 `protobuf:"fixed32,3,opt,name=battery_percentage,json=batteryPercentage,proto3" json:"battery_percentage,omitempty"`
// contains filtered or unexported fields
}Information about the device's battery.
func (*BatteryInfo) Descriptor
func (*BatteryInfo) Descriptor() ([]byte, []int)Deprecated: Use BatteryInfo.ProtoReflect.Descriptor instead.
func (*BatteryInfo) GetBatteryPercentage
func (x *BatteryInfo) GetBatteryPercentage() float32func (*BatteryInfo) GetBatteryStatus
func (x *BatteryInfo) GetBatteryStatus() BatteryStatusfunc (*BatteryInfo) GetPowerSource
func (x *BatteryInfo) GetPowerSource() PowerSourcefunc (*BatteryInfo) ProtoMessage
func (*BatteryInfo) ProtoMessage()func (*BatteryInfo) ProtoReflect
func (x *BatteryInfo) ProtoReflect() protoreflect.Messagefunc (*BatteryInfo) Reset
func (x *BatteryInfo) Reset()func (*BatteryInfo) String
func (x *BatteryInfo) String() stringBatteryStatus
type BatteryStatus int32Status of the battery, whether full or charging etc.
BatteryStatus_UNKNOWN_BATTERY_STATUS, BatteryStatus_BATTERY_STATUS_CHARGING, BatteryStatus_BATTERY_STATUS_DISCHARGING, BatteryStatus_BATTERY_STATUS_FULL, BatteryStatus_BATTERY_STATUS_NOT_CHARGING, BatteryStatus_BATTERY_STATUS_POWER_LOW
const (
// Battery status unknown.
BatteryStatus_UNKNOWN_BATTERY_STATUS BatteryStatus = 0
// Battery is being charged.
BatteryStatus_BATTERY_STATUS_CHARGING BatteryStatus = 1
// Battery is discharging.
BatteryStatus_BATTERY_STATUS_DISCHARGING BatteryStatus = 2
// Battery is full.
BatteryStatus_BATTERY_STATUS_FULL BatteryStatus = 3
// Battery is not charging.
BatteryStatus_BATTERY_STATUS_NOT_CHARGING BatteryStatus = 4
// Battery is low on power.
BatteryStatus_BATTERY_STATUS_POWER_LOW BatteryStatus = 5
)func (BatteryStatus) Descriptor
func (BatteryStatus) Descriptor() protoreflect.EnumDescriptorfunc (BatteryStatus) Enum
func (x BatteryStatus) Enum() *BatteryStatusfunc (BatteryStatus) EnumDescriptor
func (BatteryStatus) EnumDescriptor() ([]byte, []int)Deprecated: Use BatteryStatus.Descriptor instead.
func (BatteryStatus) Number
func (x BatteryStatus) Number() protoreflect.EnumNumberfunc (BatteryStatus) String
func (x BatteryStatus) String() stringfunc (BatteryStatus) Type
func (BatteryStatus) Type() protoreflect.EnumTypeBillingPlatformIdentifier
type BillingPlatformIdentifier int32A set of values that indicate upon which platform the request was issued.
BillingPlatformIdentifier_BILLING_PLATFORM_IDENTIFIER_UNSPECIFIED, BillingPlatformIdentifier_SERVER, BillingPlatformIdentifier_WEB, BillingPlatformIdentifier_ANDROID, BillingPlatformIdentifier_IOS, BillingPlatformIdentifier_OTHERS
const (
// Default. Used for unspecified platforms.
BillingPlatformIdentifier_BILLING_PLATFORM_IDENTIFIER_UNSPECIFIED BillingPlatformIdentifier = 0
// The platform is a client server.
BillingPlatformIdentifier_SERVER BillingPlatformIdentifier = 1
// The platform is a web browser.
BillingPlatformIdentifier_WEB BillingPlatformIdentifier = 2
// The platform is an Android mobile device.
BillingPlatformIdentifier_ANDROID BillingPlatformIdentifier = 3
// The platform is an IOS mobile device.
BillingPlatformIdentifier_IOS BillingPlatformIdentifier = 4
// Other platforms that are not listed in this enumeration.
BillingPlatformIdentifier_OTHERS BillingPlatformIdentifier = 5
)func (BillingPlatformIdentifier) Descriptor
func (BillingPlatformIdentifier) Descriptor() protoreflect.EnumDescriptorfunc (BillingPlatformIdentifier) Enum
func (x BillingPlatformIdentifier) Enum() *BillingPlatformIdentifierfunc (BillingPlatformIdentifier) EnumDescriptor
func (BillingPlatformIdentifier) EnumDescriptor() ([]byte, []int)Deprecated: Use BillingPlatformIdentifier.Descriptor instead.
func (BillingPlatformIdentifier) Number
func (x BillingPlatformIdentifier) Number() protoreflect.EnumNumberfunc (BillingPlatformIdentifier) String
func (x BillingPlatformIdentifier) String() stringfunc (BillingPlatformIdentifier) Type
func (BillingPlatformIdentifier) Type() protoreflect.EnumTypeConsumableTrafficPolyline
type ConsumableTrafficPolyline struct {
// Traffic speed along the path from the previous waypoint to the current
// waypoint.
SpeedReadingInterval []*SpeedReadingInterval `protobuf:"bytes,1,rep,name=speed_reading_interval,json=speedReadingInterval,proto3" json:"speed_reading_interval,omitempty"`
// The path the driver is taking from the previous waypoint to the current
// waypoint. This path has landmarks in it so clients can show traffic markers
// along the path (see `speed_reading_interval`). Decoding is not yet
// supported.
EncodedPathToWaypoint string `protobuf:"bytes,2,opt,name=encoded_path_to_waypoint,json=encodedPathToWaypoint,proto3" json:"encoded_path_to_waypoint,omitempty"`
// contains filtered or unexported fields
}Traffic density along a Vehicle's path.
func (*ConsumableTrafficPolyline) Descriptor
func (*ConsumableTrafficPolyline) Descriptor() ([]byte, []int)Deprecated: Use ConsumableTrafficPolyline.ProtoReflect.Descriptor instead.
func (*ConsumableTrafficPolyline) GetEncodedPathToWaypoint
func (x *ConsumableTrafficPolyline) GetEncodedPathToWaypoint() stringfunc (*ConsumableTrafficPolyline) GetSpeedReadingInterval
func (x *ConsumableTrafficPolyline) GetSpeedReadingInterval() []*SpeedReadingIntervalfunc (*ConsumableTrafficPolyline) ProtoMessage
func (*ConsumableTrafficPolyline) ProtoMessage()func (*ConsumableTrafficPolyline) ProtoReflect
func (x *ConsumableTrafficPolyline) ProtoReflect() protoreflect.Messagefunc (*ConsumableTrafficPolyline) Reset
func (x *ConsumableTrafficPolyline) Reset()func (*ConsumableTrafficPolyline) String
func (x *ConsumableTrafficPolyline) String() stringCreateTripRequest
type CreateTripRequest struct {
// The standard Fleet Engine request header.
Header *RequestHeader `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
// 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.
Parent string `protobuf:"bytes,3,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. Unique Trip ID.
// Subject to the following restrictions:
//
// * Must be a valid Unicode string.
// * Limited to a maximum length of 64 characters.
// * Normalized according to [Unicode Normalization Form C]
// (http://www.unicode.org/reports/tr15/).
// * May not contain any of the following ASCII characters: '/', ':', '?',
// ',', or '#'.
TripId string `protobuf:"bytes,5,opt,name=trip_id,json=tripId,proto3" json:"trip_id,omitempty"`
// Required. Trip entity to create.
//
// When creating a Trip, the following fields are required:
//
// * `trip_type`
// * `pickup_point`
//
// The following fields are used if you provide them:
//
// * `number_of_passengers`
// * `vehicle_id`
// * `dropoff_point`
// * `intermediate_destinations`
// * `vehicle_waypoints`
//
// All other Trip fields are ignored. For example, all trips start with a
// `trip_status` of `NEW` even if you pass in a `trip_status` of `CANCELED` in
// the creation request.
//
// Only `EXCLUSIVE` trips support `intermediate_destinations`.
//
// When `vehicle_id` is set for a shared trip, you must supply
// the list of `Trip.vehicle_waypoints` to specify the order of the remaining
// waypoints for the vehicle, otherwise the waypoint order will be
// undetermined.
//
// When you specify `Trip.vehicle_waypoints`, the list must contain all
// the remaining waypoints of the vehicle's trips, with no extra waypoints.
// You must order these waypoints such that for a given trip, the pickup
// point is before intermediate destinations, and all intermediate
// destinations come before the drop-off point. An `EXCLUSIVE` trip's
// waypoints must not interleave with any other trips.
//
// The `trip_id`, `waypoint_type` and `location` fields are used, and all
// other TripWaypoint fields in `vehicle_waypoints` are ignored.
Trip *Trip `protobuf:"bytes,4,opt,name=trip,proto3" json:"trip,omitempty"`
// contains filtered or unexported fields
}CreateTrip request message.
func (*CreateTripRequest) Descriptor
func (*CreateTripRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateTripRequest.ProtoReflect.Descriptor instead.
func (*CreateTripRequest) GetHeader
func (x *CreateTripRequest) GetHeader() *RequestHeaderfunc (*CreateTripRequest) GetParent
func (x *CreateTripRequest) GetParent() stringfunc (*CreateTripRequest) GetTrip
func (x *CreateTripRequest) GetTrip() *Tripfunc (*CreateTripRequest) GetTripId
func (x *CreateTripRequest) GetTripId() stringfunc (*CreateTripRequest) ProtoMessage
func (*CreateTripRequest) ProtoMessage()func (*CreateTripRequest) ProtoReflect
func (x *CreateTripRequest) ProtoReflect() protoreflect.Messagefunc (*CreateTripRequest) Reset
func (x *CreateTripRequest) Reset()func (*CreateTripRequest) String
func (x *CreateTripRequest) String() stringCreateVehicleRequest
type CreateVehicleRequest struct {
// The standard Fleet Engine request header.
Header *RequestHeader `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
// 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.
Parent string `protobuf:"bytes,3,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. Unique Vehicle ID.
// Subject to the following restrictions:
//
// * Must be a valid Unicode string.
// * Limited to a maximum length of 64 characters.
// * Normalized according to [Unicode Normalization Form C]
// (http://www.unicode.org/reports/tr15/).
// * May not contain any of the following ASCII characters: '/', ':', '?',
// ',', or '#'.
VehicleId string `protobuf:"bytes,4,opt,name=vehicle_id,json=vehicleId,proto3" json:"vehicle_id,omitempty"`
// Required. The Vehicle entity to create. When creating a Vehicle, the
// following fields are required:
//
// * `vehicleState`
// * `supportedTripTypes`
// * `maximumCapacity`
// * `vehicleType`
//
// When creating a Vehicle, the following fields are ignored:
//
// * `name`
// * `currentTrips`
// * `availableCapacity`
// * `current_route_segment`
// * `current_route_segment_end_point`
// * `current_route_segment_version`
// * `current_route_segment_traffic`
// * `route`
// * `waypoints`
// * `waypoints_version`
// * `remaining_distance_meters`
// * `remaining_time_seconds`
// * `eta_to_next_waypoint`
// * `navigation_status`
//
// All other fields are optional and used if provided.
Vehicle *Vehicle `protobuf:"bytes,5,opt,name=vehicle,proto3" json:"vehicle,omitempty"`
// contains filtered or unexported fields
}CreateVehicle request message.
func (*CreateVehicleRequest) Descriptor
func (*CreateVehicleRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateVehicleRequest.ProtoReflect.Descriptor instead.
func (*CreateVehicleRequest) GetHeader
func (x *CreateVehicleRequest) GetHeader() *RequestHeaderfunc (*CreateVehicleRequest) GetParent
func (x *CreateVehicleRequest) GetParent() stringfunc (*CreateVehicleRequest) GetVehicle
func (x *CreateVehicleRequest) GetVehicle() *Vehiclefunc (*CreateVehicleRequest) GetVehicleId
func (x *CreateVehicleRequest) GetVehicleId() stringfunc (*CreateVehicleRequest) ProtoMessage
func (*CreateVehicleRequest) ProtoMessage()func (*CreateVehicleRequest) ProtoReflect
func (x *CreateVehicleRequest) ProtoReflect() protoreflect.Messagefunc (*CreateVehicleRequest) Reset
func (x *CreateVehicleRequest) Reset()func (*CreateVehicleRequest) String
func (x *CreateVehicleRequest) String() stringDeleteTripRequest
type DeleteTripRequest struct {
// Optional. The standard Fleet Engine request header.
Header *RequestHeader `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
// 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.
Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}DeleteTrip request message.
func (*DeleteTripRequest) Descriptor
func (*DeleteTripRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteTripRequest.ProtoReflect.Descriptor instead.
func (*DeleteTripRequest) GetHeader
func (x *DeleteTripRequest) GetHeader() *RequestHeaderfunc (*DeleteTripRequest) GetName
func (x *DeleteTripRequest) GetName() stringfunc (*DeleteTripRequest) ProtoMessage
func (*DeleteTripRequest) ProtoMessage()func (*DeleteTripRequest) ProtoReflect
func (x *DeleteTripRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteTripRequest) Reset
func (x *DeleteTripRequest) Reset()func (*DeleteTripRequest) String
func (x *DeleteTripRequest) String() stringDeleteVehicleRequest
type DeleteVehicleRequest struct {
// Optional. The standard Fleet Engine request header.
Header *RequestHeader `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
// Required. Must be in the format
// `providers/{provider}/vehicles/{vehicle}`.
// 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.
Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}DeleteVehicle request message.
func (*DeleteVehicleRequest) Descriptor
func (*DeleteVehicleRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteVehicleRequest.ProtoReflect.Descriptor instead.
func (*DeleteVehicleRequest) GetHeader
func (x *DeleteVehicleRequest) GetHeader() *RequestHeaderfunc (*DeleteVehicleRequest) GetName
func (x *DeleteVehicleRequest) GetName() stringfunc (*DeleteVehicleRequest) ProtoMessage
func (*DeleteVehicleRequest) ProtoMessage()func (*DeleteVehicleRequest) ProtoReflect
func (x *DeleteVehicleRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteVehicleRequest) Reset
func (x *DeleteVehicleRequest) Reset()func (*DeleteVehicleRequest) String
func (x *DeleteVehicleRequest) String() stringDeviceSettings
type DeviceSettings struct {
// How location features are set to behave on the device when battery saver is
// on.
LocationPowerSaveMode LocationPowerSaveMode `protobuf:"varint,1,opt,name=location_power_save_mode,json=locationPowerSaveMode,proto3,enum=maps.fleetengine.v1.LocationPowerSaveMode" json:"location_power_save_mode,omitempty"`
// Whether the device is currently in power save mode.
IsPowerSaveMode bool `protobuf:"varint,2,opt,name=is_power_save_mode,json=isPowerSaveMode,proto3" json:"is_power_save_mode,omitempty"`
// Whether the device is in an interactive state.
IsInteractive bool `protobuf:"varint,3,opt,name=is_interactive,json=isInteractive,proto3" json:"is_interactive,omitempty"`
// Information about the battery state.
BatteryInfo *BatteryInfo `protobuf:"bytes,4,opt,name=battery_info,json=batteryInfo,proto3" json:"battery_info,omitempty"`
// contains filtered or unexported fields
}Information about various settings on the mobile device.
func (*DeviceSettings) Descriptor
func (*DeviceSettings) Descriptor() ([]byte, []int)Deprecated: Use DeviceSettings.ProtoReflect.Descriptor instead.
func (*DeviceSettings) GetBatteryInfo
func (x *DeviceSettings) GetBatteryInfo() *BatteryInfofunc (*DeviceSettings) GetIsInteractive
func (x *DeviceSettings) GetIsInteractive() boolfunc (*DeviceSettings) GetIsPowerSaveMode
func (x *DeviceSettings) GetIsPowerSaveMode() boolfunc (*DeviceSettings) GetLocationPowerSaveMode
func (x *DeviceSettings) GetLocationPowerSaveMode() LocationPowerSaveModefunc (*DeviceSettings) ProtoMessage
func (*DeviceSettings) ProtoMessage()func (*DeviceSettings) ProtoReflect
func (x *DeviceSettings) ProtoReflect() protoreflect.Messagefunc (*DeviceSettings) Reset
func (x *DeviceSettings) Reset()func (*DeviceSettings) String
func (x *DeviceSettings) String() stringGetTripRequest
type GetTripRequest struct {
// The standard Fleet Engine request header.
Header *RequestHeader `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
// 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.
Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
// The subset of Trip fields that should be returned and their interpretation.
View TripView `protobuf:"varint,11,opt,name=view,proto3,enum=maps.fleetengine.v1.TripView" json:"view,omitempty"`
// 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.
CurrentRouteSegmentVersion *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=current_route_segment_version,json=currentRouteSegmentVersion,proto3" json:"current_route_segment_version,omitempty"`
// Deprecated: `Trip.remaining_waypoints` are always retrieved. Use
// `remaining_waypoints_route_version` to control when
// `Trip.remaining_waypoints.traffic_to_waypoint` and
// `Trip.remaining_waypoints.path_to_waypoint` data are retrieved.
//
// Deprecated: Marked as deprecated in google/maps/fleetengine/v1/trip_api.proto.
RemainingWaypointsVersion *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=remaining_waypoints_version,json=remainingWaypointsVersion,proto3" json:"remaining_waypoints_version,omitempty"`
// 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`.
RouteFormatType PolylineFormatType `protobuf:"varint,8,opt,name=route_format_type,json=routeFormatType,proto3,enum=maps.fleetengine.v1.PolylineFormatType" json:"route_format_type,omitempty"`
// 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.
CurrentRouteSegmentTrafficVersion *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=current_route_segment_traffic_version,json=currentRouteSegmentTrafficVersion,proto3" json:"current_route_segment_traffic_version,omitempty"`
// 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.
RemainingWaypointsRouteVersion *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=remaining_waypoints_route_version,json=remainingWaypointsRouteVersion,proto3" json:"remaining_waypoints_route_version,omitempty"`
// contains filtered or unexported fields
}GetTrip request message.
func (*GetTripRequest) Descriptor
func (*GetTripRequest) Descriptor() ([]byte, []int)Deprecated: Use GetTripRequest.ProtoReflect.Descriptor instead.
func (*GetTripRequest) GetCurrentRouteSegmentTrafficVersion
func (x *GetTripRequest) GetCurrentRouteSegmentTrafficVersion() *timestamppb.Timestampfunc (*GetTripRequest) GetCurrentRouteSegmentVersion
func (x *GetTripRequest) GetCurrentRouteSegmentVersion() *timestamppb.Timestampfunc (*GetTripRequest) GetHeader
func (x *GetTripRequest) GetHeader() *RequestHeaderfunc (*GetTripRequest) GetName
func (x *GetTripRequest) GetName() stringfunc (*GetTripRequest) GetRemainingWaypointsRouteVersion
func (x *GetTripRequest) GetRemainingWaypointsRouteVersion() *timestamppb.Timestampfunc (*GetTripRequest) GetRemainingWaypointsVersion
func (x *GetTripRequest) GetRemainingWaypointsVersion() *timestamppb.TimestampDeprecated: Marked as deprecated in google/maps/fleetengine/v1/trip_api.proto.
func (*GetTripRequest) GetRouteFormatType
func (x *GetTripRequest) GetRouteFormatType() PolylineFormatTypefunc (*GetTripRequest) GetView
func (x *GetTripRequest) GetView() TripViewfunc (*GetTripRequest) ProtoMessage
func (*GetTripRequest) ProtoMessage()func (*GetTripRequest) ProtoReflect
func (x *GetTripRequest) ProtoReflect() protoreflect.Messagefunc (*GetTripRequest) Reset
func (x *GetTripRequest) Reset()func (*GetTripRequest) String
func (x *GetTripRequest) String() stringGetVehicleRequest
type GetVehicleRequest struct {
// The standard Fleet Engine request header.
Header *RequestHeader `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
// Required. Must be in the format
// `providers/{provider}/vehicles/{vehicle}`.
// 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.
Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
// Indicates the minimum timestamp (exclusive) for which
// `Vehicle.current_route_segment` is retrieved.
// If the route is unchanged since this timestamp, the `current_route_segment`
// field is not set in the response. If a minimum is unspecified, the
// `current_route_segment` is always retrieved.
CurrentRouteSegmentVersion *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=current_route_segment_version,json=currentRouteSegmentVersion,proto3" json:"current_route_segment_version,omitempty"`
// Indicates the minimum timestamp (exclusive) for which `Vehicle.waypoints`
// data is retrieved. If the waypoints are unchanged since this timestamp, the
// `vehicle.waypoints` data is not set in the response. If this field is
// unspecified, `vehicle.waypoints` is always retrieved.
WaypointsVersion *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=waypoints_version,json=waypointsVersion,proto3" json:"waypoints_version,omitempty"`
// contains filtered or unexported fields
}GetVehicle request message.
func (*GetVehicleRequest) Descriptor
func (*GetVehicleRequest) Descriptor() ([]byte, []int)Deprecated: Use GetVehicleRequest.ProtoReflect.Descriptor instead.
func (*GetVehicleRequest) GetCurrentRouteSegmentVersion
func (x *GetVehicleRequest) GetCurrentRouteSegmentVersion() *timestamppb.Timestampfunc (*GetVehicleRequest) GetHeader
func (x *GetVehicleRequest) GetHeader() *RequestHeaderfunc (*GetVehicleRequest) GetName
func (x *GetVehicleRequest) GetName() stringfunc (*GetVehicleRequest) GetWaypointsVersion
func (x *GetVehicleRequest) GetWaypointsVersion() *timestamppb.Timestampfunc (*GetVehicleRequest) ProtoMessage
func (*GetVehicleRequest) ProtoMessage()func (*GetVehicleRequest) ProtoReflect
func (x *GetVehicleRequest) ProtoReflect() protoreflect.Messagefunc (*GetVehicleRequest) Reset
func (x *GetVehicleRequest) Reset()func (*GetVehicleRequest) String
func (x *GetVehicleRequest) String() stringLicensePlate
type LicensePlate struct {
// Required. CLDR Country/Region Code. For example, `US` for United States,
// or `IN` for India.
CountryCode string `protobuf:"bytes,1,opt,name=country_code,json=countryCode,proto3" json:"country_code,omitempty"`
// The last digit of the license plate or "-1" to denote no numeric value
// is present in the license plate.
//
// * "ABC 1234" -> "4"
// * "AB 123 CD" -> "3"
// * "ABCDEF" -> "-1"
LastCharacter string `protobuf:"bytes,2,opt,name=last_character,json=lastCharacter,proto3" json:"last_character,omitempty"`
// contains filtered or unexported fields
}The license plate information of the Vehicle. To avoid storing personally-identifiable information, only the minimum information about the license plate is stored as part of the entity.
func (*LicensePlate) Descriptor
func (*LicensePlate) Descriptor() ([]byte, []int)Deprecated: Use LicensePlate.ProtoReflect.Descriptor instead.
func (*LicensePlate) GetCountryCode
func (x *LicensePlate) GetCountryCode() stringfunc (*LicensePlate) GetLastCharacter
func (x *LicensePlate) GetLastCharacter() stringfunc (*LicensePlate) ProtoMessage
func (*LicensePlate) ProtoMessage()func (*LicensePlate) ProtoReflect
func (x *LicensePlate) ProtoReflect() protoreflect.Messagefunc (*LicensePlate) Reset
func (x *LicensePlate) Reset()func (*LicensePlate) String
func (x *LicensePlate) String() stringListVehiclesRequest
type ListVehiclesRequest struct {
// The standard Fleet Engine request header.
Header *RequestHeader `protobuf:"bytes,12,opt,name=header,proto3" json:"header,omitempty"`
// 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.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The maximum number of vehicles to return.
// Default value: 100.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// The value of the `next_page_token` provided by a previous call to
// `ListVehicles` so that you can paginate through groups of vehicles. The
// value is undefined if the filter criteria of the request is not the same as
// the filter criteria for the previous call to `ListVehicles`.
PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Specifies the required minimum capacity of the vehicle. All vehicles
// returned will have a `maximum_capacity` greater than or equal to this
// value. If set, must be greater or equal to 0.
MinimumCapacity *wrapperspb.Int32Value `protobuf:"bytes,6,opt,name=minimum_capacity,json=minimumCapacity,proto3" json:"minimum_capacity,omitempty"`
// Restricts the response to vehicles that support at least one of the
// specified trip types.
TripTypes []TripType `protobuf:"varint,7,rep,packed,name=trip_types,json=tripTypes,proto3,enum=maps.fleetengine.v1.TripType" json:"trip_types,omitempty"`
// Restricts the response to vehicles that have sent location updates to Fleet
// Engine within the specified duration. Stationary vehicles still
// transmitting their locations are not considered stale. If present, must be
// a valid positive duration.
MaximumStaleness *durationpb.Duration `protobuf:"bytes,8,opt,name=maximum_staleness,json=maximumStaleness,proto3" json:"maximum_staleness,omitempty"`
// Required. Restricts the response to vehicles with one of the specified type
// categories. `UNKNOWN` is not allowed.
VehicleTypeCategories []Vehicle_VehicleType_Category `protobuf:"varint,9,rep,packed,name=vehicle_type_categories,json=vehicleTypeCategories,proto3,enum=maps.fleetengine.v1.Vehicle_VehicleType_Category" json:"vehicle_type_categories,omitempty"`
// Callers can form complex logical operations using any combination of the
// `required_attributes`, `required_one_of_attributes`, and
// `required_one_of_attribute_sets` fields.
//
// `required_attributes` is a list; `required_one_of_attributes` uses a
// message which allows a list of lists. In combination, the two fields allow
// the composition of this expression:
//
// ```
// (required_attributes[0] AND required_attributes[1] AND ...)
// AND
// (required_one_of_attributes[0][0] OR required_one_of_attributes[0][1] OR
// ...)
// AND
// (required_one_of_attributes[1][0] OR required_one_of_attributes[1][1] OR
// ...)
// ```
//
// Restricts the response to vehicles with the specified attributes. This
// field is a conjunction/AND operation. A max of 50 required_attributes is
// allowed. This matches the maximum number of attributes allowed on a
// vehicle. Each repeated string should be of the format "key:value".
RequiredAttributes []string `protobuf:"bytes,10,rep,name=required_attributes,json=requiredAttributes,proto3" json:"required_attributes,omitempty"`
// Restricts the response to vehicles with at least one of the specified
// attributes in each `VehicleAttributeList`. Within each list, a vehicle must
// match at least one of the attributes. This field is an inclusive
// disjunction/OR operation in each `VehicleAttributeList` and a
// conjunction/AND operation across the collection of `VehicleAttributeList`.
// Each repeated string should be of the format
// "key1:value1|key2:value2|key3:value3".
RequiredOneOfAttributes []string `protobuf:"bytes,13,rep,name=required_one_of_attributes,json=requiredOneOfAttributes,proto3" json:"required_one_of_attributes,omitempty"`
// `required_one_of_attribute_sets` provides additional functionality.
//
// Similar to `required_one_of_attributes`, `required_one_of_attribute_sets`
// uses a message which allows a list of lists, allowing expressions such as
// this one:
//
// ```
// (required_attributes[0] AND required_attributes[1] AND ...)
// AND
// (
//
// (required_one_of_attribute_sets[0][0] AND
// required_one_of_attribute_sets[0][1] AND
// ...)
// OR
// (required_one_of_attribute_sets[1][0] AND
// required_one_of_attribute_sets[1][1] AND
// ...)
//
// )
// ```
//
// Restricts the response to vehicles that match all the attributes in a
// `VehicleAttributeList`. Within each list, a vehicle must match all of the
// attributes. This field is a conjunction/AND operation in each
// `VehicleAttributeList` and inclusive disjunction/OR operation across the
// collection of `VehicleAttributeList`. Each repeated string should be of the
// format "key1:value1|key2:value2|key3:value3".
RequiredOneOfAttributeSets []string `protobuf:"bytes,15,rep,name=required_one_of_attribute_sets,json=requiredOneOfAttributeSets,proto3" json:"required_one_of_attribute_sets,omitempty"`
// Restricts the response to vehicles that have this vehicle state.
VehicleState VehicleState `protobuf:"varint,11,opt,name=vehicle_state,json=vehicleState,proto3,enum=maps.fleetengine.v1.VehicleState" json:"vehicle_state,omitempty"`
// Only return the vehicles with current trip(s).
OnTripOnly bool `protobuf:"varint,14,opt,name=on_trip_only,json=onTripOnly,proto3" json:"on_trip_only,omitempty"`
// Optional. A filter query to apply when listing vehicles. See
// http://aip.dev/160 for examples of the filter syntax.
//
// This field is designed to replace the `required_attributes`,
// `required_one_of_attributes`, and `required_one_of_attributes_sets` fields.
// If a non-empty value is specified here, the following fields must be empty:
// `required_attributes`, `required_one_of_attributes`, and
// `required_one_of_attributes_sets`.
//
// This filter functions as an AND clause with other constraints,
// such as `vehicle_state` or `on_trip_only`.
//
// Note that the only queries supported are on vehicle attributes (for
// example, `attributes.ListVehicles request message.
func (*ListVehiclesRequest) Descriptor
func (*ListVehiclesRequest) Descriptor() ([]byte, []int)Deprecated: Use ListVehiclesRequest.ProtoReflect.Descriptor instead.
func (*ListVehiclesRequest) GetFilter
func (x *ListVehiclesRequest) GetFilter() stringfunc (*ListVehiclesRequest) GetHeader
func (x *ListVehiclesRequest) GetHeader() *RequestHeaderfunc (*ListVehiclesRequest) GetMaximumStaleness
func (x *ListVehiclesRequest) GetMaximumStaleness() *durationpb.Durationfunc (*ListVehiclesRequest) GetMinimumCapacity
func (x *ListVehiclesRequest) GetMinimumCapacity() *wrapperspb.Int32Valuefunc (*ListVehiclesRequest) GetOnTripOnly
func (x *ListVehiclesRequest) GetOnTripOnly() boolfunc (*ListVehiclesRequest) GetPageSize
func (x *ListVehiclesRequest) GetPageSize() int32func (*ListVehiclesRequest) GetPageToken
func (x *ListVehiclesRequest) GetPageToken() stringfunc (*ListVehiclesRequest) GetParent
func (x *ListVehiclesRequest) GetParent() stringfunc (*ListVehiclesRequest) GetRequiredAttributes
func (x *ListVehiclesRequest) GetRequiredAttributes() []stringfunc (*ListVehiclesRequest) GetRequiredOneOfAttributeSets
func (x *ListVehiclesRequest) GetRequiredOneOfAttributeSets() []stringfunc (*ListVehiclesRequest) GetRequiredOneOfAttributes
func (x *ListVehiclesRequest) GetRequiredOneOfAttributes() []stringfunc (*ListVehiclesRequest) GetTripTypes
func (x *ListVehiclesRequest) GetTripTypes() []TripTypefunc (*ListVehiclesRequest) GetVehicleState
func (x *ListVehiclesRequest) GetVehicleState() VehicleStatefunc (*ListVehiclesRequest) GetVehicleTypeCategories
func (x *ListVehiclesRequest) GetVehicleTypeCategories() []Vehicle_VehicleType_Categoryfunc (*ListVehiclesRequest) GetViewport
func (x *ListVehiclesRequest) GetViewport() *viewport.Viewportfunc (*ListVehiclesRequest) ProtoMessage
func (*ListVehiclesRequest) ProtoMessage()func (*ListVehiclesRequest) ProtoReflect
func (x *ListVehiclesRequest) ProtoReflect() protoreflect.Messagefunc (*ListVehiclesRequest) Reset
func (x *ListVehiclesRequest) Reset()func (*ListVehiclesRequest) String
func (x *ListVehiclesRequest) String() stringListVehiclesResponse
type ListVehiclesResponse struct {
// Vehicles matching the criteria in the request.
// The maximum number of vehicles returned is determined by the `page_size`
// field in the request.
Vehicles []*Vehicle `protobuf:"bytes,1,rep,name=vehicles,proto3" json:"vehicles,omitempty"`
// Token to retrieve the next page of vehicles, or empty if there are no
// more vehicles that meet the request criteria.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// Required. Total number of vehicles matching the request criteria across all
// pages.
TotalSize int64 `protobuf:"varint,3,opt,name=total_size,json=totalSize,proto3" json:"total_size,omitempty"`
// contains filtered or unexported fields
}ListVehicles response message.
func (*ListVehiclesResponse) Descriptor
func (*ListVehiclesResponse) Descriptor() ([]byte, []int)Deprecated: Use ListVehiclesResponse.ProtoReflect.Descriptor instead.
func (*ListVehiclesResponse) GetNextPageToken
func (x *ListVehiclesResponse) GetNextPageToken() stringfunc (*ListVehiclesResponse) GetTotalSize
func (x *ListVehiclesResponse) GetTotalSize() int64func (*ListVehiclesResponse) GetVehicles
func (x *ListVehiclesResponse) GetVehicles() []*Vehiclefunc (*ListVehiclesResponse) ProtoMessage
func (*ListVehiclesResponse) ProtoMessage()func (*ListVehiclesResponse) ProtoReflect
func (x *ListVehiclesResponse) ProtoReflect() protoreflect.Messagefunc (*ListVehiclesResponse) Reset
func (x *ListVehiclesResponse) Reset()func (*ListVehiclesResponse) String
func (x *ListVehiclesResponse) String() stringLocationPowerSaveMode
type LocationPowerSaveMode int32How location features are configured to behave on the mobile device when the devices "battery saver" feature is on. (https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())
LocationPowerSaveMode_UNKNOWN_LOCATION_POWER_SAVE_MODE, LocationPowerSaveMode_LOCATION_MODE_NO_CHANGE, LocationPowerSaveMode_LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF, LocationPowerSaveMode_LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF, LocationPowerSaveMode_LOCATION_MODE_FOREGROUND_ONLY, LocationPowerSaveMode_LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF
const (
// Undefined LocationPowerSaveMode
LocationPowerSaveMode_UNKNOWN_LOCATION_POWER_SAVE_MODE LocationPowerSaveMode = 0
// Either the location providers shouldn't be affected by battery saver, or
// battery saver is off.
LocationPowerSaveMode_LOCATION_MODE_NO_CHANGE LocationPowerSaveMode = 1
// The GPS based location provider should be disabled when battery saver is on
// and the device is non-interactive.
LocationPowerSaveMode_LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF LocationPowerSaveMode = 2
// All location providers should be disabled when battery saver is on and the
// device is non-interactive.
LocationPowerSaveMode_LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF LocationPowerSaveMode = 3
// All the location providers will be kept available, but location fixes
// should only be provided to foreground apps.
LocationPowerSaveMode_LOCATION_MODE_FOREGROUND_ONLY LocationPowerSaveMode = 4
// Location will not be turned off, but LocationManager will throttle all
// requests to providers when the device is non-interactive.
LocationPowerSaveMode_LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF LocationPowerSaveMode = 5
)func (LocationPowerSaveMode) Descriptor
func (LocationPowerSaveMode) Descriptor() protoreflect.EnumDescriptorfunc (LocationPowerSaveMode) Enum
func (x LocationPowerSaveMode) Enum() *LocationPowerSaveModefunc (LocationPowerSaveMode) EnumDescriptor
func (LocationPowerSaveMode) EnumDescriptor() ([]byte, []int)Deprecated: Use LocationPowerSaveMode.Descriptor instead.
func (LocationPowerSaveMode) Number
func (x LocationPowerSaveMode) Number() protoreflect.EnumNumberfunc (LocationPowerSaveMode) String
func (x LocationPowerSaveMode) String() stringfunc (LocationPowerSaveMode) Type
func (LocationPowerSaveMode) Type() protoreflect.EnumTypeLocationSensor
type LocationSensor int32The sensor or methodology used to determine the location.
LocationSensor_UNKNOWN_SENSOR, LocationSensor_GPS, LocationSensor_NETWORK, LocationSensor_PASSIVE, LocationSensor_ROAD_SNAPPED_LOCATION_PROVIDER, LocationSensor_CUSTOMER_SUPPLIED_LOCATION, LocationSensor_FLEET_ENGINE_LOCATION, LocationSensor_FUSED_LOCATION_PROVIDER, LocationSensor_CORE_LOCATION
const (
// The sensor is unspecified or unknown.
LocationSensor_UNKNOWN_SENSOR LocationSensor = 0
// GPS or Assisted GPS.
LocationSensor_GPS LocationSensor = 1
// Assisted GPS, cell tower ID, or WiFi access point.
LocationSensor_NETWORK LocationSensor = 2
// Cell tower ID or WiFi access point.
LocationSensor_PASSIVE LocationSensor = 3
// A location determined by the mobile device to be the most likely
// road position.
LocationSensor_ROAD_SNAPPED_LOCATION_PROVIDER LocationSensor = 4
// A customer-supplied location from an independent source. Typically, this
// value is used for a location provided from sources other than the mobile
// device running Driver SDK. If the original source is described by one of
// the other enum values, use that value. Locations marked
// CUSTOMER_SUPPLIED_LOCATION are typically provided via a Vehicle's
// `last_location.supplemental_location_sensor`.
LocationSensor_CUSTOMER_SUPPLIED_LOCATION LocationSensor = 5
// A location calculated by Fleet Engine based on the signals available to it.
// Output only. This value will be rejected if it is received in a request.
LocationSensor_FLEET_ENGINE_LOCATION LocationSensor = 6
// Android's Fused Location Provider.
LocationSensor_FUSED_LOCATION_PROVIDER LocationSensor = 100
// The location provider on Apple operating systems.
LocationSensor_CORE_LOCATION LocationSensor = 200
)func (LocationSensor) Descriptor
func (LocationSensor) Descriptor() protoreflect.EnumDescriptorfunc (LocationSensor) Enum
func (x LocationSensor) Enum() *LocationSensorfunc (LocationSensor) EnumDescriptor
func (LocationSensor) EnumDescriptor() ([]byte, []int)Deprecated: Use LocationSensor.Descriptor instead.
func (LocationSensor) Number
func (x LocationSensor) Number() protoreflect.EnumNumberfunc (LocationSensor) String
func (x LocationSensor) String() stringfunc (LocationSensor) Type
func (LocationSensor) Type() protoreflect.EnumTypeNavigationStatus
type NavigationStatus int32The vehicle's navigation status.
NavigationStatus_UNKNOWN_NAVIGATION_STATUS, NavigationStatus_NO_GUIDANCE, NavigationStatus_ENROUTE_TO_DESTINATION, NavigationStatus_OFF_ROUTE, NavigationStatus_ARRIVED_AT_DESTINATION
const (
// Unspecified navigation status.
NavigationStatus_UNKNOWN_NAVIGATION_STATUS NavigationStatus = 0
// The Driver app's navigation is in `FREE_NAV` mode.
NavigationStatus_NO_GUIDANCE NavigationStatus = 1
// Turn-by-turn navigation is available and the Driver app navigation has
// entered `GUIDED_NAV` mode.
NavigationStatus_ENROUTE_TO_DESTINATION NavigationStatus = 2
// The vehicle has gone off the suggested route.
NavigationStatus_OFF_ROUTE NavigationStatus = 3
// The vehicle is within approximately 50m of the destination.
NavigationStatus_ARRIVED_AT_DESTINATION NavigationStatus = 4
)func (NavigationStatus) Descriptor
func (NavigationStatus) Descriptor() protoreflect.EnumDescriptorfunc (NavigationStatus) Enum
func (x NavigationStatus) Enum() *NavigationStatusfunc (NavigationStatus) EnumDescriptor
func (NavigationStatus) EnumDescriptor() ([]byte, []int)Deprecated: Use NavigationStatus.Descriptor instead.
func (NavigationStatus) Number
func (x NavigationStatus) Number() protoreflect.EnumNumberfunc (NavigationStatus) String
func (x NavigationStatus) String() stringfunc (NavigationStatus) Type
func (NavigationStatus) Type() protoreflect.EnumTypePolylineFormatType
type PolylineFormatType int32The type of polyline format.
PolylineFormatType_UNKNOWN_FORMAT_TYPE, PolylineFormatType_LAT_LNG_LIST_TYPE, PolylineFormatType_ENCODED_POLYLINE_TYPE
const (
// The format is unspecified or unknown.
PolylineFormatType_UNKNOWN_FORMAT_TYPE PolylineFormatType = 0
// A list of `google.type.LatLng`.
PolylineFormatType_LAT_LNG_LIST_TYPE PolylineFormatType = 1
// A polyline encoded with a polyline compression algorithm. Decoding is not
// yet supported.
PolylineFormatType_ENCODED_POLYLINE_TYPE PolylineFormatType = 2
)func (PolylineFormatType) Descriptor
func (PolylineFormatType) Descriptor() protoreflect.EnumDescriptorfunc (PolylineFormatType) Enum
func (x PolylineFormatType) Enum() *PolylineFormatTypefunc (PolylineFormatType) EnumDescriptor
func (PolylineFormatType) EnumDescriptor() ([]byte, []int)Deprecated: Use PolylineFormatType.Descriptor instead.
func (PolylineFormatType) Number
func (x PolylineFormatType) Number() protoreflect.EnumNumberfunc (PolylineFormatType) String
func (x PolylineFormatType) String() stringfunc (PolylineFormatType) Type
func (PolylineFormatType) Type() protoreflect.EnumTypePowerSource
type PowerSource int32Type of the charger being used to charge the battery.
PowerSource_UNKNOWN_POWER_SOURCE, PowerSource_POWER_SOURCE_AC, PowerSource_POWER_SOURCE_USB, PowerSource_POWER_SOURCE_WIRELESS, PowerSource_POWER_SOURCE_UNPLUGGED
const (
// Power source unknown.
PowerSource_UNKNOWN_POWER_SOURCE PowerSource = 0
// Power source is an AC charger.
PowerSource_POWER_SOURCE_AC PowerSource = 1
// Power source is a USB port.
PowerSource_POWER_SOURCE_USB PowerSource = 2
// Power source is wireless.
PowerSource_POWER_SOURCE_WIRELESS PowerSource = 3
// Battery is unplugged.
PowerSource_POWER_SOURCE_UNPLUGGED PowerSource = 4
)func (PowerSource) Descriptor
func (PowerSource) Descriptor() protoreflect.EnumDescriptorfunc (PowerSource) Enum
func (x PowerSource) Enum() *PowerSourcefunc (PowerSource) EnumDescriptor
func (PowerSource) EnumDescriptor() ([]byte, []int)Deprecated: Use PowerSource.Descriptor instead.
func (PowerSource) Number
func (x PowerSource) Number() protoreflect.EnumNumberfunc (PowerSource) String
func (x PowerSource) String() stringfunc (PowerSource) Type
func (PowerSource) Type() protoreflect.EnumTypeReportBillableTripRequest
type ReportBillableTripRequest struct {
// Required. Must be in the format
// `providers/{provider}/billableTrips/{billable_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.
Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
// Required. Two letter country code of the country where the trip takes
// place. Price is defined according to country code.
CountryCode string `protobuf:"bytes,3,opt,name=country_code,json=countryCode,proto3" json:"country_code,omitempty"`
// The platform upon which the request was issued.
Platform BillingPlatformIdentifier `protobuf:"varint,5,opt,name=platform,proto3,enum=maps.fleetengine.v1.BillingPlatformIdentifier" json:"platform,omitempty"`
// The identifiers that are directly related to the trip being reported. These
// are usually IDs (for example, session IDs) of pre-booking operations done
// before the trip ID is available. The number of `related_ids` is
// limited to 50.
RelatedIds []string `protobuf:"bytes,6,rep,name=related_ids,json=relatedIds,proto3" json:"related_ids,omitempty"`
// The type of GMP product solution (for example,
// `ON_DEMAND_RIDESHARING_AND_DELIVERIES`) used for the reported trip.
SolutionType ReportBillableTripRequest_SolutionType `protobuf:"varint,7,opt,name=solution_type,json=solutionType,proto3,enum=maps.fleetengine.v1.ReportBillableTripRequest_SolutionType" json:"solution_type,omitempty"`
// contains filtered or unexported fields
}ReportBillableTrip request message.
func (*ReportBillableTripRequest) Descriptor
func (*ReportBillableTripRequest) Descriptor() ([]byte, []int)Deprecated: Use ReportBillableTripRequest.ProtoReflect.Descriptor instead.
func (*ReportBillableTripRequest) GetCountryCode
func (x *ReportBillableTripRequest) GetCountryCode() stringfunc (*ReportBillableTripRequest) GetName
func (x *ReportBillableTripRequest) GetName() stringfunc (*ReportBillableTripRequest) GetPlatform
func (x *ReportBillableTripRequest) GetPlatform() BillingPlatformIdentifierfunc (*ReportBillableTripRequest) GetRelatedIds
func (x *ReportBillableTripRequest) GetRelatedIds() []stringfunc (*ReportBillableTripRequest) GetSolutionType
func (x *ReportBillableTripRequest) GetSolutionType() ReportBillableTripRequest_SolutionTypefunc (*ReportBillableTripRequest) ProtoMessage
func (*ReportBillableTripRequest) ProtoMessage()func (*ReportBillableTripRequest) ProtoReflect
func (x *ReportBillableTripRequest) ProtoReflect() protoreflect.Messagefunc (*ReportBillableTripRequest) Reset
func (x *ReportBillableTripRequest) Reset()func (*ReportBillableTripRequest) String
func (x *ReportBillableTripRequest) String() stringReportBillableTripRequest_SolutionType
type ReportBillableTripRequest_SolutionType int32Selector for different solution types of a reported trip.
ReportBillableTripRequest_SOLUTION_TYPE_UNSPECIFIED, ReportBillableTripRequest_ON_DEMAND_RIDESHARING_AND_DELIVERIES
const (
// The default value. For backwards-compatibility, the API will use
// `ON_DEMAND_RIDESHARING_AND_DELIVERIES` by default which is the first
// supported solution type.
ReportBillableTripRequest_SOLUTION_TYPE_UNSPECIFIED ReportBillableTripRequest_SolutionType = 0
// The solution is an on-demand ridesharing and deliveries trip.
ReportBillableTripRequest_ON_DEMAND_RIDESHARING_AND_DELIVERIES ReportBillableTripRequest_SolutionType = 1
)func (ReportBillableTripRequest_SolutionType) Descriptor
func (ReportBillableTripRequest_SolutionType) Descriptor() protoreflect.EnumDescriptorfunc (ReportBillableTripRequest_SolutionType) Enum
func (ReportBillableTripRequest_SolutionType) EnumDescriptor
func (ReportBillableTripRequest_SolutionType) EnumDescriptor() ([]byte, []int)Deprecated: Use ReportBillableTripRequest_SolutionType.Descriptor instead.
func (ReportBillableTripRequest_SolutionType) Number
func (x ReportBillableTripRequest_SolutionType) Number() protoreflect.EnumNumberfunc (ReportBillableTripRequest_SolutionType) String
func (x ReportBillableTripRequest_SolutionType) String() stringfunc (ReportBillableTripRequest_SolutionType) Type
func (ReportBillableTripRequest_SolutionType) Type() protoreflect.EnumTypeRequestHeader
type RequestHeader struct {
// The BCP-47 language code, such as en-US or sr-Latn. For more information,
// see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If none
// is specified, the response may be in any language, with a preference for
// English if such a name exists. Field value example: `en-US`.
LanguageCode string `protobuf:"bytes,1,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
// Required. CLDR region code of the region where the request originates.
// Field value example: `US`.
RegionCode string `protobuf:"bytes,2,opt,name=region_code,json=regionCode,proto3" json:"region_code,omitempty"`
// Version of the calling SDK, if applicable.
// The version format is "major.minor.patch", example: `1.1.2`.
SdkVersion string `protobuf:"bytes,3,opt,name=sdk_version,json=sdkVersion,proto3" json:"sdk_version,omitempty"`
// Version of the operating system on which the calling SDK is running.
// Field value examples: `4.4.1`, `12.1`.
OsVersion string `protobuf:"bytes,4,opt,name=os_version,json=osVersion,proto3" json:"os_version,omitempty"`
// Model of the device on which the calling SDK is running.
// Field value examples: `iPhone12,1`, `SM-G920F`.
DeviceModel string `protobuf:"bytes,5,opt,name=device_model,json=deviceModel,proto3" json:"device_model,omitempty"`
// The type of SDK sending the request.
SdkType RequestHeader_SdkType `protobuf:"varint,6,opt,name=sdk_type,json=sdkType,proto3,enum=maps.fleetengine.v1.RequestHeader_SdkType" json:"sdk_type,omitempty"`
// Version of the MapSDK which the calling SDK depends on, if applicable.
// The version format is "major.minor.patch", example: `5.2.1`.
MapsSdkVersion string `protobuf:"bytes,7,opt,name=maps_sdk_version,json=mapsSdkVersion,proto3" json:"maps_sdk_version,omitempty"`
// Version of the NavSDK which the calling SDK depends on, if applicable.
// The version format is "major.minor.patch", example: `2.1.0`.
NavSdkVersion string `protobuf:"bytes,8,opt,name=nav_sdk_version,json=navSdkVersion,proto3" json:"nav_sdk_version,omitempty"`
// Platform of the calling SDK.
Platform RequestHeader_Platform `protobuf:"varint,9,opt,name=platform,proto3,enum=maps.fleetengine.v1.RequestHeader_Platform" json:"platform,omitempty"`
// Manufacturer of the Android device from the calling SDK, only applicable
// for the Android SDKs.
// Field value example: `Samsung`.
Manufacturer string `protobuf:"bytes,10,opt,name=manufacturer,proto3" json:"manufacturer,omitempty"`
// Android API level of the calling SDK, only applicable for the Android SDKs.
// Field value example: `23`.
AndroidApiLevel int32 `protobuf:"varint,11,opt,name=android_api_level,json=androidApiLevel,proto3" json:"android_api_level,omitempty"`
// Optional ID that can be provided for logging purposes in order to identify
// the request.
TraceId string `protobuf:"bytes,12,opt,name=trace_id,json=traceId,proto3" json:"trace_id,omitempty"`
// contains filtered or unexported fields
}A RequestHeader contains fields common to all Fleet Engine RPC requests.
func (*RequestHeader) Descriptor
func (*RequestHeader) Descriptor() ([]byte, []int)Deprecated: Use RequestHeader.ProtoReflect.Descriptor instead.
func (*RequestHeader) GetAndroidApiLevel
func (x *RequestHeader) GetAndroidApiLevel() int32func (*RequestHeader) GetDeviceModel
func (x *RequestHeader) GetDeviceModel() stringfunc (*RequestHeader) GetLanguageCode
func (x *RequestHeader) GetLanguageCode() stringfunc (*RequestHeader) GetManufacturer
func (x *RequestHeader) GetManufacturer() stringfunc (*RequestHeader) GetMapsSdkVersion
func (x *RequestHeader) GetMapsSdkVersion() stringfunc (*RequestHeader) GetNavSdkVersion
func (x *RequestHeader) GetNavSdkVersion() stringfunc (*RequestHeader) GetOsVersion
func (x *RequestHeader) GetOsVersion() stringfunc (*RequestHeader) GetPlatform
func (x *RequestHeader) GetPlatform() RequestHeader_Platformfunc (*RequestHeader) GetRegionCode
func (x *RequestHeader) GetRegionCode() stringfunc (*RequestHeader) GetSdkType
func (x *RequestHeader) GetSdkType() RequestHeader_SdkTypefunc (*RequestHeader) GetSdkVersion
func (x *RequestHeader) GetSdkVersion() stringfunc (*RequestHeader) GetTraceId
func (x *RequestHeader) GetTraceId() stringfunc (*RequestHeader) ProtoMessage
func (*RequestHeader) ProtoMessage()func (*RequestHeader) ProtoReflect
func (x *RequestHeader) ProtoReflect() protoreflect.Messagefunc (*RequestHeader) Reset
func (x *RequestHeader) Reset()func (*RequestHeader) String
func (x *RequestHeader) String() stringRequestHeader_Platform
type RequestHeader_Platform int32The platform of the calling SDK.
RequestHeader_PLATFORM_UNSPECIFIED, RequestHeader_ANDROID, RequestHeader_IOS, RequestHeader_WEB
const (
// The default value. This value is used if the platform is omitted.
RequestHeader_PLATFORM_UNSPECIFIED RequestHeader_Platform = 0
// The request is coming from Android.
RequestHeader_ANDROID RequestHeader_Platform = 1
// The request is coming from iOS.
RequestHeader_IOS RequestHeader_Platform = 2
// The request is coming from the web.
RequestHeader_WEB RequestHeader_Platform = 3
)func (RequestHeader_Platform) Descriptor
func (RequestHeader_Platform) Descriptor() protoreflect.EnumDescriptorfunc (RequestHeader_Platform) Enum
func (x RequestHeader_Platform) Enum() *RequestHeader_Platformfunc (RequestHeader_Platform) EnumDescriptor
func (RequestHeader_Platform) EnumDescriptor() ([]byte, []int)Deprecated: Use RequestHeader_Platform.Descriptor instead.
func (RequestHeader_Platform) Number
func (x RequestHeader_Platform) Number() protoreflect.EnumNumberfunc (RequestHeader_Platform) String
func (x RequestHeader_Platform) String() stringfunc (RequestHeader_Platform) Type
func (RequestHeader_Platform) Type() protoreflect.EnumTypeRequestHeader_SdkType
type RequestHeader_SdkType int32Possible types of SDK.
RequestHeader_SDK_TYPE_UNSPECIFIED, RequestHeader_CONSUMER, RequestHeader_DRIVER, RequestHeader_JAVASCRIPT
const (
// The default value. This value is used if the `sdk_type` is omitted.
RequestHeader_SDK_TYPE_UNSPECIFIED RequestHeader_SdkType = 0
// The calling SDK is Consumer.
RequestHeader_CONSUMER RequestHeader_SdkType = 1
// The calling SDK is Driver.
RequestHeader_DRIVER RequestHeader_SdkType = 2
// The calling SDK is JavaScript.
RequestHeader_JAVASCRIPT RequestHeader_SdkType = 3
)func (RequestHeader_SdkType) Descriptor
func (RequestHeader_SdkType) Descriptor() protoreflect.EnumDescriptorfunc (RequestHeader_SdkType) Enum
func (x RequestHeader_SdkType) Enum() *RequestHeader_SdkTypefunc (RequestHeader_SdkType) EnumDescriptor
func (RequestHeader_SdkType) EnumDescriptor() ([]byte, []int)Deprecated: Use RequestHeader_SdkType.Descriptor instead.
func (RequestHeader_SdkType) Number
func (x RequestHeader_SdkType) Number() protoreflect.EnumNumberfunc (RequestHeader_SdkType) String
func (x RequestHeader_SdkType) String() stringfunc (RequestHeader_SdkType) Type
func (RequestHeader_SdkType) Type() protoreflect.EnumTypeSearchTripsRequest
type SearchTripsRequest struct {
// The standard Fleet Engine request header.
Header *RequestHeader `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
// 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.
Parent string `protobuf:"bytes,3,opt,name=parent,proto3" json:"parent,omitempty"`
// 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`
VehicleId string `protobuf:"bytes,4,opt,name=vehicle_id,json=vehicleId,proto3" json:"vehicle_id,omitempty"`
// If set to true, the response includes Trips that influence a driver's
// route.
ActiveTripsOnly bool `protobuf:"varint,5,opt,name=active_trips_only,json=activeTripsOnly,proto3" json:"active_trips_only,omitempty"`
// If not set, the server decides the number of results to return.
PageSize int32 `protobuf:"varint,6,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Set this to a value previously returned in the `SearchTripsResponse` to
// continue from previous results.
PageToken string `protobuf:"bytes,7,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// If specified, returns the trips that have not been updated after the time
// `(current - minimum_staleness)`.
MinimumStaleness *durationpb.Duration `protobuf:"bytes,8,opt,name=minimum_staleness,json=minimumStaleness,proto3" json:"minimum_staleness,omitempty"`
// contains filtered or unexported fields
}SearchTrips request message.
func (*SearchTripsRequest) Descriptor
func (*SearchTripsRequest) Descriptor() ([]byte, []int)Deprecated: Use SearchTripsRequest.ProtoReflect.Descriptor instead.
func (*SearchTripsRequest) GetActiveTripsOnly
func (x *SearchTripsRequest) GetActiveTripsOnly() boolfunc (*SearchTripsRequest) GetHeader
func (x *SearchTripsRequest) GetHeader() *RequestHeaderfunc (*SearchTripsRequest) GetMinimumStaleness
func (x *SearchTripsRequest) GetMinimumStaleness() *durationpb.Durationfunc (*SearchTripsRequest) GetPageSize
func (x *SearchTripsRequest) GetPageSize() int32func (*SearchTripsRequest) GetPageToken
func (x *SearchTripsRequest) GetPageToken() stringfunc (*SearchTripsRequest) GetParent
func (x *SearchTripsRequest) GetParent() stringfunc (*SearchTripsRequest) GetVehicleId
func (x *SearchTripsRequest) GetVehicleId() stringfunc (*SearchTripsRequest) ProtoMessage
func (*SearchTripsRequest) ProtoMessage()func (*SearchTripsRequest) ProtoReflect
func (x *SearchTripsRequest) ProtoReflect() protoreflect.Messagefunc (*SearchTripsRequest) Reset
func (x *SearchTripsRequest) Reset()func (*SearchTripsRequest) String
func (x *SearchTripsRequest) String() stringSearchTripsResponse
type SearchTripsResponse struct {
// The list of trips for the requested vehicle.
Trips []*Trip `protobuf:"bytes,1,rep,name=trips,proto3" json:"trips,omitempty"`
// Pass this token in the SearchTripsRequest to page through list results. The
// API returns a trip list on each call, and when no more results remain the
// trip list is empty.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}SearchTrips response message.
func (*SearchTripsResponse) Descriptor
func (*SearchTripsResponse) Descriptor() ([]byte, []int)Deprecated: Use SearchTripsResponse.ProtoReflect.Descriptor instead.
func (*SearchTripsResponse) GetNextPageToken
func (x *SearchTripsResponse) GetNextPageToken() stringfunc (*SearchTripsResponse) GetTrips
func (x *SearchTripsResponse) GetTrips() []*Tripfunc (*SearchTripsResponse) ProtoMessage
func (*SearchTripsResponse) ProtoMessage()func (*SearchTripsResponse) ProtoReflect
func (x *SearchTripsResponse) ProtoReflect() protoreflect.Messagefunc (*SearchTripsResponse) Reset
func (x *SearchTripsResponse) Reset()func (*SearchTripsResponse) String
func (x *SearchTripsResponse) String() stringSearchVehiclesRequest
type SearchVehiclesRequest struct {
// The standard Fleet Engine request header.
Header *RequestHeader `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
// 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.
Parent string `protobuf:"bytes,3,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The pickup point to search near.
PickupPoint *TerminalLocation `protobuf:"bytes,4,opt,name=pickup_point,json=pickupPoint,proto3" json:"pickup_point,omitempty"`
// The customer's intended dropoff location. The field is required if
// `trip_types` contains `TripType.SHARED`.
DropoffPoint *TerminalLocation `protobuf:"bytes,5,opt,name=dropoff_point,json=dropoffPoint,proto3" json:"dropoff_point,omitempty"`
// Required. Defines the vehicle search radius around the pickup point. Only
// vehicles within the search radius will be returned. Value must be between
// 400 and 10000 meters (inclusive).
PickupRadiusMeters int32 `protobuf:"varint,6,opt,name=pickup_radius_meters,json=pickupRadiusMeters,proto3" json:"pickup_radius_meters,omitempty"`
// Required. Specifies the maximum number of vehicles to return. The value
// must be between 1 and 50 (inclusive).
Count int32 `protobuf:"varint,7,opt,name=count,proto3" json:"count,omitempty"`
// Required. Specifies the number of passengers being considered for a trip.
// The value must be greater than or equal to one. The driver is not
// considered in the capacity value.
MinimumCapacity int32 `protobuf:"varint,8,opt,name=minimum_capacity,json=minimumCapacity,proto3" json:"minimum_capacity,omitempty"`
// Required. Represents the type of proposed trip. Must include exactly one
// type. `UNKNOWN_TRIP_TYPE` is not allowed. Restricts the search to only
// those vehicles that can support that trip type.
TripTypes []TripType `protobuf:"varint,9,rep,packed,name=trip_types,json=tripTypes,proto3,enum=maps.fleetengine.v1.TripType" json:"trip_types,omitempty"`
// Restricts the search to only those vehicles that have sent location updates
// to Fleet Engine within the specified duration. Stationary vehicles still
// transmitting their locations are not considered stale. If this field is not
// set, the server uses five minutes as the default value.
MaximumStaleness *durationpb.Duration `protobuf:"bytes,10,opt,name=maximum_staleness,json=maximumStaleness,proto3" json:"maximum_staleness,omitempty"`
// Required. Restricts the search to vehicles with one of the specified types.
// At least one vehicle type must be specified. VehicleTypes with a category
// of `UNKNOWN` are not allowed.
VehicleTypes []*Vehicle_VehicleType `protobuf:"bytes,14,rep,name=vehicle_types,json=vehicleTypes,proto3" json:"vehicle_types,omitempty"`
// Callers can form complex logical operations using any combination of the
// `required_attributes`, `required_one_of_attributes`, and
// `required_one_of_attribute_sets` fields.
//
// `required_attributes` is a list; `required_one_of_attributes` uses a
// message which allows a list of lists. In combination, the two fields allow
// the composition of this expression:
//
// ```
// (required_attributes[0] AND required_attributes[1] AND ...)
// AND
// (required_one_of_attributes[0][0] OR required_one_of_attributes[0][1] OR
// ...)
// AND
// (required_one_of_attributes[1][0] OR required_one_of_attributes[1][1] OR
// ...)
// ```
//
// Restricts the search to only those vehicles with the specified attributes.
// This field is a conjunction/AND operation. A max of 50 required_attributes
// is allowed. This matches the maximum number of attributes allowed on a
// vehicle.
RequiredAttributes []*VehicleAttribute `protobuf:"bytes,12,rep,name=required_attributes,json=requiredAttributes,proto3" json:"required_attributes,omitempty"`
// Restricts the search to only those vehicles with at least one of
// the specified attributes in each `VehicleAttributeList`. Within each
// list, a vehicle must match at least one of the attributes. This field is an
// inclusive disjunction/OR operation in each `VehicleAttributeList` and a
// conjunction/AND operation across the collection of `VehicleAttributeList`.
RequiredOneOfAttributes []*VehicleAttributeList `protobuf:"bytes,15,rep,name=required_one_of_attributes,json=requiredOneOfAttributes,proto3" json:"required_one_of_attributes,omitempty"`
// `required_one_of_attribute_sets` provides additional functionality.
//
// Similar to `required_one_of_attributes`, `required_one_of_attribute_sets`
// uses a message which allows a list of lists, allowing expressions such as
// this one:
//
// ```
// (required_attributes[0] AND required_attributes[1] AND ...)
// AND
// (
//
// (required_one_of_attribute_sets[0][0] AND
// required_one_of_attribute_sets[0][1] AND
// ...)
// OR
// (required_one_of_attribute_sets[1][0] AND
// required_one_of_attribute_sets[1][1] AND
// ...)
//
// )
// ```
//
// Restricts the search to only those vehicles with all the attributes in a
// `VehicleAttributeList`. Within each list, a
// vehicle must match all of the attributes. This field is a conjunction/AND
// operation in each `VehicleAttributeList` and inclusive disjunction/OR
// operation across the collection of `VehicleAttributeList`.
RequiredOneOfAttributeSets []*VehicleAttributeList `protobuf:"bytes,20,rep,name=required_one_of_attribute_sets,json=requiredOneOfAttributeSets,proto3" json:"required_one_of_attribute_sets,omitempty"`
// Required. Specifies the desired ordering criterion for results.
OrderBy SearchVehiclesRequest_VehicleMatchOrder `protobuf:"varint,13,opt,name=order_by,json=orderBy,proto3,enum=maps.fleetengine.v1.SearchVehiclesRequest_VehicleMatchOrder" json:"order_by,omitempty"`
// This indicates if vehicles with a single active trip are eligible for this
// search. This field is only used when `current_trips_present` is
// unspecified. When `current_trips_present` is unspecified and this field
// is `false`, vehicles with assigned trips are excluded from the search
// results. When `current_trips_present` is unspecified and this field is
// `true`, search results can include vehicles with one active trip that has a
// status of `ENROUTE_TO_DROPOFF`. When `current_trips_present` is specified,
// this field cannot be set to true.
//
// The default value is `false`.
IncludeBackToBack bool `protobuf:"varint,18,opt,name=include_back_to_back,json=includeBackToBack,proto3" json:"include_back_to_back,omitempty"`
// Indicates the trip associated with this `SearchVehicleRequest`.
TripId string `protobuf:"bytes,19,opt,name=trip_id,json=tripId,proto3" json:"trip_id,omitempty"`
// This indicates if vehicles with active trips are eligible for this search.
// This must be set to something other than
// `CURRENT_TRIPS_PRESENT_UNSPECIFIED` if `trip_type` includes `SHARED`.
CurrentTripsPresent SearchVehiclesRequest_CurrentTripsPresent `protobuf:"varint,21,opt,name=current_trips_present,json=currentTripsPresent,proto3,enum=maps.fleetengine.v1.SearchVehiclesRequest_CurrentTripsPresent" json:"current_trips_present,omitempty"`
// Optional. A filter query to apply when searching vehicles. See
// http://aip.dev/160 for examples of the filter syntax.
//
// This field is designed to replace the `required_attributes`,
// `required_one_of_attributes`, and `required_one_of_attributes_sets` fields.
// If a non-empty value is specified here, the following fields must be empty:
// `required_attributes`, `required_one_of_attributes`, and
// `required_one_of_attributes_sets`.
//
// This filter functions as an AND clause with other constraints,
// such as `minimum_capacity` or `vehicle_types`.
//
// Note that the only queries supported are on vehicle attributes (for
// example, `attributes.SearchVehicles request message.
func (*SearchVehiclesRequest) Descriptor
func (*SearchVehiclesRequest) Descriptor() ([]byte, []int)Deprecated: Use SearchVehiclesRequest.ProtoReflect.Descriptor instead.
func (*SearchVehiclesRequest) GetCount
func (x *SearchVehiclesRequest) GetCount() int32func (*SearchVehiclesRequest) GetCurrentTripsPresent
func (x *SearchVehiclesRequest) GetCurrentTripsPresent() SearchVehiclesRequest_CurrentTripsPresentfunc (*SearchVehiclesRequest) GetDropoffPoint
func (x *SearchVehiclesRequest) GetDropoffPoint() *TerminalLocationfunc (*SearchVehiclesRequest) GetFilter
func (x *SearchVehiclesRequest) GetFilter() stringfunc (*SearchVehiclesRequest) GetHeader
func (x *SearchVehiclesRequest) GetHeader() *RequestHeaderfunc (*SearchVehiclesRequest) GetIncludeBackToBack
func (x *SearchVehiclesRequest) GetIncludeBackToBack() boolfunc (*SearchVehiclesRequest) GetMaximumStaleness
func (x *SearchVehiclesRequest) GetMaximumStaleness() *durationpb.Durationfunc (*SearchVehiclesRequest) GetMinimumCapacity
func (x *SearchVehiclesRequest) GetMinimumCapacity() int32func (*SearchVehiclesRequest) GetOrderBy
func (x *SearchVehiclesRequest) GetOrderBy() SearchVehiclesRequest_VehicleMatchOrderfunc (*SearchVehiclesRequest) GetParent
func (x *SearchVehiclesRequest) GetParent() stringfunc (*SearchVehiclesRequest) GetPickupPoint
func (x *SearchVehiclesRequest) GetPickupPoint() *TerminalLocationfunc (*SearchVehiclesRequest) GetPickupRadiusMeters
func (x *SearchVehiclesRequest) GetPickupRadiusMeters() int32func (*SearchVehiclesRequest) GetRequiredAttributes
func (x *SearchVehiclesRequest) GetRequiredAttributes() []*VehicleAttributefunc (*SearchVehiclesRequest) GetRequiredOneOfAttributeSets
func (x *SearchVehiclesRequest) GetRequiredOneOfAttributeSets() []*VehicleAttributeListfunc (*SearchVehiclesRequest) GetRequiredOneOfAttributes
func (x *SearchVehiclesRequest) GetRequiredOneOfAttributes() []*VehicleAttributeListfunc (*SearchVehiclesRequest) GetTripId
func (x *SearchVehiclesRequest) GetTripId() stringfunc (*SearchVehiclesRequest) GetTripTypes
func (x *SearchVehiclesRequest) GetTripTypes() []TripTypefunc (*SearchVehiclesRequest) GetVehicleTypes
func (x *SearchVehiclesRequest) GetVehicleTypes() []*Vehicle_VehicleTypefunc (*SearchVehiclesRequest) ProtoMessage
func (*SearchVehiclesRequest) ProtoMessage()func (*SearchVehiclesRequest) ProtoReflect
func (x *SearchVehiclesRequest) ProtoReflect() protoreflect.Messagefunc (*SearchVehiclesRequest) Reset
func (x *SearchVehiclesRequest) Reset()func (*SearchVehiclesRequest) String
func (x *SearchVehiclesRequest) String() stringSearchVehiclesRequest_CurrentTripsPresent
type SearchVehiclesRequest_CurrentTripsPresent int32Specifies the types of restrictions on a vehicle's current trips.
SearchVehiclesRequest_CURRENT_TRIPS_PRESENT_UNSPECIFIED, SearchVehiclesRequest_NONE, SearchVehiclesRequest_ANY
const (
// The availability of vehicles with trips present is governed by the
// `include_back_to_back` field.
SearchVehiclesRequest_CURRENT_TRIPS_PRESENT_UNSPECIFIED SearchVehiclesRequest_CurrentTripsPresent = 0
// Vehicles without trips can appear in search results. When this value is
// used, `include_back_to_back` cannot be `true`.
SearchVehiclesRequest_NONE SearchVehiclesRequest_CurrentTripsPresent = 1
// Vehicles with at most 5 current trips and 10 waypoints are included
// in the search results. When this value is used, `include_back_to_back`
// cannot be `true`.
SearchVehiclesRequest_ANY SearchVehiclesRequest_CurrentTripsPresent = 2
)func (SearchVehiclesRequest_CurrentTripsPresent) Descriptor
func (SearchVehiclesRequest_CurrentTripsPresent) Descriptor() protoreflect.EnumDescriptorfunc (SearchVehiclesRequest_CurrentTripsPresent) Enum
func (x SearchVehiclesRequest_CurrentTripsPresent) Enum() *SearchVehiclesRequest_CurrentTripsPresentfunc (SearchVehiclesRequest_CurrentTripsPresent) EnumDescriptor
func (SearchVehiclesRequest_CurrentTripsPresent) EnumDescriptor() ([]byte, []int)Deprecated: Use SearchVehiclesRequest_CurrentTripsPresent.Descriptor instead.
func (SearchVehiclesRequest_CurrentTripsPresent) Number
func (x SearchVehiclesRequest_CurrentTripsPresent) Number() protoreflect.EnumNumberfunc (SearchVehiclesRequest_CurrentTripsPresent) String
func (x SearchVehiclesRequest_CurrentTripsPresent) String() stringfunc (SearchVehiclesRequest_CurrentTripsPresent) Type
func (SearchVehiclesRequest_CurrentTripsPresent) Type() protoreflect.EnumTypeSearchVehiclesRequest_VehicleMatchOrder
type SearchVehiclesRequest_VehicleMatchOrder int32Specifies the order of the vehicle matches in the response.
SearchVehiclesRequest_UNKNOWN_VEHICLE_MATCH_ORDER, SearchVehiclesRequest_PICKUP_POINT_ETA, SearchVehiclesRequest_PICKUP_POINT_DISTANCE, SearchVehiclesRequest_DROPOFF_POINT_ETA, SearchVehiclesRequest_PICKUP_POINT_STRAIGHT_DISTANCE, SearchVehiclesRequest_COST
const (
// Default, used for unspecified or unrecognized vehicle matches order.
SearchVehiclesRequest_UNKNOWN_VEHICLE_MATCH_ORDER SearchVehiclesRequest_VehicleMatchOrder = 0
// Ascending order by vehicle driving time to the pickup point.
SearchVehiclesRequest_PICKUP_POINT_ETA SearchVehiclesRequest_VehicleMatchOrder = 1
// Ascending order by vehicle driving distance to the pickup point.
SearchVehiclesRequest_PICKUP_POINT_DISTANCE SearchVehiclesRequest_VehicleMatchOrder = 2
// Ascending order by vehicle driving time to the dropoff point. This order
// can only be used if the dropoff point is specified in the request.
SearchVehiclesRequest_DROPOFF_POINT_ETA SearchVehiclesRequest_VehicleMatchOrder = 3
// Ascending order by straight-line distance from the vehicle's last
// reported location to the pickup point.
SearchVehiclesRequest_PICKUP_POINT_STRAIGHT_DISTANCE SearchVehiclesRequest_VehicleMatchOrder = 4
// Ascending order by the configured match cost. Match cost is defined as a
// weighted calculation between straight-line distance and ETA. Weights are
// set with default values and can be modified per customer. Please contact
// Google support if these weights need to be modified for your project.
SearchVehiclesRequest_COST SearchVehiclesRequest_VehicleMatchOrder = 5
)func (SearchVehiclesRequest_VehicleMatchOrder) Descriptor
func (SearchVehiclesRequest_VehicleMatchOrder) Descriptor() protoreflect.EnumDescriptorfunc (SearchVehiclesRequest_VehicleMatchOrder) Enum
func (SearchVehiclesRequest_VehicleMatchOrder) EnumDescriptor
func (SearchVehiclesRequest_VehicleMatchOrder) EnumDescriptor() ([]byte, []int)Deprecated: Use SearchVehiclesRequest_VehicleMatchOrder.Descriptor instead.
func (SearchVehiclesRequest_VehicleMatchOrder) Number
func (x SearchVehiclesRequest_VehicleMatchOrder) Number() protoreflect.EnumNumberfunc (SearchVehiclesRequest_VehicleMatchOrder) String
func (x SearchVehiclesRequest_VehicleMatchOrder) String() stringfunc (SearchVehiclesRequest_VehicleMatchOrder) Type
func (SearchVehiclesRequest_VehicleMatchOrder) Type() protoreflect.EnumTypeSearchVehiclesResponse
type SearchVehiclesResponse struct {
// List of vehicles that match the `SearchVehiclesRequest` criteria, ordered
// according to `SearchVehiclesRequest.order_by` field.
Matches []*VehicleMatch `protobuf:"bytes,1,rep,name=matches,proto3" json:"matches,omitempty"`
// contains filtered or unexported fields
}SearchVehicles response message.
func (*SearchVehiclesResponse) Descriptor
func (*SearchVehiclesResponse) Descriptor() ([]byte, []int)Deprecated: Use SearchVehiclesResponse.ProtoReflect.Descriptor instead.
func (*SearchVehiclesResponse) GetMatches
func (x *SearchVehiclesResponse) GetMatches() []*VehicleMatchfunc (*SearchVehiclesResponse) ProtoMessage
func (*SearchVehiclesResponse) ProtoMessage()func (*SearchVehiclesResponse) ProtoReflect
func (x *SearchVehiclesResponse) ProtoReflect() protoreflect.Messagefunc (*SearchVehiclesResponse) Reset
func (x *SearchVehiclesResponse) Reset()func (*SearchVehiclesResponse) String
func (x *SearchVehiclesResponse) String() stringSpeedReadingInterval
type SpeedReadingInterval struct {
// The starting index of this interval in the path.
// In JSON, when the index is 0, the field will appear to be unpopulated.
StartPolylinePointIndex int32 `protobuf:"varint,1,opt,name=start_polyline_point_index,json=startPolylinePointIndex,proto3" json:"start_polyline_point_index,omitempty"`
// The ending index of this interval in the path.
// In JSON, when the index is 0, the field will appear to be unpopulated.
EndPolylinePointIndex int32 `protobuf:"varint,2,opt,name=end_polyline_point_index,json=endPolylinePointIndex,proto3" json:"end_polyline_point_index,omitempty"`
// Traffic speed in this interval.
Speed SpeedReadingInterval_Speed `protobuf:"varint,3,opt,name=speed,proto3,enum=maps.fleetengine.v1.SpeedReadingInterval_Speed" json:"speed,omitempty"`
// contains filtered or unexported fields
}Traffic density indicator on a contiguous segment of a path. Given a path with points P_0, P_1, ... , P_N (zero-based index), the SpeedReadingInterval defines an interval and describes its traffic using the following categories.
func (*SpeedReadingInterval) Descriptor
func (*SpeedReadingInterval) Descriptor() ([]byte, []int)Deprecated: Use SpeedReadingInterval.ProtoReflect.Descriptor instead.
func (*SpeedReadingInterval) GetEndPolylinePointIndex
func (x *SpeedReadingInterval) GetEndPolylinePointIndex() int32func (*SpeedReadingInterval) GetSpeed
func (x *SpeedReadingInterval) GetSpeed() SpeedReadingInterval_Speedfunc (*SpeedReadingInterval) GetStartPolylinePointIndex
func (x *SpeedReadingInterval) GetStartPolylinePointIndex() int32func (*SpeedReadingInterval) ProtoMessage
func (*SpeedReadingInterval) ProtoMessage()func (*SpeedReadingInterval) ProtoReflect
func (x *SpeedReadingInterval) ProtoReflect() protoreflect.Messagefunc (*SpeedReadingInterval) Reset
func (x *SpeedReadingInterval) Reset()func (*SpeedReadingInterval) String
func (x *SpeedReadingInterval) String() stringSpeedReadingInterval_Speed
type SpeedReadingInterval_Speed int32The classification of polyline speed based on traffic data.
SpeedReadingInterval_SPEED_UNSPECIFIED, SpeedReadingInterval_NORMAL, SpeedReadingInterval_SLOW, SpeedReadingInterval_TRAFFIC_JAM
const (
// Default value. This value is unused.
SpeedReadingInterval_SPEED_UNSPECIFIED SpeedReadingInterval_Speed = 0
// Normal speed, no traffic delays.
SpeedReadingInterval_NORMAL SpeedReadingInterval_Speed = 1
// Slowdown detected, medium amount of traffic.
SpeedReadingInterval_SLOW SpeedReadingInterval_Speed = 2
// Traffic delays.
SpeedReadingInterval_TRAFFIC_JAM SpeedReadingInterval_Speed = 3
)func (SpeedReadingInterval_Speed) Descriptor
func (SpeedReadingInterval_Speed) Descriptor() protoreflect.EnumDescriptorfunc (SpeedReadingInterval_Speed) Enum
func (x SpeedReadingInterval_Speed) Enum() *SpeedReadingInterval_Speedfunc (SpeedReadingInterval_Speed) EnumDescriptor
func (SpeedReadingInterval_Speed) EnumDescriptor() ([]byte, []int)Deprecated: Use SpeedReadingInterval_Speed.Descriptor instead.
func (SpeedReadingInterval_Speed) Number
func (x SpeedReadingInterval_Speed) Number() protoreflect.EnumNumberfunc (SpeedReadingInterval_Speed) String
func (x SpeedReadingInterval_Speed) String() stringfunc (SpeedReadingInterval_Speed) Type
func (SpeedReadingInterval_Speed) Type() protoreflect.EnumTypeStopLocation
type StopLocation struct {
// Required. Denotes the actual location.
Point *latlng.LatLng `protobuf:"bytes,1,opt,name=point,proto3" json:"point,omitempty"`
// Indicates when the stop happened.
Timestamp *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
// Input only. Deprecated. Use the timestamp field.
//
// Deprecated: Marked as deprecated in google/maps/fleetengine/v1/trips.proto.
StopTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=stop_time,json=stopTime,proto3" json:"stop_time,omitempty"`
// contains filtered or unexported fields
}The actual location where a stop (pickup/dropoff) happened.
func (*StopLocation) Descriptor
func (*StopLocation) Descriptor() ([]byte, []int)Deprecated: Use StopLocation.ProtoReflect.Descriptor instead.
func (*StopLocation) GetPoint
func (x *StopLocation) GetPoint() *latlng.LatLngfunc (*StopLocation) GetStopTime
func (x *StopLocation) GetStopTime() *timestamppb.TimestampDeprecated: Marked as deprecated in google/maps/fleetengine/v1/trips.proto.
func (*StopLocation) GetTimestamp
func (x *StopLocation) GetTimestamp() *timestamppb.Timestampfunc (*StopLocation) ProtoMessage
func (*StopLocation) ProtoMessage()func (*StopLocation) ProtoReflect
func (x *StopLocation) ProtoReflect() protoreflect.Messagefunc (*StopLocation) Reset
func (x *StopLocation) Reset()func (*StopLocation) String
func (x *StopLocation) String() stringTerminalLocation
type TerminalLocation struct {
// Required. Denotes the location of a trip waypoint.
Point *latlng.LatLng `protobuf:"bytes,1,opt,name=point,proto3" json:"point,omitempty"`
// Deprecated: Specify the `point` field instead.
//
// Deprecated: Marked as deprecated in google/maps/fleetengine/v1/fleetengine.proto.
TerminalPointId *TerminalPointId `protobuf:"bytes,2,opt,name=terminal_point_id,json=terminalPointId,proto3" json:"terminal_point_id,omitempty"`
// Deprecated: Specify the `point` field instead.
//
// Deprecated: Marked as deprecated in google/maps/fleetengine/v1/fleetengine.proto.
AccessPointId string `protobuf:"bytes,3,opt,name=access_point_id,json=accessPointId,proto3" json:"access_point_id,omitempty"`
// Deprecated.
//
// Deprecated: Marked as deprecated in google/maps/fleetengine/v1/fleetengine.proto.
TripId string `protobuf:"bytes,4,opt,name=trip_id,json=tripId,proto3" json:"trip_id,omitempty"`
// Deprecated: `Vehicle.waypoint` will have this data.
//
// Deprecated: Marked as deprecated in google/maps/fleetengine/v1/fleetengine.proto.
TerminalLocationType WaypointType `protobuf:"varint,5,opt,name=terminal_location_type,json=terminalLocationType,proto3,enum=maps.fleetengine.v1.WaypointType" json:"terminal_location_type,omitempty"`
// contains filtered or unexported fields
}Describes the location of a waypoint.
func (*TerminalLocation) Descriptor
func (*TerminalLocation) Descriptor() ([]byte, []int)Deprecated: Use TerminalLocation.ProtoReflect.Descriptor instead.
func (*TerminalLocation) GetAccessPointId
func (x *TerminalLocation) GetAccessPointId() stringDeprecated: Marked as deprecated in google/maps/fleetengine/v1/fleetengine.proto.
func (*TerminalLocation) GetPoint
func (x *TerminalLocation) GetPoint() *latlng.LatLngfunc (*TerminalLocation) GetTerminalLocationType
func (x *TerminalLocation) GetTerminalLocationType() WaypointTypeDeprecated: Marked as deprecated in google/maps/fleetengine/v1/fleetengine.proto.
func (*TerminalLocation) GetTerminalPointId
func (x *TerminalLocation) GetTerminalPointId() *TerminalPointIdDeprecated: Marked as deprecated in google/maps/fleetengine/v1/fleetengine.proto.
func (*TerminalLocation) GetTripId
func (x *TerminalLocation) GetTripId() stringDeprecated: Marked as deprecated in google/maps/fleetengine/v1/fleetengine.proto.
func (*TerminalLocation) ProtoMessage
func (*TerminalLocation) ProtoMessage()func (*TerminalLocation) ProtoReflect
func (x *TerminalLocation) ProtoReflect() protoreflect.Messagefunc (*TerminalLocation) Reset
func (x *TerminalLocation) Reset()func (*TerminalLocation) String
func (x *TerminalLocation) String() stringTerminalPointId (deprecated)
type TerminalPointId struct {
// Deprecated.
//
// Types that are assignable to Id:
//
// *TerminalPointId_PlaceId
// *TerminalPointId_GeneratedId
Id isTerminalPointId_Id `protobuf_oneof:"Id"`
// Deprecated.
//
// Deprecated: Marked as deprecated in google/maps/fleetengine/v1/fleetengine.proto.
Value string `protobuf:"bytes,4,opt,name=value,proto3" json:"value,omitempty"`
// contains filtered or unexported fields
}Deprecated: TerminalPoints are no longer supported in Fleet Engine. Use
TerminalLocation.point instead.
Deprecated: Marked as deprecated in google/maps/fleetengine/v1/fleetengine.proto.
func (*TerminalPointId) Descriptor (deprecated)
func (*TerminalPointId) Descriptor() ([]byte, []int)Deprecated: Use TerminalPointId.ProtoReflect.Descriptor instead.
func (*TerminalPointId) GetGeneratedId (deprecated)
func (x *TerminalPointId) GetGeneratedId() stringDeprecated: Marked as deprecated in google/maps/fleetengine/v1/fleetengine.proto.
func (*TerminalPointId) GetId (deprecated)
func (m *TerminalPointId) GetId() isTerminalPointId_Idfunc (*TerminalPointId) GetPlaceId (deprecated)
func (x *TerminalPointId) GetPlaceId() stringDeprecated: Marked as deprecated in google/maps/fleetengine/v1/fleetengine.proto.
func (*TerminalPointId) GetValue (deprecated)
func (x *TerminalPointId) GetValue() stringDeprecated: Marked as deprecated in google/maps/fleetengine/v1/fleetengine.proto.
func (*TerminalPointId) ProtoMessage (deprecated)
func (*TerminalPointId) ProtoMessage()func (*TerminalPointId) ProtoReflect (deprecated)
func (x *TerminalPointId) ProtoReflect() protoreflect.Messagefunc (*TerminalPointId) Reset (deprecated)
func (x *TerminalPointId) Reset()func (*TerminalPointId) String (deprecated)
func (x *TerminalPointId) String() stringTerminalPointId_GeneratedId
type TerminalPointId_GeneratedId struct {
// Deprecated.
//
// Deprecated: Marked as deprecated in google/maps/fleetengine/v1/fleetengine.proto.
GeneratedId string `protobuf:"bytes,3,opt,name=generated_id,json=generatedId,proto3,oneof"`
}TerminalPointId_PlaceId
type TerminalPointId_PlaceId struct {
// Deprecated.
//
// Deprecated: Marked as deprecated in google/maps/fleetengine/v1/fleetengine.proto.
PlaceId string `protobuf:"bytes,2,opt,name=place_id,json=placeId,proto3,oneof"`
}TrafficPolylineData
type TrafficPolylineData struct {
// A polyline rendering of how fast traffic is for all regions along
// one stretch of a customer ride.
TrafficRendering *VisualTrafficReportPolylineRendering `protobuf:"bytes,1,opt,name=traffic_rendering,json=trafficRendering,proto3" json:"traffic_rendering,omitempty"`
// contains filtered or unexported fields
}Traffic conditions along the expected vehicle route.
func (*TrafficPolylineData) Descriptor
func (*TrafficPolylineData) Descriptor() ([]byte, []int)Deprecated: Use TrafficPolylineData.ProtoReflect.Descriptor instead.
func (*TrafficPolylineData) GetTrafficRendering
func (x *TrafficPolylineData) GetTrafficRendering() *VisualTrafficReportPolylineRenderingfunc (*TrafficPolylineData) ProtoMessage
func (*TrafficPolylineData) ProtoMessage()func (*TrafficPolylineData) ProtoReflect
func (x *TrafficPolylineData) ProtoReflect() protoreflect.Messagefunc (*TrafficPolylineData) Reset
func (x *TrafficPolylineData) Reset()func (*TrafficPolylineData) String
func (x *TrafficPolylineData) String() stringTrip
type Trip struct {
// Output only. In the format "providers/{provider}/trips/{trip}"
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// ID of the vehicle making this trip.
VehicleId string `protobuf:"bytes,2,opt,name=vehicle_id,json=vehicleId,proto3" json:"vehicle_id,omitempty"`
// Current status of the trip.
TripStatus TripStatus `protobuf:"varint,3,opt,name=trip_status,json=tripStatus,proto3,enum=maps.fleetengine.v1.TripStatus" json:"trip_status,omitempty"`
// The type of the trip.
TripType TripType `protobuf:"varint,4,opt,name=trip_type,json=tripType,proto3,enum=maps.fleetengine.v1.TripType" json:"trip_type,omitempty"`
// Location where customer indicates they will be picked up.
PickupPoint *TerminalLocation `protobuf:"bytes,5,opt,name=pickup_point,json=pickupPoint,proto3" json:"pickup_point,omitempty"`
// Input only. The actual location when and where customer was picked up.
// This field is for provider to provide feedback on actual pickup
// information.
ActualPickupPoint *StopLocation `protobuf:"bytes,22,opt,name=actual_pickup_point,json=actualPickupPoint,proto3" json:"actual_pickup_point,omitempty"`
// Input only. The actual time and location of the driver arrival at
// the pickup point.
// This field is for provider to provide feedback on actual arrival
// information at the pickup point.
ActualPickupArrivalPoint *StopLocation `protobuf:"bytes,32,opt,name=actual_pickup_arrival_point,json=actualPickupArrivalPoint,proto3" json:"actual_pickup_arrival_point,omitempty"`
// Output only. Either the estimated future time when the rider(s) will be
// picked up, or the actual time when they were picked up.
PickupTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=pickup_time,json=pickupTime,proto3" json:"pickup_time,omitempty"`
// Intermediate stops in order that the trip requests (in addition
// to pickup and dropoff). Initially this will not be supported for shared
// trips.
IntermediateDestinations []*TerminalLocation `protobuf:"bytes,14,rep,name=intermediate_destinations,json=intermediateDestinations,proto3" json:"intermediate_destinations,omitempty"`
// Indicates the last time the `intermediate_destinations` was modified.
// Your server should cache this value and pass it in `UpdateTripRequest`
// when update `intermediate_destination_index` to ensure the
// `intermediate_destinations` is not changed.
IntermediateDestinationsVersion *timestamppb.Timestamp `protobuf:"bytes,25,opt,name=intermediate_destinations_version,json=intermediateDestinationsVersion,proto3" json:"intermediate_destinations_version,omitempty"`
// When `TripStatus` is `ENROUTE_TO_INTERMEDIATE_DESTINATION`, a number
// between [0..N-1] indicating which intermediate destination the vehicle will
// cross next. When `TripStatus` is `ARRIVED_AT_INTERMEDIATE_DESTINATION`, a
// number between [0..N-1] indicating which intermediate destination the
// vehicle is at. The provider sets this value. If there are no
// `intermediate_destinations`, this field is ignored.
IntermediateDestinationIndex int32 `protobuf:"varint,15,opt,name=intermediate_destination_index,json=intermediateDestinationIndex,proto3" json:"intermediate_destination_index,omitempty"`
// Input only. The actual time and location of the driver's arrival at
// an intermediate destination.
// This field is for provider to provide feedback on actual arrival
// information at intermediate destinations.
ActualIntermediateDestinationArrivalPoints []*StopLocation `protobuf:"bytes,33,rep,name=actual_intermediate_destination_arrival_points,json=actualIntermediateDestinationArrivalPoints,proto3" json:"actual_intermediate_destination_arrival_points,omitempty"`
// Input only. The actual time and location when and where the customer was
// picked up from an intermediate destination. This field is for provider to
// provide feedback on actual pickup information at intermediate destinations.
ActualIntermediateDestinations []*StopLocation `protobuf:"bytes,34,rep,name=actual_intermediate_destinations,json=actualIntermediateDestinations,proto3" json:"actual_intermediate_destinations,omitempty"`
// Location where customer indicates they will be dropped off.
DropoffPoint *TerminalLocation `protobuf:"bytes,7,opt,name=dropoff_point,json=dropoffPoint,proto3" json:"dropoff_point,omitempty"`
// Input only. The actual time and location when and where customer was
// dropped off. This field is for provider to provide feedback on actual
// dropoff information.
ActualDropoffPoint *StopLocation `protobuf:"bytes,23,opt,name=actual_dropoff_point,json=actualDropoffPoint,proto3" json:"actual_dropoff_point,omitempty"`
// Output only. Either the estimated future time when the rider(s) will be
// dropped off at the final destination, or the actual time when they were
// dropped off.
DropoffTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=dropoff_time,json=dropoffTime,proto3" json:"dropoff_time,omitempty"`
// Output only. The full path from the current location to the dropoff point,
// inclusive. This path could include waypoints from other trips.
RemainingWaypoints []*TripWaypoint `protobuf:"bytes,16,rep,name=remaining_waypoints,json=remainingWaypoints,proto3" json:"remaining_waypoints,omitempty"`
// This field supports manual ordering of the waypoints for the trip. It
// contains all of the remaining waypoints for the assigned vehicle, as well
// as the pickup and drop-off waypoints for this trip. If the trip hasn't been
// assigned to a vehicle, then Fleet Engine ignores this field. For privacy
// reasons, this field is only populated by the server on `UpdateTrip` and
// `CreateTrip` calls, NOT on `GetTrip` calls.
VehicleWaypoints []*TripWaypoint `protobuf:"bytes,20,rep,name=vehicle_waypoints,json=vehicleWaypoints,proto3" json:"vehicle_waypoints,omitempty"`
// Output only. Anticipated route for this trip to the first entry in
// remaining_waypoints. Note that the first waypoint may belong to a different
// trip.
Route []*latlng.LatLng `protobuf:"bytes,9,rep,name=route,proto3" json:"route,omitempty"`
// Output only. An encoded path to the next waypoint.
//
// Note: This field is intended only for use by the Driver SDK and Consumer
// SDK. Decoding is not yet supported.
CurrentRouteSegment string `protobuf:"bytes,21,opt,name=current_route_segment,json=currentRouteSegment,proto3" json:"current_route_segment,omitempty"`
// Output only. Indicates the last time the route was modified.
//
// Note: This field is intended only for use by the Driver SDK and Consumer
// SDK.
CurrentRouteSegmentVersion *timestamppb.Timestamp `protobuf:"bytes,17,opt,name=current_route_segment_version,json=currentRouteSegmentVersion,proto3" json:"current_route_segment_version,omitempty"`
// Output only. Indicates the traffic conditions along the
// `current_route_segment` when they're available.
//
// Note: This field is intended only for use by the Driver SDK and Consumer
// SDK.
CurrentRouteSegmentTraffic *ConsumableTrafficPolyline `protobuf:"bytes,28,opt,name=current_route_segment_traffic,json=currentRouteSegmentTraffic,proto3" json:"current_route_segment_traffic,omitempty"`
// Output only. Indicates the last time the `current_route_segment_traffic`
// was modified.
//
// Note: This field is intended only for use by the Driver SDK and Consumer
// SDK.
CurrentRouteSegmentTrafficVersion *timestamppb.Timestamp `protobuf:"bytes,30,opt,name=current_route_segment_traffic_version,json=currentRouteSegmentTrafficVersion,proto3" json:"current_route_segment_traffic_version,omitempty"`
// Output only. The waypoint where `current_route_segment` ends.
CurrentRouteSegmentEndPoint *TripWaypoint `protobuf:"bytes,24,opt,name=current_route_segment_end_point,json=currentRouteSegmentEndPoint,proto3" json:"current_route_segment_end_point,omitempty"`
// Output only. The remaining driving distance in the `current_route_segment`
// field. The value is unspecified if the trip is not assigned to a vehicle,
// or the trip is completed or cancelled.
RemainingDistanceMeters *wrapperspb.Int32Value `protobuf:"bytes,12,opt,name=remaining_distance_meters,json=remainingDistanceMeters,proto3" json:"remaining_distance_meters,omitempty"`
// Output only. The ETA to the next waypoint (the first entry in the
// `remaining_waypoints` field). The value is unspecified if the trip is not
// assigned to a vehicle, or the trip is inactive (completed or cancelled).
EtaToFirstWaypoint *timestamppb.Timestamp `protobuf:"bytes,13,opt,name=eta_to_first_waypoint,json=etaToFirstWaypoint,proto3" json:"eta_to_first_waypoint,omitempty"`
// Output only. The duration from when the Trip data is returned to the time
// in `Trip.eta_to_first_waypoint`. The value is unspecified if the trip is
// not assigned to a vehicle, or the trip is inactive (completed or
// cancelled).
RemainingTimeToFirstWaypoint *durationpb.Duration `protobuf:"bytes,27,opt,name=remaining_time_to_first_waypoint,json=remainingTimeToFirstWaypoint,proto3" json:"remaining_time_to_first_waypoint,omitempty"`
// Output only. Indicates the last time that `remaining_waypoints` was changed
// (a waypoint was added, removed, or changed).
RemainingWaypointsVersion *timestamppb.Timestamp `protobuf:"bytes,19,opt,name=remaining_waypoints_version,json=remainingWaypointsVersion,proto3" json:"remaining_waypoints_version,omitempty"`
// Output only. Indicates the last time the
// `remaining_waypoints.path_to_waypoint` and
// `remaining_waypoints.traffic_to_waypoint` were modified. Your client app
// should cache this value and pass it in `GetTripRequest` to ensure the
// paths and traffic for `remaining_waypoints` are only returned if updated.
RemainingWaypointsRouteVersion *timestamppb.Timestamp `protobuf:"bytes,29,opt,name=remaining_waypoints_route_version,json=remainingWaypointsRouteVersion,proto3" json:"remaining_waypoints_route_version,omitempty"`
// Immutable. Indicates the number of passengers on this trip and does not
// include the driver. A vehicle must have available capacity to be returned
// in a `SearchVehicles` response.
NumberOfPassengers int32 `protobuf:"varint,10,opt,name=number_of_passengers,json=numberOfPassengers,proto3" json:"number_of_passengers,omitempty"`
// Output only. Indicates the last reported location of the vehicle along the
// route.
LastLocation *VehicleLocation `protobuf:"bytes,11,opt,name=last_location,json=lastLocation,proto3" json:"last_location,omitempty"`
// Output only. Indicates whether the vehicle's `last_location` can be snapped
// to the current_route_segment. False if `last_location` or
// `current_route_segment` doesn't exist.
// It is computed by Fleet Engine. Any update from clients will be ignored.
LastLocationSnappable bool `protobuf:"varint,26,opt,name=last_location_snappable,json=lastLocationSnappable,proto3" json:"last_location_snappable,omitempty"`
// The subset of Trip fields that are populated and how they should be
// interpreted.
View TripView `protobuf:"varint,31,opt,name=view,proto3,enum=maps.fleetengine.v1.TripView" json:"view,omitempty"`
// A list of custom Trip attributes. Each attribute must have a unique key.
Attributes []*TripAttribute `protobuf:"bytes,35,rep,name=attributes,proto3" json:"attributes,omitempty"`
// contains filtered or unexported fields
}Trip metadata.
func (*Trip) Descriptor
Deprecated: Use Trip.ProtoReflect.Descriptor instead.
func (*Trip) GetActualDropoffPoint
func (x *Trip) GetActualDropoffPoint() *StopLocationfunc (*Trip) GetActualIntermediateDestinationArrivalPoints
func (x *Trip) GetActualIntermediateDestinationArrivalPoints() []*StopLocationfunc (*Trip) GetActualIntermediateDestinations
func (x *Trip) GetActualIntermediateDestinations() []*StopLocationfunc (*Trip) GetActualPickupArrivalPoint
func (x *Trip) GetActualPickupArrivalPoint() *StopLocationfunc (*Trip) GetActualPickupPoint
func (x *Trip) GetActualPickupPoint() *StopLocationfunc (*Trip) GetAttributes
func (x *Trip) GetAttributes() []*TripAttributefunc (*Trip) GetCurrentRouteSegment
func (*Trip) GetCurrentRouteSegmentEndPoint
func (x *Trip) GetCurrentRouteSegmentEndPoint() *TripWaypointfunc (*Trip) GetCurrentRouteSegmentTraffic
func (x *Trip) GetCurrentRouteSegmentTraffic() *ConsumableTrafficPolylinefunc (*Trip) GetCurrentRouteSegmentTrafficVersion
func (x *Trip) GetCurrentRouteSegmentTrafficVersion() *timestamppb.Timestampfunc (*Trip) GetCurrentRouteSegmentVersion
func (x *Trip) GetCurrentRouteSegmentVersion() *timestamppb.Timestampfunc (*Trip) GetDropoffPoint
func (x *Trip) GetDropoffPoint() *TerminalLocationfunc (*Trip) GetDropoffTime
func (x *Trip) GetDropoffTime() *timestamppb.Timestampfunc (*Trip) GetEtaToFirstWaypoint
func (x *Trip) GetEtaToFirstWaypoint() *timestamppb.Timestampfunc (*Trip) GetIntermediateDestinationIndex
func (*Trip) GetIntermediateDestinations
func (x *Trip) GetIntermediateDestinations() []*TerminalLocationfunc (*Trip) GetIntermediateDestinationsVersion
func (x *Trip) GetIntermediateDestinationsVersion() *timestamppb.Timestampfunc (*Trip) GetLastLocation
func (x *Trip) GetLastLocation() *VehicleLocationfunc (*Trip) GetLastLocationSnappable
func (*Trip) GetName
func (*Trip) GetNumberOfPassengers
func (*Trip) GetPickupPoint
func (x *Trip) GetPickupPoint() *TerminalLocationfunc (*Trip) GetPickupTime
func (x *Trip) GetPickupTime() *timestamppb.Timestampfunc (*Trip) GetRemainingDistanceMeters
func (x *Trip) GetRemainingDistanceMeters() *wrapperspb.Int32Valuefunc (*Trip) GetRemainingTimeToFirstWaypoint
func (x *Trip) GetRemainingTimeToFirstWaypoint() *durationpb.Durationfunc (*Trip) GetRemainingWaypoints
func (x *Trip) GetRemainingWaypoints() []*TripWaypointfunc (*Trip) GetRemainingWaypointsRouteVersion
func (x *Trip) GetRemainingWaypointsRouteVersion() *timestamppb.Timestampfunc (*Trip) GetRemainingWaypointsVersion
func (x *Trip) GetRemainingWaypointsVersion() *timestamppb.Timestampfunc (*Trip) GetRoute
func (*Trip) GetTripStatus
func (x *Trip) GetTripStatus() TripStatusfunc (*Trip) GetTripType
func (*Trip) GetVehicleId
func (*Trip) GetVehicleWaypoints
func (x *Trip) GetVehicleWaypoints() []*TripWaypointfunc (*Trip) GetView
func (*Trip) ProtoMessage
func (*Trip) ProtoMessage()func (*Trip) ProtoReflect
func (x *Trip) ProtoReflect() protoreflect.Messagefunc (*Trip) Reset
func (x *Trip) Reset()func (*Trip) String
TripAttribute
type TripAttribute struct {
// The attribute's key. Keys may not contain the colon character (:).
Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
// The attribute's value, can be in string, bool, or double type.
//
// Types that are assignable to TripAttributeValue:
//
// *TripAttribute_StringValue
// *TripAttribute_BoolValue
// *TripAttribute_NumberValue
TripAttributeValue isTripAttribute_TripAttributeValue `protobuf_oneof:"trip_attribute_value"`
// contains filtered or unexported fields
}Describes a trip attribute as a key-value pair. The "key:value" string length cannot exceed 256 characters.
func (*TripAttribute) Descriptor
func (*TripAttribute) Descriptor() ([]byte, []int)Deprecated: Use TripAttribute.ProtoReflect.Descriptor instead.
func (*TripAttribute) GetBoolValue
func (x *TripAttribute) GetBoolValue() boolfunc (*TripAttribute) GetKey
func (x *TripAttribute) GetKey() stringfunc (*TripAttribute) GetNumberValue
func (x *TripAttribute) GetNumberValue() float64func (*TripAttribute) GetStringValue
func (x *TripAttribute) GetStringValue() stringfunc (*TripAttribute) GetTripAttributeValue
func (m *TripAttribute) GetTripAttributeValue() isTripAttribute_TripAttributeValuefunc (*TripAttribute) ProtoMessage
func (*TripAttribute) ProtoMessage()func (*TripAttribute) ProtoReflect
func (x *TripAttribute) ProtoReflect() protoreflect.Messagefunc (*TripAttribute) Reset
func (x *TripAttribute) Reset()func (*TripAttribute) String
func (x *TripAttribute) String() stringTripAttribute_BoolValue
type TripAttribute_BoolValue struct {
// Boolean typed attribute value.
BoolValue bool `protobuf:"varint,3,opt,name=bool_value,json=boolValue,proto3,oneof"`
}TripAttribute_NumberValue
type TripAttribute_NumberValue struct {
// Double typed attribute value.
NumberValue float64 `protobuf:"fixed64,4,opt,name=number_value,json=numberValue,proto3,oneof"`
}TripAttribute_StringValue
type TripAttribute_StringValue struct {
// String typed attribute value.
StringValue string `protobuf:"bytes,2,opt,name=string_value,json=stringValue,proto3,oneof"`
}TripServiceClient
type TripServiceClient interface {
// Creates a trip in the Fleet Engine and returns the new trip.
CreateTrip(ctx context.Context, in *CreateTripRequest, opts ...grpc.CallOption) (*Trip, error)
// Get information about a single trip.
GetTrip(ctx context.Context, in *GetTripRequest, opts ...grpc.CallOption) (*Trip, error)
// Deletes a single Trip.
//
// Returns FAILED_PRECONDITION if the Trip is active and assigned to a
// vehicle.
DeleteTrip(ctx context.Context, in *DeleteTripRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Report billable trip usage.
ReportBillableTrip(ctx context.Context, in *ReportBillableTripRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Get all the trips for a specific vehicle.
SearchTrips(ctx context.Context, in *SearchTripsRequest, opts ...grpc.CallOption) (*SearchTripsResponse, error)
// Updates trip data.
UpdateTrip(ctx context.Context, in *UpdateTripRequest, opts ...grpc.CallOption) (*Trip, error)
}TripServiceClient is the client API for TripService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewTripServiceClient
func NewTripServiceClient(cc grpc.ClientConnInterface) TripServiceClientTripServiceServer
type TripServiceServer interface {
// Creates a trip in the Fleet Engine and returns the new trip.
CreateTrip(context.Context, *CreateTripRequest) (*Trip, error)
// Get information about a single trip.
GetTrip(context.Context, *GetTripRequest) (*Trip, error)
// Deletes a single Trip.
//
// Returns FAILED_PRECONDITION if the Trip is active and assigned to a
// vehicle.
DeleteTrip(context.Context, *DeleteTripRequest) (*emptypb.Empty, error)
// Report billable trip usage.
ReportBillableTrip(context.Context, *ReportBillableTripRequest) (*emptypb.Empty, error)
// Get all the trips for a specific vehicle.
SearchTrips(context.Context, *SearchTripsRequest) (*SearchTripsResponse, error)
// Updates trip data.
UpdateTrip(context.Context, *UpdateTripRequest) (*Trip, error)
}TripServiceServer is the server API for TripService service. All implementations should embed UnimplementedTripServiceServer for forward compatibility
TripStatus
type TripStatus int32The status of a trip indicating its progression.
TripStatus_UNKNOWN_TRIP_STATUS, TripStatus_NEW, TripStatus_ENROUTE_TO_PICKUP, TripStatus_ARRIVED_AT_PICKUP, TripStatus_ARRIVED_AT_INTERMEDIATE_DESTINATION, TripStatus_ENROUTE_TO_INTERMEDIATE_DESTINATION, TripStatus_ENROUTE_TO_DROPOFF, TripStatus_COMPLETE, TripStatus_CANCELED
const (
// Default, used for unspecified or unrecognized trip status.
TripStatus_UNKNOWN_TRIP_STATUS TripStatus = 0
// Newly created trip.
TripStatus_NEW TripStatus = 1
// The driver is on their way to the pickup point.
TripStatus_ENROUTE_TO_PICKUP TripStatus = 2
// The driver has arrived at the pickup point.
TripStatus_ARRIVED_AT_PICKUP TripStatus = 3
// The driver has arrived at an intermediate destination and is waiting for
// the rider.
TripStatus_ARRIVED_AT_INTERMEDIATE_DESTINATION TripStatus = 7
// The driver is on their way to an intermediate destination
// (not the dropoff point).
TripStatus_ENROUTE_TO_INTERMEDIATE_DESTINATION TripStatus = 8
// The driver has picked up the rider and is on their way to the
// next destination.
TripStatus_ENROUTE_TO_DROPOFF TripStatus = 4
// The rider has been dropped off and the trip is complete.
TripStatus_COMPLETE TripStatus = 5
// The trip was canceled prior to pickup by the driver, rider, or
// rideshare provider.
TripStatus_CANCELED TripStatus = 6
)func (TripStatus) Descriptor
func (TripStatus) Descriptor() protoreflect.EnumDescriptorfunc (TripStatus) Enum
func (x TripStatus) Enum() *TripStatusfunc (TripStatus) EnumDescriptor
func (TripStatus) EnumDescriptor() ([]byte, []int)Deprecated: Use TripStatus.Descriptor instead.
func (TripStatus) Number
func (x TripStatus) Number() protoreflect.EnumNumberfunc (TripStatus) String
func (x TripStatus) String() stringfunc (TripStatus) Type
func (TripStatus) Type() protoreflect.EnumTypeTripType
type TripType int32The type of a trip.
TripType_UNKNOWN_TRIP_TYPE, TripType_SHARED, TripType_EXCLUSIVE
const (
// Default, used for unspecified or unrecognized trip types.
TripType_UNKNOWN_TRIP_TYPE TripType = 0
// The trip may share a vehicle with other trips.
TripType_SHARED TripType = 1
// The trip is exclusive to a vehicle.
TripType_EXCLUSIVE TripType = 2
)func (TripType) Descriptor
func (TripType) Descriptor() protoreflect.EnumDescriptorfunc (TripType) Enum
func (TripType) EnumDescriptor
Deprecated: Use TripType.Descriptor instead.
func (TripType) Number
func (x TripType) Number() protoreflect.EnumNumberfunc (TripType) String
func (TripType) Type
func (TripType) Type() protoreflect.EnumTypeTripView
type TripView int32Selector for different sets of Trip fields in a GetTrip response. See
AIP-157 for context. Additional views are
likely to be added.
TripView_TRIP_VIEW_UNSPECIFIED, TripView_SDK, TripView_JOURNEY_SHARING_V1S
const (
// The default value. For backwards-compatibility, the API will default to an
// SDK view. To ensure stability and support, customers are
// advised to select a `TripView` other than `SDK`.
TripView_TRIP_VIEW_UNSPECIFIED TripView = 0
// Includes fields that may not be interpretable or supportable using
// publicly available libraries.
TripView_SDK TripView = 1
// Trip fields are populated for the Journey Sharing use case. This view is
// intended for server-to-server communications.
TripView_JOURNEY_SHARING_V1S TripView = 2
)func (TripView) Descriptor
func (TripView) Descriptor() protoreflect.EnumDescriptorfunc (TripView) Enum
func (TripView) EnumDescriptor
Deprecated: Use TripView.Descriptor instead.
func (TripView) Number
func (x TripView) Number() protoreflect.EnumNumberfunc (TripView) String
func (TripView) Type
func (TripView) Type() protoreflect.EnumTypeTripWaypoint
type TripWaypoint struct { // The location of this waypoint. Location *TerminalLocation `protobuf:"bytes,1,opt,name=location,proto3" json:"location,omitempty"` // The trip associated with this waypoint. TripId string `protobuf:"bytes,2,opt,name=trip_id,json=tripId,proto3" json:"trip_id,omitempty"` // The role this waypoint plays in this trip, such as pickup or dropoff. WaypointType WaypointType `protobuf:"varint,3,opt,name=waypoint_type,json=waypointType,proto3,enum=maps.fleetengine.v1.WaypointType" json:"waypoint_type,omitempty"` // The path from the previous waypoint to the current waypoint. Undefined for // the first waypoint in a list. This field is only populated when requested. PathToWaypoint []*latlng.LatLng `protobuf:"bytes,4,rep,name=path_to_waypoint,json=pathToWaypoint,proto3" json:"path_to_waypoint,omitempty"` // The encoded path from the previous waypoint to the current waypoint. // //
Note: This field is intended only for use by the Driver SDK and Consumer // SDK. Decoding is not yet supported. EncodedPathToWaypoint string `protobuf:"bytes,5,opt,name=encoded_path_to_waypoint,json=encodedPathToWaypoint,proto3" json:"encoded_path_to_waypoint,omitempty"` // The traffic conditions along the path to this waypoint. Note that traffic // is only available for Google Map Platform Rides and Deliveries Solution // customers. TrafficToWaypoint *ConsumableTrafficPolyline `protobuf:"bytes,10,opt,name=traffic_to_waypoint,json=trafficToWaypoint,proto3" json:"traffic_to_waypoint,omitempty"` // The path distance from the previous waypoint to the current waypoint. // Undefined for the first waypoint in a list. DistanceMeters *wrapperspb.Int32Value `protobuf:"bytes,6,opt,name=distance_meters,json=distanceMeters,proto3" json:"distance_meters,omitempty"` // The estimated time of arrival at this waypoint. Undefined for the first // waypoint in a list. Eta *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=eta,proto3" json:"eta,omitempty"` // The travel time from previous waypoint to this point. Undefined for the // first waypoint in a list. Duration *durationpb.Duration `protobuf:"bytes,8,opt,name=duration,proto3" json:"duration,omitempty"` // contains filtered or unexported fields }
Describes a stopping point on a vehicle's route or an ending point on a vehicle's trip.
func (*TripWaypoint) Descriptor
func (*TripWaypoint) Descriptor() ([]byte, []int)Deprecated: Use TripWaypoint.ProtoReflect.Descriptor instead.
func (*TripWaypoint) GetDistanceMeters
func (x *TripWaypoint) GetDistanceMeters() *wrapperspb.Int32Valuefunc (*TripWaypoint) GetDuration
func (x *TripWaypoint) GetDuration() *durationpb.Durationfunc (*TripWaypoint) GetEncodedPathToWaypoint
func (x *TripWaypoint) GetEncodedPathToWaypoint() stringfunc (*TripWaypoint) GetEta
func (x *TripWaypoint) GetEta() *timestamppb.Timestampfunc (*TripWaypoint) GetLocation
func (x *TripWaypoint) GetLocation() *TerminalLocationfunc (*TripWaypoint) GetPathToWaypoint
func (x *TripWaypoint) GetPathToWaypoint() []*latlng.LatLngfunc (*TripWaypoint) GetTrafficToWaypoint
func (x *TripWaypoint) GetTrafficToWaypoint() *ConsumableTrafficPolylinefunc (*TripWaypoint) GetTripId
func (x *TripWaypoint) GetTripId() stringfunc (*TripWaypoint) GetWaypointType
func (x *TripWaypoint) GetWaypointType() WaypointTypefunc (*TripWaypoint) ProtoMessage
func (*TripWaypoint) ProtoMessage()func (*TripWaypoint) ProtoReflect
func (x *TripWaypoint) ProtoReflect() protoreflect.Messagefunc (*TripWaypoint) Reset
func (x *TripWaypoint) Reset()func (*TripWaypoint) String
func (x *TripWaypoint) String() stringUnimplementedTripServiceServer
type UnimplementedTripServiceServer struct {
}UnimplementedTripServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedTripServiceServer) CreateTrip
func (UnimplementedTripServiceServer) CreateTrip(context.Context, *CreateTripRequest) (*Trip, error)func (UnimplementedTripServiceServer) DeleteTrip
func (UnimplementedTripServiceServer) DeleteTrip(context.Context, *DeleteTripRequest) (*emptypb.Empty, error)func (UnimplementedTripServiceServer) GetTrip
func (UnimplementedTripServiceServer) GetTrip(context.Context, *GetTripRequest) (*Trip, error)func (UnimplementedTripServiceServer) ReportBillableTrip
func (UnimplementedTripServiceServer) ReportBillableTrip(context.Context, *ReportBillableTripRequest) (*emptypb.Empty, error)func (UnimplementedTripServiceServer) SearchTrips
func (UnimplementedTripServiceServer) SearchTrips(context.Context, *SearchTripsRequest) (*SearchTripsResponse, error)func (UnimplementedTripServiceServer) UpdateTrip
func (UnimplementedTripServiceServer) UpdateTrip(context.Context, *UpdateTripRequest) (*Trip, error)UnimplementedVehicleServiceServer
type UnimplementedVehicleServiceServer struct {
}UnimplementedVehicleServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedVehicleServiceServer) CreateVehicle
func (UnimplementedVehicleServiceServer) CreateVehicle(context.Context, *CreateVehicleRequest) (*Vehicle, error)func (UnimplementedVehicleServiceServer) DeleteVehicle
func (UnimplementedVehicleServiceServer) DeleteVehicle(context.Context, *DeleteVehicleRequest) (*emptypb.Empty, error)func (UnimplementedVehicleServiceServer) GetVehicle
func (UnimplementedVehicleServiceServer) GetVehicle(context.Context, *GetVehicleRequest) (*Vehicle, error)func (UnimplementedVehicleServiceServer) ListVehicles
func (UnimplementedVehicleServiceServer) ListVehicles(context.Context, *ListVehiclesRequest) (*ListVehiclesResponse, error)func (UnimplementedVehicleServiceServer) SearchVehicles
func (UnimplementedVehicleServiceServer) SearchVehicles(context.Context, *SearchVehiclesRequest) (*SearchVehiclesResponse, error)func (UnimplementedVehicleServiceServer) UpdateVehicle
func (UnimplementedVehicleServiceServer) UpdateVehicle(context.Context, *UpdateVehicleRequest) (*Vehicle, error)func (UnimplementedVehicleServiceServer) UpdateVehicleAttributes
func (UnimplementedVehicleServiceServer) UpdateVehicleAttributes(context.Context, *UpdateVehicleAttributesRequest) (*UpdateVehicleAttributesResponse, error)UnsafeTripServiceServer
type UnsafeTripServiceServer interface {
// contains filtered or unexported methods
}UnsafeTripServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to TripServiceServer will result in compilation errors.
UnsafeVehicleServiceServer
type UnsafeVehicleServiceServer interface {
// contains filtered or unexported methods
}UnsafeVehicleServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to VehicleServiceServer will result in compilation errors.
UpdateTripRequest
type UpdateTripRequest struct {
// The standard Fleet Engine request header.
Header *RequestHeader `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
// Required. Must be in the format
// `providers/{provider}/trips/{trip}`. The provider must
// be the Project ID (for example, `sample-consumer-project`) of the Google
// Cloud Project of which the service account making this call is a member.
Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
// Required. The Trip associated with the update.
//
// The following fields are maintained by the Fleet Engine. Do not update
// them using Trip.update.
//
// * `current_route_segment`
// * `current_route_segment_end_point`
// * `current_route_segment_traffic`
// * `current_route_segment_traffic_version`
// * `current_route_segment_version`
// * `dropoff_time`
// * `eta_to_next_waypoint`
// * `intermediate_destinations_version`
// * `last_location`
// * `name`
// * `number_of_passengers`
// * `pickup_time`
// * `remaining_distance_meters`
// * `remaining_time_to_first_waypoint`
// * `remaining_waypoints`
// * `remaining_waypoints_version`
// * `route`
//
// When you update the `Trip.vehicle_id` for a shared trip, you must supply
// the list of `Trip.vehicle_waypoints` to specify the order of the remaining
// waypoints, otherwise the order will be undetermined.
//
// When you specify `Trip.vehicle_waypoints`, the list must contain all
// the remaining waypoints of the vehicle's trips, with no extra waypoints.
// You must order these waypoints such that for a given trip, the pickup
// point is before intermediate destinations, and all intermediate
// destinations come before the drop-off point. An `EXCLUSIVE` trip's
// waypoints must not interleave with any other trips.
// The `trip_id`, `waypoint_type` and `location` fields are used, and all
// other TripWaypoint fields in `vehicle_waypoints` are ignored.
//
// To avoid a race condition for trips with multiple destinations, you
// should provide `Trip.intermediate_destinations_version` when updating
// the trip status to `ENROUTE_TO_INTERMEDIATE_DESTINATION`. The
// `Trip.intermediate_destinations_version` passed must be consistent with
// Fleet Engine's version. If it isn't, the request fails.
Trip *Trip `protobuf:"bytes,4,opt,name=trip,proto3" json:"trip,omitempty"`
// Required. The field mask indicating which fields in Trip to update.
// The `update_mask` must contain at least one field.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,5,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}UpdateTrip request message.
func (*UpdateTripRequest) Descriptor
func (*UpdateTripRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateTripRequest.ProtoReflect.Descriptor instead.
func (*UpdateTripRequest) GetHeader
func (x *UpdateTripRequest) GetHeader() *RequestHeaderfunc (*UpdateTripRequest) GetName
func (x *UpdateTripRequest) GetName() stringfunc (*UpdateTripRequest) GetTrip
func (x *UpdateTripRequest) GetTrip() *Tripfunc (*UpdateTripRequest) GetUpdateMask
func (x *UpdateTripRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateTripRequest) ProtoMessage
func (*UpdateTripRequest) ProtoMessage()func (*UpdateTripRequest) ProtoReflect
func (x *UpdateTripRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateTripRequest) Reset
func (x *UpdateTripRequest) Reset()func (*UpdateTripRequest) String
func (x *UpdateTripRequest) String() stringUpdateVehicleAttributesRequest
type UpdateVehicleAttributesRequest struct {
// The standard Fleet Engine request header.
Header *RequestHeader `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
// Required. Must be in the format `providers/{provider}/vehicles/{vehicle}`.
// 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.
Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
// Required. The vehicle attributes to update. Unmentioned attributes are not
// altered or removed.
Attributes []*VehicleAttribute `protobuf:"bytes,4,rep,name=attributes,proto3" json:"attributes,omitempty"`
// contains filtered or unexported fields
}UpdateVehicleAttributes request message.
func (*UpdateVehicleAttributesRequest) Descriptor
func (*UpdateVehicleAttributesRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateVehicleAttributesRequest.ProtoReflect.Descriptor instead.
func (*UpdateVehicleAttributesRequest) GetAttributes
func (x *UpdateVehicleAttributesRequest) GetAttributes() []*VehicleAttributefunc (*UpdateVehicleAttributesRequest) GetHeader
func (x *UpdateVehicleAttributesRequest) GetHeader() *RequestHeaderfunc (*UpdateVehicleAttributesRequest) GetName
func (x *UpdateVehicleAttributesRequest) GetName() stringfunc (*UpdateVehicleAttributesRequest) ProtoMessage
func (*UpdateVehicleAttributesRequest) ProtoMessage()func (*UpdateVehicleAttributesRequest) ProtoReflect
func (x *UpdateVehicleAttributesRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateVehicleAttributesRequest) Reset
func (x *UpdateVehicleAttributesRequest) Reset()func (*UpdateVehicleAttributesRequest) String
func (x *UpdateVehicleAttributesRequest) String() stringUpdateVehicleAttributesResponse
type UpdateVehicleAttributesResponse struct {
// Required. The updated full list of vehicle attributes, including new,
// altered, and untouched attributes.
Attributes []*VehicleAttribute `protobuf:"bytes,1,rep,name=attributes,proto3" json:"attributes,omitempty"`
// contains filtered or unexported fields
}UpdateVehicleAttributes response message.
func (*UpdateVehicleAttributesResponse) Descriptor
func (*UpdateVehicleAttributesResponse) Descriptor() ([]byte, []int)Deprecated: Use UpdateVehicleAttributesResponse.ProtoReflect.Descriptor instead.
func (*UpdateVehicleAttributesResponse) GetAttributes
func (x *UpdateVehicleAttributesResponse) GetAttributes() []*VehicleAttributefunc (*UpdateVehicleAttributesResponse) ProtoMessage
func (*UpdateVehicleAttributesResponse) ProtoMessage()func (*UpdateVehicleAttributesResponse) ProtoReflect
func (x *UpdateVehicleAttributesResponse) ProtoReflect() protoreflect.Messagefunc (*UpdateVehicleAttributesResponse) Reset
func (x *UpdateVehicleAttributesResponse) Reset()func (*UpdateVehicleAttributesResponse) String
func (x *UpdateVehicleAttributesResponse) String() stringUpdateVehicleRequest
type UpdateVehicleRequest struct {
// The standard Fleet Engine request header.
Header *RequestHeader `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
// Required. Must be in the format
// `providers/{provider}/vehicles/{vehicle}`.
// 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.
Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
// Required. The `Vehicle` entity values to apply. When updating a `Vehicle`,
// the following fields may not be updated as they are managed by the
// server.
//
// * `available_capacity`
// * `current_route_segment_version`
// * `current_trips`
// * `name`
// * `waypoints_version`
//
// If the `attributes` field is updated, **all** the vehicle's attributes are
// replaced with the attributes provided in the request. If you want to update
// only some attributes, see the `UpdateVehicleAttributes` method.
//
// Likewise, the `waypoints` field can be updated, but must contain all the
// waypoints currently on the vehicle, and no other waypoints.
Vehicle *Vehicle `protobuf:"bytes,4,opt,name=vehicle,proto3" json:"vehicle,omitempty"`
// Required. A field mask indicating which fields of the `Vehicle` to update.
// At least one field name must be provided.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,5,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}`UpdateVehicle request message.
func (*UpdateVehicleRequest) Descriptor
func (*UpdateVehicleRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateVehicleRequest.ProtoReflect.Descriptor instead.
func (*UpdateVehicleRequest) GetHeader
func (x *UpdateVehicleRequest) GetHeader() *RequestHeaderfunc (*UpdateVehicleRequest) GetName
func (x *UpdateVehicleRequest) GetName() stringfunc (*UpdateVehicleRequest) GetUpdateMask
func (x *UpdateVehicleRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateVehicleRequest) GetVehicle
func (x *UpdateVehicleRequest) GetVehicle() *Vehiclefunc (*UpdateVehicleRequest) ProtoMessage
func (*UpdateVehicleRequest) ProtoMessage()func (*UpdateVehicleRequest) ProtoReflect
func (x *UpdateVehicleRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateVehicleRequest) Reset
func (x *UpdateVehicleRequest) Reset()func (*UpdateVehicleRequest) String
func (x *UpdateVehicleRequest) String() stringVehicle
type Vehicle struct {
// Output only. The unique name for this vehicle.
// The format is `providers/{provider}/vehicles/{vehicle}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The vehicle state.
VehicleState VehicleState `protobuf:"varint,2,opt,name=vehicle_state,json=vehicleState,proto3,enum=maps.fleetengine.v1.VehicleState" json:"vehicle_state,omitempty"`
// Trip types supported by this vehicle.
SupportedTripTypes []TripType `protobuf:"varint,3,rep,packed,name=supported_trip_types,json=supportedTripTypes,proto3,enum=maps.fleetengine.v1.TripType" json:"supported_trip_types,omitempty"`
// Output only. List of `trip_id`'s for trips currently assigned to this
// vehicle.
CurrentTrips []string `protobuf:"bytes,4,rep,name=current_trips,json=currentTrips,proto3" json:"current_trips,omitempty"`
// Last reported location of the vehicle.
LastLocation *VehicleLocation `protobuf:"bytes,5,opt,name=last_location,json=lastLocation,proto3" json:"last_location,omitempty"`
// Input only. Locations where this vehicle has been in the past that haven't
// yet been reported to Fleet Engine. This is used in `UpdateVehicleRequest`
// to record locations which were previously unable to be sent to the server.
// Typically this happens when the vehicle does not have internet
// connectivity.
PastLocations []*VehicleLocation `protobuf:"bytes,30,rep,name=past_locations,json=pastLocations,proto3" json:"past_locations,omitempty"`
// The total numbers of riders this vehicle can carry. The driver is not
// considered in this value. This value must be greater than or equal to one.
MaximumCapacity int32 `protobuf:"varint,6,opt,name=maximum_capacity,json=maximumCapacity,proto3" json:"maximum_capacity,omitempty"`
// List of vehicle attributes. A vehicle can have at most 100
// attributes, and each attribute must have a unique key.
Attributes []*VehicleAttribute `protobuf:"bytes,8,rep,name=attributes,proto3" json:"attributes,omitempty"`
// Required. The type of this vehicle. Can be used to filter vehicles in
// `SearchVehicles` results. Also influences ETA and route calculations.
VehicleType *Vehicle_VehicleType `protobuf:"bytes,9,opt,name=vehicle_type,json=vehicleType,proto3" json:"vehicle_type,omitempty"`
// License plate information for the vehicle.
LicensePlate *LicensePlate `protobuf:"bytes,10,opt,name=license_plate,json=licensePlate,proto3" json:"license_plate,omitempty"`
// Deprecated: Use `Vehicle.waypoints` instead.
//
// Deprecated: Marked as deprecated in google/maps/fleetengine/v1/vehicles.proto.
Route []*TerminalLocation `protobuf:"bytes,12,rep,name=route,proto3" json:"route,omitempty"`
// The polyline specifying the route the driver app intends to take to
// the next waypoint. This list is also returned in
// `Trip.current_route_segment` for all active trips assigned to the vehicle.
//
// Note: This field is intended only for use by the Driver SDK. Decoding is
// not yet supported.
CurrentRouteSegment string `protobuf:"bytes,20,opt,name=current_route_segment,json=currentRouteSegment,proto3" json:"current_route_segment,omitempty"`
// Input only. Fleet Engine uses this information to improve journey sharing.
// Note: This field is intended only for use by the Driver SDK.
CurrentRouteSegmentTraffic *TrafficPolylineData `protobuf:"bytes,28,opt,name=current_route_segment_traffic,json=currentRouteSegmentTraffic,proto3" json:"current_route_segment_traffic,omitempty"`
// Output only. Time when `current_route_segment` was set. It can be stored by
// the client and passed in future `GetVehicle` requests to prevent returning
// routes that haven't changed.
CurrentRouteSegmentVersion *timestamppb.Timestamp `protobuf:"bytes,15,opt,name=current_route_segment_version,json=currentRouteSegmentVersion,proto3" json:"current_route_segment_version,omitempty"`
// The waypoint where `current_route_segment` ends. This can be supplied by
// drivers on `UpdateVehicle` calls either as a full trip waypoint, a waypoint
// `LatLng`, or as the last `LatLng` of the `current_route_segment`. Fleet
// Engine will then do its best to interpolate to an actual waypoint if it is
// not fully specified. This field is ignored in `UpdateVehicle` calls unless
// `current_route_segment` is also specified.
CurrentRouteSegmentEndPoint *TripWaypoint `protobuf:"bytes,24,opt,name=current_route_segment_end_point,json=currentRouteSegmentEndPoint,proto3" json:"current_route_segment_end_point,omitempty"`
// The remaining driving distance for the `current_route_segment`.
// This value is also returned in `Trip.remaining_distance_meters` for all
// active trips assigned to the vehicle. The value is unspecified if the
// `current_route_segment` field is empty.
RemainingDistanceMeters *wrapperspb.Int32Value `protobuf:"bytes,18,opt,name=remaining_distance_meters,json=remainingDistanceMeters,proto3" json:"remaining_distance_meters,omitempty"`
// The ETA to the first entry in the `waypoints` field. The value is
// unspecified if the `waypoints` field is empty or the
// `Vehicle.current_route_segment` field is empty.
//
// When updating a vehicle, `remaining_time_seconds` takes precedence over
// `eta_to_first_waypoint` in the same request.
EtaToFirstWaypoint *timestamppb.Timestamp `protobuf:"bytes,19,opt,name=eta_to_first_waypoint,json=etaToFirstWaypoint,proto3" json:"eta_to_first_waypoint,omitempty"`
// Input only. The remaining driving time for the `current_route_segment`. The
// value is unspecified if the `waypoints` field is empty or the
// `Vehicle.current_route_segment` field is empty. This value should match
// `eta_to_first_waypoint` - `current_time` if all parties are using the same
// clock.
//
// When updating a vehicle, `remaining_time_seconds` takes precedence over
// `eta_to_first_waypoint` in the same request.
RemainingTimeSeconds *wrapperspb.Int32Value `protobuf:"bytes,25,opt,name=remaining_time_seconds,json=remainingTimeSeconds,proto3" json:"remaining_time_seconds,omitempty"`
// The remaining waypoints assigned to this Vehicle.
Waypoints []*TripWaypoint `protobuf:"bytes,22,rep,name=waypoints,proto3" json:"waypoints,omitempty"`
// Output only. Last time the `waypoints` field was updated. Clients should
// cache this value and pass it in `GetVehicleRequest` to ensure the
// `waypoints` field is only returned if it is updated.
WaypointsVersion *timestamppb.Timestamp `protobuf:"bytes,16,opt,name=waypoints_version,json=waypointsVersion,proto3" json:"waypoints_version,omitempty"`
// Indicates if the driver accepts back-to-back trips. If `true`,
// `SearchVehicles` may include the vehicle even if it is currently assigned
// to a trip. The default value is `false`.
BackToBackEnabled bool `protobuf:"varint,23,opt,name=back_to_back_enabled,json=backToBackEnabled,proto3" json:"back_to_back_enabled,omitempty"`
// The vehicle's navigation status.
NavigationStatus NavigationStatus `protobuf:"varint,26,opt,name=navigation_status,json=navigationStatus,proto3,enum=maps.fleetengine.v1.NavigationStatus" json:"navigation_status,omitempty"`
// Input only. Information about settings in the mobile device being used by
// the driver.
DeviceSettings *DeviceSettings `protobuf:"bytes,27,opt,name=device_settings,json=deviceSettings,proto3" json:"device_settings,omitempty"`
// contains filtered or unexported fields
}Vehicle metadata.
func (*Vehicle) Descriptor
Deprecated: Use Vehicle.ProtoReflect.Descriptor instead.
func (*Vehicle) GetAttributes
func (x *Vehicle) GetAttributes() []*VehicleAttributefunc (*Vehicle) GetBackToBackEnabled
func (*Vehicle) GetCurrentRouteSegment
func (*Vehicle) GetCurrentRouteSegmentEndPoint
func (x *Vehicle) GetCurrentRouteSegmentEndPoint() *TripWaypointfunc (*Vehicle) GetCurrentRouteSegmentTraffic
func (x *Vehicle) GetCurrentRouteSegmentTraffic() *TrafficPolylineDatafunc (*Vehicle) GetCurrentRouteSegmentVersion
func (x *Vehicle) GetCurrentRouteSegmentVersion() *timestamppb.Timestampfunc (*Vehicle) GetCurrentTrips
func (*Vehicle) GetDeviceSettings
func (x *Vehicle) GetDeviceSettings() *DeviceSettingsfunc (*Vehicle) GetEtaToFirstWaypoint
func (x *Vehicle) GetEtaToFirstWaypoint() *timestamppb.Timestampfunc (*Vehicle) GetLastLocation
func (x *Vehicle) GetLastLocation() *VehicleLocationfunc (*Vehicle) GetLicensePlate
func (x *Vehicle) GetLicensePlate() *LicensePlatefunc (*Vehicle) GetMaximumCapacity
func (*Vehicle) GetName
func (*Vehicle) GetNavigationStatus
func (x *Vehicle) GetNavigationStatus() NavigationStatusfunc (*Vehicle) GetPastLocations
func (x *Vehicle) GetPastLocations() []*VehicleLocationfunc (*Vehicle) GetRemainingDistanceMeters
func (x *Vehicle) GetRemainingDistanceMeters() *wrapperspb.Int32Valuefunc (*Vehicle) GetRemainingTimeSeconds
func (x *Vehicle) GetRemainingTimeSeconds() *wrapperspb.Int32Valuefunc (*Vehicle) GetRoute
func (x *Vehicle) GetRoute() []*TerminalLocationDeprecated: Marked as deprecated in google/maps/fleetengine/v1/vehicles.proto.
func (*Vehicle) GetSupportedTripTypes
func (*Vehicle) GetVehicleState
func (x *Vehicle) GetVehicleState() VehicleStatefunc (*Vehicle) GetVehicleType
func (x *Vehicle) GetVehicleType() *Vehicle_VehicleTypefunc (*Vehicle) GetWaypoints
func (x *Vehicle) GetWaypoints() []*TripWaypointfunc (*Vehicle) GetWaypointsVersion
func (x *Vehicle) GetWaypointsVersion() *timestamppb.Timestampfunc (*Vehicle) ProtoMessage
func (*Vehicle) ProtoMessage()func (*Vehicle) ProtoReflect
func (x *Vehicle) ProtoReflect() protoreflect.Messagefunc (*Vehicle) Reset
func (x *Vehicle) Reset()func (*Vehicle) String
VehicleAttribute
type VehicleAttribute struct {
// The attribute's key. Keys may not contain the colon character (:).
Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
// The attribute's value.
Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
// The attribute's value, can be in string, bool, or double type.
//
// Types that are assignable to VehicleAttributeValue:
//
// *VehicleAttribute_StringValue
// *VehicleAttribute_BoolValue
// *VehicleAttribute_NumberValue
VehicleAttributeValue isVehicleAttribute_VehicleAttributeValue `protobuf_oneof:"vehicle_attribute_value"`
// contains filtered or unexported fields
}Describes a vehicle attribute as a key-value pair. The "key:value" string length cannot exceed 256 characters.
func (*VehicleAttribute) Descriptor
func (*VehicleAttribute) Descriptor() ([]byte, []int)Deprecated: Use VehicleAttribute.ProtoReflect.Descriptor instead.
func (*VehicleAttribute) GetBoolValue
func (x *VehicleAttribute) GetBoolValue() boolfunc (*VehicleAttribute) GetKey
func (x *VehicleAttribute) GetKey() stringfunc (*VehicleAttribute) GetNumberValue
func (x *VehicleAttribute) GetNumberValue() float64func (*VehicleAttribute) GetStringValue
func (x *VehicleAttribute) GetStringValue() stringfunc (*VehicleAttribute) GetValue
func (x *VehicleAttribute) GetValue() stringfunc (*VehicleAttribute) GetVehicleAttributeValue
func (m *VehicleAttribute) GetVehicleAttributeValue() isVehicleAttribute_VehicleAttributeValuefunc (*VehicleAttribute) ProtoMessage
func (*VehicleAttribute) ProtoMessage()func (*VehicleAttribute) ProtoReflect
func (x *VehicleAttribute) ProtoReflect() protoreflect.Messagefunc (*VehicleAttribute) Reset
func (x *VehicleAttribute) Reset()func (*VehicleAttribute) String
func (x *VehicleAttribute) String() stringVehicleAttributeList
type VehicleAttributeList struct {
// A list of attributes in this collection.
Attributes []*VehicleAttribute `protobuf:"bytes,1,rep,name=attributes,proto3" json:"attributes,omitempty"`
// contains filtered or unexported fields
}A list-of-lists datatype for vehicle attributes.
func (*VehicleAttributeList) Descriptor
func (*VehicleAttributeList) Descriptor() ([]byte, []int)Deprecated: Use VehicleAttributeList.ProtoReflect.Descriptor instead.
func (*VehicleAttributeList) GetAttributes
func (x *VehicleAttributeList) GetAttributes() []*VehicleAttributefunc (*VehicleAttributeList) ProtoMessage
func (*VehicleAttributeList) ProtoMessage()func (*VehicleAttributeList) ProtoReflect
func (x *VehicleAttributeList) ProtoReflect() protoreflect.Messagefunc (*VehicleAttributeList) Reset
func (x *VehicleAttributeList) Reset()func (*VehicleAttributeList) String
func (x *VehicleAttributeList) String() stringVehicleAttribute_BoolValue
type VehicleAttribute_BoolValue struct {
// Boolean typed attribute value.
BoolValue bool `protobuf:"varint,4,opt,name=bool_value,json=boolValue,proto3,oneof"`
}VehicleAttribute_NumberValue
type VehicleAttribute_NumberValue struct {
// Double typed attribute value.
NumberValue float64 `protobuf:"fixed64,5,opt,name=number_value,json=numberValue,proto3,oneof"`
}VehicleAttribute_StringValue
type VehicleAttribute_StringValue struct {
// String typed attribute value.
//
// Note: This is identical to the `value` field which will eventually be
// deprecated. For create or update methods, either field can be used, but
// it's strongly recommended to use `string_value`. If both `string_value`
// and `value` are set, they must be identical or an error will be thrown.
// Both fields are populated in responses.
StringValue string `protobuf:"bytes,3,opt,name=string_value,json=stringValue,proto3,oneof"`
}VehicleLocation
type VehicleLocation struct {
// The location of the vehicle.
// When it is sent to Fleet Engine, the vehicle's location is a GPS location.
// When you receive it in a response, the vehicle's location can be either a
// GPS location, a supplemental location, or some other estimated location.
// The source is specified in `location_sensor`.
Location *latlng.LatLng `protobuf:"bytes,1,opt,name=location,proto3" json:"location,omitempty"`
// Deprecated: Use `latlng_accuracy` instead.
//
// Deprecated: Marked as deprecated in google/maps/fleetengine/v1/fleetengine.proto.
HorizontalAccuracy *wrapperspb.DoubleValue `protobuf:"bytes,8,opt,name=horizontal_accuracy,json=horizontalAccuracy,proto3" json:"horizontal_accuracy,omitempty"`
// Accuracy of `location` in meters as a radius.
LatlngAccuracy *wrapperspb.DoubleValue `protobuf:"bytes,22,opt,name=latlng_accuracy,json=latlngAccuracy,proto3" json:"latlng_accuracy,omitempty"`
// Direction the vehicle is moving in degrees. 0 represents North.
// The valid range is [0,360).
Heading *wrapperspb.Int32Value `protobuf:"bytes,2,opt,name=heading,proto3" json:"heading,omitempty"`
// Deprecated: Use `heading_accuracy` instead.
//
// Deprecated: Marked as deprecated in google/maps/fleetengine/v1/fleetengine.proto.
BearingAccuracy *wrapperspb.DoubleValue `protobuf:"bytes,10,opt,name=bearing_accuracy,json=bearingAccuracy,proto3" json:"bearing_accuracy,omitempty"`
// Accuracy of `heading` in degrees.
HeadingAccuracy *wrapperspb.DoubleValue `protobuf:"bytes,23,opt,name=heading_accuracy,json=headingAccuracy,proto3" json:"heading_accuracy,omitempty"`
// Altitude in meters above WGS84.
Altitude *wrapperspb.DoubleValue `protobuf:"bytes,5,opt,name=altitude,proto3" json:"altitude,omitempty"`
// Deprecated: Use `altitude_accuracy` instead.
//
// Deprecated: Marked as deprecated in google/maps/fleetengine/v1/fleetengine.proto.
VerticalAccuracy *wrapperspb.DoubleValue `protobuf:"bytes,9,opt,name=vertical_accuracy,json=verticalAccuracy,proto3" json:"vertical_accuracy,omitempty"`
// Accuracy of `altitude` in meters.
AltitudeAccuracy *wrapperspb.DoubleValue `protobuf:"bytes,24,opt,name=altitude_accuracy,json=altitudeAccuracy,proto3" json:"altitude_accuracy,omitempty"`
// Speed of the vehicle in kilometers per hour.
// Deprecated: Use `speed` instead.
//
// Deprecated: Marked as deprecated in google/maps/fleetengine/v1/fleetengine.proto.
SpeedKmph *wrapperspb.Int32Value `protobuf:"bytes,3,opt,name=speed_kmph,json=speedKmph,proto3" json:"speed_kmph,omitempty"`
// Speed of the vehicle in meters/second
Speed *wrapperspb.DoubleValue `protobuf:"bytes,6,opt,name=speed,proto3" json:"speed,omitempty"`
// Accuracy of `speed` in meters/second.
SpeedAccuracy *wrapperspb.DoubleValue `protobuf:"bytes,7,opt,name=speed_accuracy,json=speedAccuracy,proto3" json:"speed_accuracy,omitempty"`
// The time when `location` was reported by the sensor according to the
// sensor's clock.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Output only. The time when the server received the location information.
ServerTime *timestamppb.Timestamp `protobuf:"bytes,13,opt,name=server_time,json=serverTime,proto3" json:"server_time,omitempty"`
// Provider of location data (for example, `GPS`).
LocationSensor LocationSensor `protobuf:"varint,11,opt,name=location_sensor,json=locationSensor,proto3,enum=maps.fleetengine.v1.LocationSensor" json:"location_sensor,omitempty"`
// Whether `location` is snapped to a road.
IsRoadSnapped *wrapperspb.BoolValue `protobuf:"bytes,27,opt,name=is_road_snapped,json=isRoadSnapped,proto3" json:"is_road_snapped,omitempty"`
// Input only. Indicates whether the GPS sensor is enabled on the mobile
// device.
IsGpsSensorEnabled *wrapperspb.BoolValue `protobuf:"bytes,12,opt,name=is_gps_sensor_enabled,json=isGpsSensorEnabled,proto3" json:"is_gps_sensor_enabled,omitempty"`
// Input only. Time (in seconds) since this location was first sent to the
// server. This will be zero for the first update. If the time is unknown (for
// example, when the app restarts), this value resets to zero.
TimeSinceUpdate *wrapperspb.Int32Value `protobuf:"bytes,14,opt,name=time_since_update,json=timeSinceUpdate,proto3" json:"time_since_update,omitempty"`
// Input only. Deprecated: Other signals are now used to determine if a
// location is stale.
//
// Deprecated: Marked as deprecated in google/maps/fleetengine/v1/fleetengine.proto.
NumStaleUpdates *wrapperspb.Int32Value `protobuf:"bytes,15,opt,name=num_stale_updates,json=numStaleUpdates,proto3" json:"num_stale_updates,omitempty"`
// Raw vehicle location (unprocessed by road-snapper).
RawLocation *latlng.LatLng `protobuf:"bytes,16,opt,name=raw_location,json=rawLocation,proto3" json:"raw_location,omitempty"`
// Timestamp associated with the raw location.
RawLocationTime *timestamppb.Timestamp `protobuf:"bytes,17,opt,name=raw_location_time,json=rawLocationTime,proto3" json:"raw_location_time,omitempty"`
// Source of the raw location. Defaults to `GPS`.
RawLocationSensor LocationSensor `protobuf:"varint,28,opt,name=raw_location_sensor,json=rawLocationSensor,proto3,enum=maps.fleetengine.v1.LocationSensor" json:"raw_location_sensor,omitempty"`
// Accuracy of `raw_location` as a radius, in meters.
RawLocationAccuracy *wrapperspb.DoubleValue `protobuf:"bytes,25,opt,name=raw_location_accuracy,json=rawLocationAccuracy,proto3" json:"raw_location_accuracy,omitempty"`
// The location from Android's Fused Location Provider.
FlpLocation *latlng.LatLng `protobuf:"bytes,29,opt,name=flp_location,json=flpLocation,proto3" json:"flp_location,omitempty"`
// Update timestamp of `flp_location`.
FlpUpdateTime *timestamppb.Timestamp `protobuf:"bytes,30,opt,name=flp_update_time,json=flpUpdateTime,proto3" json:"flp_update_time,omitempty"`
// Accuracy of `flp_location` in meters as a radius.
FlpLatlngAccuracyMeters *wrapperspb.DoubleValue `protobuf:"bytes,31,opt,name=flp_latlng_accuracy_meters,json=flpLatlngAccuracyMeters,proto3" json:"flp_latlng_accuracy_meters,omitempty"`
// Direction the vehicle is moving in degrees, as determined by the Fused
// Location Provider. 0 represents North. The valid range is [0,360).
FlpHeadingDegrees *wrapperspb.Int32Value `protobuf:"bytes,32,opt,name=flp_heading_degrees,json=flpHeadingDegrees,proto3" json:"flp_heading_degrees,omitempty"`
// Supplemental location provided by the integrating app.
SupplementalLocation *latlng.LatLng `protobuf:"bytes,18,opt,name=supplemental_location,json=supplementalLocation,proto3" json:"supplemental_location,omitempty"`
// Timestamp associated with the supplemental location.
SupplementalLocationTime *timestamppb.Timestamp `protobuf:"bytes,19,opt,name=supplemental_location_time,json=supplementalLocationTime,proto3" json:"supplemental_location_time,omitempty"`
// Source of the supplemental location. Defaults to
// `CUSTOMER_SUPPLIED_LOCATION`.
SupplementalLocationSensor LocationSensor `protobuf:"varint,20,opt,name=supplemental_location_sensor,json=supplementalLocationSensor,proto3,enum=maps.fleetengine.v1.LocationSensor" json:"supplemental_location_sensor,omitempty"`
// Accuracy of `supplemental_location` as a radius, in meters.
SupplementalLocationAccuracy *wrapperspb.DoubleValue `protobuf:"bytes,21,opt,name=supplemental_location_accuracy,json=supplementalLocationAccuracy,proto3" json:"supplemental_location_accuracy,omitempty"`
// Deprecated: Use `is_road_snapped` instead.
//
// Deprecated: Marked as deprecated in google/maps/fleetengine/v1/fleetengine.proto.
RoadSnapped bool `protobuf:"varint,26,opt,name=road_snapped,json=roadSnapped,proto3" json:"road_snapped,omitempty"`
// contains filtered or unexported fields
}The location, speed, and heading of a vehicle at a point in time.
func (*VehicleLocation) Descriptor
func (*VehicleLocation) Descriptor() ([]byte, []int)Deprecated: Use VehicleLocation.ProtoReflect.Descriptor instead.
func (*VehicleLocation) GetAltitude
func (x *VehicleLocation) GetAltitude() *wrapperspb.DoubleValuefunc (*VehicleLocation) GetAltitudeAccuracy
func (x *VehicleLocation) GetAltitudeAccuracy() *wrapperspb.DoubleValuefunc (*VehicleLocation) GetBearingAccuracy
func (x *VehicleLocation) GetBearingAccuracy() *wrapperspb.DoubleValueDeprecated: Marked as deprecated in google/maps/fleetengine/v1/fleetengine.proto.
func (*VehicleLocation) GetFlpHeadingDegrees
func (x *VehicleLocation) GetFlpHeadingDegrees() *wrapperspb.Int32Valuefunc (*VehicleLocation) GetFlpLatlngAccuracyMeters
func (x *VehicleLocation) GetFlpLatlngAccuracyMeters() *wrapperspb.DoubleValuefunc (*VehicleLocation) GetFlpLocation
func (x *VehicleLocation) GetFlpLocation() *latlng.LatLngfunc (*VehicleLocation) GetFlpUpdateTime
func (x *VehicleLocation) GetFlpUpdateTime() *timestamppb.Timestampfunc (*VehicleLocation) GetHeading
func (x *VehicleLocation) GetHeading() *wrapperspb.Int32Valuefunc (*VehicleLocation) GetHeadingAccuracy
func (x *VehicleLocation) GetHeadingAccuracy() *wrapperspb.DoubleValuefunc (*VehicleLocation) GetHorizontalAccuracy
func (x *VehicleLocation) GetHorizontalAccuracy() *wrapperspb.DoubleValueDeprecated: Marked as deprecated in google/maps/fleetengine/v1/fleetengine.proto.
func (*VehicleLocation) GetIsGpsSensorEnabled
func (x *VehicleLocation) GetIsGpsSensorEnabled() *wrapperspb.BoolValuefunc (*VehicleLocation) GetIsRoadSnapped
func (x *VehicleLocation) GetIsRoadSnapped() *wrapperspb.BoolValuefunc (*VehicleLocation) GetLatlngAccuracy
func (x *VehicleLocation) GetLatlngAccuracy() *wrapperspb.DoubleValuefunc (*VehicleLocation) GetLocation
func (x *VehicleLocation) GetLocation() *latlng.LatLngfunc (*VehicleLocation) GetLocationSensor
func (x *VehicleLocation) GetLocationSensor() LocationSensorfunc (*VehicleLocation) GetNumStaleUpdates
func (x *VehicleLocation) GetNumStaleUpdates() *wrapperspb.Int32ValueDeprecated: Marked as deprecated in google/maps/fleetengine/v1/fleetengine.proto.
func (*VehicleLocation) GetRawLocation
func (x *VehicleLocation) GetRawLocation() *latlng.LatLngfunc (*VehicleLocation) GetRawLocationAccuracy
func (x *VehicleLocation) GetRawLocationAccuracy() *wrapperspb.DoubleValuefunc (*VehicleLocation) GetRawLocationSensor
func (x *VehicleLocation) GetRawLocationSensor() LocationSensorfunc (*VehicleLocation) GetRawLocationTime
func (x *VehicleLocation) GetRawLocationTime() *timestamppb.Timestampfunc (*VehicleLocation) GetRoadSnapped
func (x *VehicleLocation) GetRoadSnapped() boolDeprecated: Marked as deprecated in google/maps/fleetengine/v1/fleetengine.proto.
func (*VehicleLocation) GetServerTime
func (x *VehicleLocation) GetServerTime() *timestamppb.Timestampfunc (*VehicleLocation) GetSpeed
func (x *VehicleLocation) GetSpeed() *wrapperspb.DoubleValuefunc (*VehicleLocation) GetSpeedAccuracy
func (x *VehicleLocation) GetSpeedAccuracy() *wrapperspb.DoubleValuefunc (*VehicleLocation) GetSpeedKmph
func (x *VehicleLocation) GetSpeedKmph() *wrapperspb.Int32ValueDeprecated: Marked as deprecated in google/maps/fleetengine/v1/fleetengine.proto.
func (*VehicleLocation) GetSupplementalLocation
func (x *VehicleLocation) GetSupplementalLocation() *latlng.LatLngfunc (*VehicleLocation) GetSupplementalLocationAccuracy
func (x *VehicleLocation) GetSupplementalLocationAccuracy() *wrapperspb.DoubleValuefunc (*VehicleLocation) GetSupplementalLocationSensor
func (x *VehicleLocation) GetSupplementalLocationSensor() LocationSensorfunc (*VehicleLocation) GetSupplementalLocationTime
func (x *VehicleLocation) GetSupplementalLocationTime() *timestamppb.Timestampfunc (*VehicleLocation) GetTimeSinceUpdate
func (x *VehicleLocation) GetTimeSinceUpdate() *wrapperspb.Int32Valuefunc (*VehicleLocation) GetUpdateTime
func (x *VehicleLocation) GetUpdateTime() *timestamppb.Timestampfunc (*VehicleLocation) GetVerticalAccuracy
func (x *VehicleLocation) GetVerticalAccuracy() *wrapperspb.DoubleValueDeprecated: Marked as deprecated in google/maps/fleetengine/v1/fleetengine.proto.
func (*VehicleLocation) ProtoMessage
func (*VehicleLocation) ProtoMessage()func (*VehicleLocation) ProtoReflect
func (x *VehicleLocation) ProtoReflect() protoreflect.Messagefunc (*VehicleLocation) Reset
func (x *VehicleLocation) Reset()func (*VehicleLocation) String
func (x *VehicleLocation) String() stringVehicleMatch
type VehicleMatch struct {
// Required. A vehicle that matches the request.
Vehicle *Vehicle `protobuf:"bytes,1,opt,name=vehicle,proto3" json:"vehicle,omitempty"`
// The vehicle's driving ETA to the pickup point specified in the
// request. An empty value indicates a failure in calculating ETA for the
// vehicle. If `SearchVehiclesRequest.include_back_to_back` was `true` and
// this vehicle has an active trip, `vehicle_pickup_eta` includes the time
// required to complete the current active trip.
VehiclePickupEta *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=vehicle_pickup_eta,json=vehiclePickupEta,proto3" json:"vehicle_pickup_eta,omitempty"`
// The distance from the Vehicle's current location to the pickup point
// specified in the request, including any intermediate pickup or dropoff
// points for existing trips. This distance comprises the calculated driving
// (route) distance, plus the straight line distance between the navigation
// end point and the requested pickup point. (The distance between the
// navigation end point and the requested pickup point is typically small.) An
// empty value indicates an error in calculating the distance.
VehiclePickupDistanceMeters *wrapperspb.Int32Value `protobuf:"bytes,3,opt,name=vehicle_pickup_distance_meters,json=vehiclePickupDistanceMeters,proto3" json:"vehicle_pickup_distance_meters,omitempty"`
// Required. The straight-line distance between the vehicle and the pickup
// point specified in the request.
VehiclePickupStraightLineDistanceMeters *wrapperspb.Int32Value `protobuf:"bytes,11,opt,name=vehicle_pickup_straight_line_distance_meters,json=vehiclePickupStraightLineDistanceMeters,proto3" json:"vehicle_pickup_straight_line_distance_meters,omitempty"`
// The complete vehicle's driving ETA to the drop off point specified in the
// request. The ETA includes stopping at any waypoints before the
// `dropoff_point` specified in the request. The value will only be populated
// when a drop off point is specified in the request. An empty value indicates
// an error calculating the ETA.
VehicleDropoffEta *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=vehicle_dropoff_eta,json=vehicleDropoffEta,proto3" json:"vehicle_dropoff_eta,omitempty"`
// The vehicle's driving distance (in meters) from the pickup point
// to the drop off point specified in the request. The distance is only
// between the two points and does not include the vehicle location or any
// other points that must be visited before the vehicle visits either the
// pickup point or dropoff point. The value will only be populated when a
// `dropoff_point` is specified in the request. An empty value indicates
// a failure in calculating the distance from the pickup to
// drop off point specified in the request.
VehiclePickupToDropoffDistanceMeters *wrapperspb.Int32Value `protobuf:"bytes,5,opt,name=vehicle_pickup_to_dropoff_distance_meters,json=vehiclePickupToDropoffDistanceMeters,proto3" json:"vehicle_pickup_to_dropoff_distance_meters,omitempty"`
// Required. The trip type of the request that was used to calculate the ETA
// to the pickup point.
TripType TripType `protobuf:"varint,6,opt,name=trip_type,json=tripType,proto3,enum=maps.fleetengine.v1.TripType" json:"trip_type,omitempty"`
// The ordered list of waypoints used to calculate the ETA. The list
// includes vehicle location, the pickup points of active
// trips for the vehicle, and the pickup points provided in the
// request. An empty list indicates a failure in calculating ETA for the
// vehicle.
VehicleTripsWaypoints []*Waypoint `protobuf:"bytes,7,rep,name=vehicle_trips_waypoints,json=vehicleTripsWaypoints,proto3" json:"vehicle_trips_waypoints,omitempty"`
// Type of the vehicle match.
VehicleMatchType VehicleMatch_VehicleMatchType `protobuf:"varint,8,opt,name=vehicle_match_type,json=vehicleMatchType,proto3,enum=maps.fleetengine.v1.VehicleMatch_VehicleMatchType" json:"vehicle_match_type,omitempty"`
// The order requested for sorting vehicle matches. Equivalent to
// `ordered_by`.
RequestedOrderedBy SearchVehiclesRequest_VehicleMatchOrder `protobuf:"varint,9,opt,name=requested_ordered_by,json=requestedOrderedBy,proto3,enum=maps.fleetengine.v1.SearchVehiclesRequest_VehicleMatchOrder" json:"requested_ordered_by,omitempty"`
// The order requested for sorting vehicle matches. Equivalent to
// `requested_ordered_by`.
OrderedBy SearchVehiclesRequest_VehicleMatchOrder `protobuf:"varint,10,opt,name=ordered_by,json=orderedBy,proto3,enum=maps.fleetengine.v1.SearchVehiclesRequest_VehicleMatchOrder" json:"ordered_by,omitempty"`
// contains filtered or unexported fields
}Contains the vehicle and related estimates for a vehicle that match the
points of active trips for the vehicle SearchVehiclesRequest.
func (*VehicleMatch) Descriptor
func (*VehicleMatch) Descriptor() ([]byte, []int)Deprecated: Use VehicleMatch.ProtoReflect.Descriptor instead.
func (*VehicleMatch) GetOrderedBy
func (x *VehicleMatch) GetOrderedBy() SearchVehiclesRequest_VehicleMatchOrderfunc (*VehicleMatch) GetRequestedOrderedBy
func (x *VehicleMatch) GetRequestedOrderedBy() SearchVehiclesRequest_VehicleMatchOrderfunc (*VehicleMatch) GetTripType
func (x *VehicleMatch) GetTripType() TripTypefunc (*VehicleMatch) GetVehicle
func (x *VehicleMatch) GetVehicle() *Vehiclefunc (*VehicleMatch) GetVehicleDropoffEta
func (x *VehicleMatch) GetVehicleDropoffEta() *timestamppb.Timestampfunc (*VehicleMatch) GetVehicleMatchType
func (x *VehicleMatch) GetVehicleMatchType() VehicleMatch_VehicleMatchTypefunc (*VehicleMatch) GetVehiclePickupDistanceMeters
func (x *VehicleMatch) GetVehiclePickupDistanceMeters() *wrapperspb.Int32Valuefunc (*VehicleMatch) GetVehiclePickupEta
func (x *VehicleMatch) GetVehiclePickupEta() *timestamppb.Timestampfunc (*VehicleMatch) GetVehiclePickupStraightLineDistanceMeters
func (x *VehicleMatch) GetVehiclePickupStraightLineDistanceMeters() *wrapperspb.Int32Valuefunc (*VehicleMatch) GetVehiclePickupToDropoffDistanceMeters
func (x *VehicleMatch) GetVehiclePickupToDropoffDistanceMeters() *wrapperspb.Int32Valuefunc (*VehicleMatch) GetVehicleTripsWaypoints
func (x *VehicleMatch) GetVehicleTripsWaypoints() []*Waypointfunc (*VehicleMatch) ProtoMessage
func (*VehicleMatch) ProtoMessage()func (*VehicleMatch) ProtoReflect
func (x *VehicleMatch) ProtoReflect() protoreflect.Messagefunc (*VehicleMatch) Reset
func (x *VehicleMatch) Reset()func (*VehicleMatch) String
func (x *VehicleMatch) String() stringVehicleMatch_VehicleMatchType
type VehicleMatch_VehicleMatchType int32Type of vehicle match.
VehicleMatch_UNKNOWN, VehicleMatch_EXCLUSIVE, VehicleMatch_BACK_TO_BACK, VehicleMatch_CARPOOL, VehicleMatch_CARPOOL_BACK_TO_BACK
const (
// Unknown vehicle match type
VehicleMatch_UNKNOWN VehicleMatch_VehicleMatchType = 0
// The vehicle currently has no trip assigned to it and can proceed to the
// pickup point.
VehicleMatch_EXCLUSIVE VehicleMatch_VehicleMatchType = 1
// The vehicle is currently assigned to a trip, but can proceed to the
// pickup point after completing the in-progress trip. ETA and distance
// calculations take the existing trip into account.
VehicleMatch_BACK_TO_BACK VehicleMatch_VehicleMatchType = 2
// The vehicle has sufficient capacity for a shared ride.
VehicleMatch_CARPOOL VehicleMatch_VehicleMatchType = 3
// The vehicle will finish its current, active trip before proceeding to the
// pickup point. ETA and distance calculations take the existing trip into
// account.
VehicleMatch_CARPOOL_BACK_TO_BACK VehicleMatch_VehicleMatchType = 4
)func (VehicleMatch_VehicleMatchType) Descriptor
func (VehicleMatch_VehicleMatchType) Descriptor() protoreflect.EnumDescriptorfunc (VehicleMatch_VehicleMatchType) Enum
func (x VehicleMatch_VehicleMatchType) Enum() *VehicleMatch_VehicleMatchTypefunc (VehicleMatch_VehicleMatchType) EnumDescriptor
func (VehicleMatch_VehicleMatchType) EnumDescriptor() ([]byte, []int)Deprecated: Use VehicleMatch_VehicleMatchType.Descriptor instead.
func (VehicleMatch_VehicleMatchType) Number
func (x VehicleMatch_VehicleMatchType) Number() protoreflect.EnumNumberfunc (VehicleMatch_VehicleMatchType) String
func (x VehicleMatch_VehicleMatchType) String() stringfunc (VehicleMatch_VehicleMatchType) Type
func (VehicleMatch_VehicleMatchType) Type() protoreflect.EnumTypeVehicleServiceClient
type VehicleServiceClient interface {
// Instantiates a new vehicle associated with an on-demand rideshare or
// deliveries provider. Each `Vehicle` must have a unique vehicle ID.
//
// The following `Vehicle` fields are required when creating a `Vehicle`:
//
// * `vehicleState`
// * `supportedTripTypes`
// * `maximumCapacity`
// * `vehicleType`
//
// The following `Vehicle` fields are ignored when creating a `Vehicle`:
//
// * `name`
// * `currentTrips`
// * `availableCapacity`
// * `current_route_segment`
// * `current_route_segment_end_point`
// * `current_route_segment_version`
// * `current_route_segment_traffic`
// * `route`
// * `waypoints`
// * `waypoints_version`
// * `remaining_distance_meters`
// * `remaining_time_seconds`
// * `eta_to_next_waypoint`
// * `navigation_status`
//
// All other fields are optional and used if provided.
CreateVehicle(ctx context.Context, in *CreateVehicleRequest, opts ...grpc.CallOption) (*Vehicle, error)
// Returns a vehicle from the Fleet Engine.
GetVehicle(ctx context.Context, in *GetVehicleRequest, opts ...grpc.CallOption) (*Vehicle, error)
// Deletes a Vehicle from the Fleet Engine.
//
// Returns FAILED_PRECONDITION if the Vehicle has active Trips.
// assigned to it.
DeleteVehicle(ctx context.Context, in *DeleteVehicleRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Writes updated vehicle data to the Fleet Engine.
//
// When updating a `Vehicle`, the following fields cannot be updated since
// they are managed by the server:
//
// * `currentTrips`
// * `availableCapacity`
// * `current_route_segment_version`
// * `waypoints_version`
//
// The vehicle `name` also cannot be updated.
//
// If the `attributes` field is updated, **all** the vehicle's attributes are
// replaced with the attributes provided in the request. If you want to update
// only some attributes, see the `UpdateVehicleAttributes` method. Likewise,
// the `waypoints` field can be updated, but must contain all the waypoints
// currently on the vehicle, and no other waypoints.
UpdateVehicle(ctx context.Context, in *UpdateVehicleRequest, opts ...grpc.CallOption) (*Vehicle, error)
// Partially updates a vehicle's attributes.
// Only the attributes mentioned in the request will be updated, other
// attributes will NOT be altered. Note: this is different in `UpdateVehicle`,
// where the whole `attributes` field will be replaced by the one in
// `UpdateVehicleRequest`, attributes not in the request would be removed.
UpdateVehicleAttributes(ctx context.Context, in *UpdateVehicleAttributesRequest, opts ...grpc.CallOption) (*UpdateVehicleAttributesResponse, error)
// Returns a paginated list of vehicles associated with
// a provider that match the request options.
ListVehicles(ctx context.Context, in *ListVehiclesRequest, opts ...grpc.CallOption) (*ListVehiclesResponse, error)
// Returns a list of vehicles that match the request options.
SearchVehicles(ctx context.Context, in *SearchVehiclesRequest, opts ...grpc.CallOption) (*SearchVehiclesResponse, error)
}VehicleServiceClient is the client API for VehicleService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewVehicleServiceClient
func NewVehicleServiceClient(cc grpc.ClientConnInterface) VehicleServiceClientVehicleServiceServer
type VehicleServiceServer interface {
// Instantiates a new vehicle associated with an on-demand rideshare or
// deliveries provider. Each `Vehicle` must have a unique vehicle ID.
//
// The following `Vehicle` fields are required when creating a `Vehicle`:
//
// * `vehicleState`
// * `supportedTripTypes`
// * `maximumCapacity`
// * `vehicleType`
//
// The following `Vehicle` fields are ignored when creating a `Vehicle`:
//
// * `name`
// * `currentTrips`
// * `availableCapacity`
// * `current_route_segment`
// * `current_route_segment_end_point`
// * `current_route_segment_version`
// * `current_route_segment_traffic`
// * `route`
// * `waypoints`
// * `waypoints_version`
// * `remaining_distance_meters`
// * `remaining_time_seconds`
// * `eta_to_next_waypoint`
// * `navigation_status`
//
// All other fields are optional and used if provided.
CreateVehicle(context.Context, *CreateVehicleRequest) (*Vehicle, error)
// Returns a vehicle from the Fleet Engine.
GetVehicle(context.Context, *GetVehicleRequest) (*Vehicle, error)
// Deletes a Vehicle from the Fleet Engine.
//
// Returns FAILED_PRECONDITION if the Vehicle has active Trips.
// assigned to it.
DeleteVehicle(context.Context, *DeleteVehicleRequest) (*emptypb.Empty, error)
// Writes updated vehicle data to the Fleet Engine.
//
// When updating a `Vehicle`, the following fields cannot be updated since
// they are managed by the server:
//
// * `currentTrips`
// * `availableCapacity`
// * `current_route_segment_version`
// * `waypoints_version`
//
// The vehicle `name` also cannot be updated.
//
// If the `attributes` field is updated, **all** the vehicle's attributes are
// replaced with the attributes provided in the request. If you want to update
// only some attributes, see the `UpdateVehicleAttributes` method. Likewise,
// the `waypoints` field can be updated, but must contain all the waypoints
// currently on the vehicle, and no other waypoints.
UpdateVehicle(context.Context, *UpdateVehicleRequest) (*Vehicle, error)
// Partially updates a vehicle's attributes.
// Only the attributes mentioned in the request will be updated, other
// attributes will NOT be altered. Note: this is different in `UpdateVehicle`,
// where the whole `attributes` field will be replaced by the one in
// `UpdateVehicleRequest`, attributes not in the request would be removed.
UpdateVehicleAttributes(context.Context, *UpdateVehicleAttributesRequest) (*UpdateVehicleAttributesResponse, error)
// Returns a paginated list of vehicles associated with
// a provider that match the request options.
ListVehicles(context.Context, *ListVehiclesRequest) (*ListVehiclesResponse, error)
// Returns a list of vehicles that match the request options.
SearchVehicles(context.Context, *SearchVehiclesRequest) (*SearchVehiclesResponse, error)
}VehicleServiceServer is the server API for VehicleService service. All implementations should embed UnimplementedVehicleServiceServer for forward compatibility
VehicleState
type VehicleState int32The state of a Vehicle.
VehicleState_UNKNOWN_VEHICLE_STATE, VehicleState_OFFLINE, VehicleState_ONLINE
const (
// Default, used for unspecified or unrecognized vehicle states.
VehicleState_UNKNOWN_VEHICLE_STATE VehicleState = 0
// The vehicle is not accepting new trips. Note: the vehicle may continue to
// operate in this state while completing a trip assigned to it.
VehicleState_OFFLINE VehicleState = 1
// The vehicle is accepting new trips.
VehicleState_ONLINE VehicleState = 2
)func (VehicleState) Descriptor
func (VehicleState) Descriptor() protoreflect.EnumDescriptorfunc (VehicleState) Enum
func (x VehicleState) Enum() *VehicleStatefunc (VehicleState) EnumDescriptor
func (VehicleState) EnumDescriptor() ([]byte, []int)Deprecated: Use VehicleState.Descriptor instead.
func (VehicleState) Number
func (x VehicleState) Number() protoreflect.EnumNumberfunc (VehicleState) String
func (x VehicleState) String() stringfunc (VehicleState) Type
func (VehicleState) Type() protoreflect.EnumTypeVehicle_VehicleType
type Vehicle_VehicleType struct {
// Vehicle type category
Category Vehicle_VehicleType_Category `protobuf:"varint,1,opt,name=category,proto3,enum=maps.fleetengine.v1.Vehicle_VehicleType_Category" json:"category,omitempty"`
// contains filtered or unexported fields
}The type of vehicle.
func (*Vehicle_VehicleType) Descriptor
func (*Vehicle_VehicleType) Descriptor() ([]byte, []int)Deprecated: Use Vehicle_VehicleType.ProtoReflect.Descriptor instead.
func (*Vehicle_VehicleType) GetCategory
func (x *Vehicle_VehicleType) GetCategory() Vehicle_VehicleType_Categoryfunc (*Vehicle_VehicleType) ProtoMessage
func (*Vehicle_VehicleType) ProtoMessage()func (*Vehicle_VehicleType) ProtoReflect
func (x *Vehicle_VehicleType) ProtoReflect() protoreflect.Messagefunc (*Vehicle_VehicleType) Reset
func (x *Vehicle_VehicleType) Reset()func (*Vehicle_VehicleType) String
func (x *Vehicle_VehicleType) String() stringVehicle_VehicleType_Category
type Vehicle_VehicleType_Category int32Vehicle type categories
Vehicle_VehicleType_UNKNOWN, Vehicle_VehicleType_AUTO, Vehicle_VehicleType_TAXI, Vehicle_VehicleType_TRUCK, Vehicle_VehicleType_TWO_WHEELER, Vehicle_VehicleType_BICYCLE, Vehicle_VehicleType_PEDESTRIAN
const (
// Default, used for unspecified or unrecognized vehicle categories.
Vehicle_VehicleType_UNKNOWN Vehicle_VehicleType_Category = 0
// An automobile.
Vehicle_VehicleType_AUTO Vehicle_VehicleType_Category = 1
// Any vehicle that acts as a taxi (typically licensed or regulated).
Vehicle_VehicleType_TAXI Vehicle_VehicleType_Category = 2
// Generally, a vehicle with a large storage capacity.
Vehicle_VehicleType_TRUCK Vehicle_VehicleType_Category = 3
// A motorcycle, moped, or other two-wheeled vehicle
Vehicle_VehicleType_TWO_WHEELER Vehicle_VehicleType_Category = 4
// Human-powered transport.
Vehicle_VehicleType_BICYCLE Vehicle_VehicleType_Category = 5
// A human transporter, typically walking or running, traveling along
// pedestrian pathways.
Vehicle_VehicleType_PEDESTRIAN Vehicle_VehicleType_Category = 6
)func (Vehicle_VehicleType_Category) Descriptor
func (Vehicle_VehicleType_Category) Descriptor() protoreflect.EnumDescriptorfunc (Vehicle_VehicleType_Category) Enum
func (x Vehicle_VehicleType_Category) Enum() *Vehicle_VehicleType_Categoryfunc (Vehicle_VehicleType_Category) EnumDescriptor
func (Vehicle_VehicleType_Category) EnumDescriptor() ([]byte, []int)Deprecated: Use Vehicle_VehicleType_Category.Descriptor instead.
func (Vehicle_VehicleType_Category) Number
func (x Vehicle_VehicleType_Category) Number() protoreflect.EnumNumberfunc (Vehicle_VehicleType_Category) String
func (x Vehicle_VehicleType_Category) String() stringfunc (Vehicle_VehicleType_Category) Type
func (Vehicle_VehicleType_Category) Type() protoreflect.EnumTypeVisualTrafficReportPolylineRendering
type VisualTrafficReportPolylineRendering struct {
// Optional. Road stretches that should be rendered along the polyline.
// Stretches are guaranteed to not overlap, and do not necessarily span the
// full route.
//
// In the absence of a road stretch to style, the client should apply the
// default for the route.
RoadStretch []*VisualTrafficReportPolylineRendering_RoadStretch `protobuf:"bytes,1,rep,name=road_stretch,json=roadStretch,proto3" json:"road_stretch,omitempty"`
// contains filtered or unexported fields
}Describes how clients should color one portion of the polyline along the route.
func (*VisualTrafficReportPolylineRendering) Descriptor
func (*VisualTrafficReportPolylineRendering) Descriptor() ([]byte, []int)Deprecated: Use VisualTrafficReportPolylineRendering.ProtoReflect.Descriptor instead.
func (*VisualTrafficReportPolylineRendering) GetRoadStretch
func (x *VisualTrafficReportPolylineRendering) GetRoadStretch() []*VisualTrafficReportPolylineRendering_RoadStretchfunc (*VisualTrafficReportPolylineRendering) ProtoMessage
func (*VisualTrafficReportPolylineRendering) ProtoMessage()func (*VisualTrafficReportPolylineRendering) ProtoReflect
func (x *VisualTrafficReportPolylineRendering) ProtoReflect() protoreflect.Messagefunc (*VisualTrafficReportPolylineRendering) Reset
func (x *VisualTrafficReportPolylineRendering) Reset()func (*VisualTrafficReportPolylineRendering) String
func (x *VisualTrafficReportPolylineRendering) String() stringVisualTrafficReportPolylineRendering_RoadStretch
type VisualTrafficReportPolylineRendering_RoadStretch struct {
// Required. The style to apply.
Style VisualTrafficReportPolylineRendering_RoadStretch_Style `protobuf:"varint,1,opt,name=style,proto3,enum=maps.fleetengine.v1.VisualTrafficReportPolylineRendering_RoadStretch_Style" json:"style,omitempty"`
// Required. The style should be applied between `[offset_meters,
// offset_meters + length_meters)`.
OffsetMeters int32 `protobuf:"varint,2,opt,name=offset_meters,json=offsetMeters,proto3" json:"offset_meters,omitempty"`
// Required. The length of the path where to apply the style.
LengthMeters int32 `protobuf:"varint,3,opt,name=length_meters,json=lengthMeters,proto3" json:"length_meters,omitempty"`
// contains filtered or unexported fields
}One road stretch that should be rendered.
func (*VisualTrafficReportPolylineRendering_RoadStretch) Descriptor
func (*VisualTrafficReportPolylineRendering_RoadStretch) Descriptor() ([]byte, []int)Deprecated: Use VisualTrafficReportPolylineRendering_RoadStretch.ProtoReflect.Descriptor instead.
func (*VisualTrafficReportPolylineRendering_RoadStretch) GetLengthMeters
func (x *VisualTrafficReportPolylineRendering_RoadStretch) GetLengthMeters() int32func (*VisualTrafficReportPolylineRendering_RoadStretch) GetOffsetMeters
func (x *VisualTrafficReportPolylineRendering_RoadStretch) GetOffsetMeters() int32func (*VisualTrafficReportPolylineRendering_RoadStretch) GetStyle
func (x *VisualTrafficReportPolylineRendering_RoadStretch) GetStyle() VisualTrafficReportPolylineRendering_RoadStretch_Stylefunc (*VisualTrafficReportPolylineRendering_RoadStretch) ProtoMessage
func (*VisualTrafficReportPolylineRendering_RoadStretch) ProtoMessage()func (*VisualTrafficReportPolylineRendering_RoadStretch) ProtoReflect
func (x *VisualTrafficReportPolylineRendering_RoadStretch) ProtoReflect() protoreflect.Messagefunc (*VisualTrafficReportPolylineRendering_RoadStretch) Reset
func (x *VisualTrafficReportPolylineRendering_RoadStretch) Reset()func (*VisualTrafficReportPolylineRendering_RoadStretch) String
func (x *VisualTrafficReportPolylineRendering_RoadStretch) String() stringVisualTrafficReportPolylineRendering_RoadStretch_Style
type VisualTrafficReportPolylineRendering_RoadStretch_Style int32The traffic style, indicating traffic speed.
VisualTrafficReportPolylineRendering_RoadStretch_STYLE_UNSPECIFIED, VisualTrafficReportPolylineRendering_RoadStretch_SLOWER_TRAFFIC, VisualTrafficReportPolylineRendering_RoadStretch_TRAFFIC_JAM
const (
// No style selected.
VisualTrafficReportPolylineRendering_RoadStretch_STYLE_UNSPECIFIED VisualTrafficReportPolylineRendering_RoadStretch_Style = 0
// Traffic is slowing down.
VisualTrafficReportPolylineRendering_RoadStretch_SLOWER_TRAFFIC VisualTrafficReportPolylineRendering_RoadStretch_Style = 1
// There is a traffic jam.
VisualTrafficReportPolylineRendering_RoadStretch_TRAFFIC_JAM VisualTrafficReportPolylineRendering_RoadStretch_Style = 2
)func (VisualTrafficReportPolylineRendering_RoadStretch_Style) Descriptor
func (VisualTrafficReportPolylineRendering_RoadStretch_Style) Descriptor() protoreflect.EnumDescriptorfunc (VisualTrafficReportPolylineRendering_RoadStretch_Style) Enum
func (x VisualTrafficReportPolylineRendering_RoadStretch_Style) Enum() *VisualTrafficReportPolylineRendering_RoadStretch_Stylefunc (VisualTrafficReportPolylineRendering_RoadStretch_Style) EnumDescriptor
func (VisualTrafficReportPolylineRendering_RoadStretch_Style) EnumDescriptor() ([]byte, []int)Deprecated: Use VisualTrafficReportPolylineRendering_RoadStretch_Style.Descriptor instead.
func (VisualTrafficReportPolylineRendering_RoadStretch_Style) Number
func (x VisualTrafficReportPolylineRendering_RoadStretch_Style) Number() protoreflect.EnumNumberfunc (VisualTrafficReportPolylineRendering_RoadStretch_Style) String
func (x VisualTrafficReportPolylineRendering_RoadStretch_Style) String() stringfunc (VisualTrafficReportPolylineRendering_RoadStretch_Style) Type
Waypoint
type Waypoint struct {
// The location of this waypoint.
LatLng *latlng.LatLng `protobuf:"bytes,1,opt,name=lat_lng,json=latLng,proto3" json:"lat_lng,omitempty"`
// The estimated time that the vehicle will arrive at this waypoint.
Eta *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=eta,proto3" json:"eta,omitempty"`
// contains filtered or unexported fields
}Describes intermediate points along a route for a VehicleMatch in a
SearchVehiclesResponse. This concept is represented as a TripWaypoint in
all other endpoints.
func (*Waypoint) Descriptor
Deprecated: Use Waypoint.ProtoReflect.Descriptor instead.
func (*Waypoint) GetEta
func (x *Waypoint) GetEta() *timestamppb.Timestampfunc (*Waypoint) GetLatLng
func (*Waypoint) ProtoMessage
func (*Waypoint) ProtoMessage()func (*Waypoint) ProtoReflect
func (x *Waypoint) ProtoReflect() protoreflect.Messagefunc (*Waypoint) Reset
func (x *Waypoint) Reset()func (*Waypoint) String
WaypointType
type WaypointType int32The type of waypoint.
WaypointType_UNKNOWN_WAYPOINT_TYPE, WaypointType_PICKUP_WAYPOINT_TYPE, WaypointType_DROP_OFF_WAYPOINT_TYPE, WaypointType_INTERMEDIATE_DESTINATION_WAYPOINT_TYPE
const (
// Unknown or unspecified waypoint type.
WaypointType_UNKNOWN_WAYPOINT_TYPE WaypointType = 0
// Waypoints for picking up riders or items.
WaypointType_PICKUP_WAYPOINT_TYPE WaypointType = 1
// Waypoints for dropping off riders or items.
WaypointType_DROP_OFF_WAYPOINT_TYPE WaypointType = 2
// Waypoints for intermediate destinations in a multi-destination trip.
WaypointType_INTERMEDIATE_DESTINATION_WAYPOINT_TYPE WaypointType = 3
)func (WaypointType) Descriptor
func (WaypointType) Descriptor() protoreflect.EnumDescriptorfunc (WaypointType) Enum
func (x WaypointType) Enum() *WaypointTypefunc (WaypointType) EnumDescriptor
func (WaypointType) EnumDescriptor() ([]byte, []int)Deprecated: Use WaypointType.Descriptor instead.
func (WaypointType) Number
func (x WaypointType) Number() protoreflect.EnumNumberfunc (WaypointType) String
func (x WaypointType) String() stringfunc (WaypointType) Type
func (WaypointType) Type() protoreflect.EnumType