Last Mile Fleet Solution Delivery API v1 - Package cloud.google.com/go/maps/fleetengine/delivery/apiv1/deliverypb (v1.35.0)

1.35.0 (latest) 1.34.0 1.33.0 1.32.0 1.31.0 1.30.0 1.29.0 1.28.0 1.27.0 1.26.0 1.25.0 1.24.0 1.23.0 1.22.0 1.21.1 1.20.4 1.19.0 1.18.0 1.17.1 1.16.0 1.15.0 1.14.1 1.13.0 1.12.1 1.11.7 1.10.0 1.9.0 1.8.0 1.7.3 1.6.4 1.5.1 1.4.0 1.3.0 1.2.1 1.1.0 1.0.1 0.7.0 0.6.0 0.5.0 0.2.0 0.1.0

Note: To get more information about this package, such as access to older versions, view this package on pkg.go.dev.

Constants

DeliveryService_CreateDeliveryVehicle_FullMethodName, DeliveryService_GetDeliveryVehicle_FullMethodName, DeliveryService_DeleteDeliveryVehicle_FullMethodName, DeliveryService_UpdateDeliveryVehicle_FullMethodName, DeliveryService_BatchCreateTasks_FullMethodName, DeliveryService_CreateTask_FullMethodName, DeliveryService_GetTask_FullMethodName, DeliveryService_DeleteTask_FullMethodName, DeliveryService_UpdateTask_FullMethodName, DeliveryService_ListTasks_FullMethodName, DeliveryService_GetTaskTrackingInfo_FullMethodName, DeliveryService_ListDeliveryVehicles_FullMethodName

const (
	DeliveryService_CreateDeliveryVehicle_FullMethodName = "/maps.fleetengine.delivery.v1.DeliveryService/CreateDeliveryVehicle"
	DeliveryService_GetDeliveryVehicle_FullMethodName    = "/maps.fleetengine.delivery.v1.DeliveryService/GetDeliveryVehicle"
	DeliveryService_DeleteDeliveryVehicle_FullMethodName = "/maps.fleetengine.delivery.v1.DeliveryService/DeleteDeliveryVehicle"
	DeliveryService_UpdateDeliveryVehicle_FullMethodName = "/maps.fleetengine.delivery.v1.DeliveryService/UpdateDeliveryVehicle"
	DeliveryService_BatchCreateTasks_FullMethodName      = "/maps.fleetengine.delivery.v1.DeliveryService/BatchCreateTasks"
	DeliveryService_CreateTask_FullMethodName            = "/maps.fleetengine.delivery.v1.DeliveryService/CreateTask"
	DeliveryService_GetTask_FullMethodName               = "/maps.fleetengine.delivery.v1.DeliveryService/GetTask"
	DeliveryService_DeleteTask_FullMethodName            = "/maps.fleetengine.delivery.v1.DeliveryService/DeleteTask"
	DeliveryService_UpdateTask_FullMethodName            = "/maps.fleetengine.delivery.v1.DeliveryService/UpdateTask"
	DeliveryService_ListTasks_FullMethodName             = "/maps.fleetengine.delivery.v1.DeliveryService/ListTasks"
	DeliveryService_GetTaskTrackingInfo_FullMethodName   = "/maps.fleetengine.delivery.v1.DeliveryService/GetTaskTrackingInfo"
	DeliveryService_ListDeliveryVehicles_FullMethodName  = "/maps.fleetengine.delivery.v1.DeliveryService/ListDeliveryVehicles"
)

Variables

DeliveryVehicleLocationSensor_name, DeliveryVehicleLocationSensor_value

var (
	DeliveryVehicleLocationSensor_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",
	}
	DeliveryVehicleLocationSensor_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 DeliveryVehicleLocationSensor.

DeliveryVehicleNavigationStatus_name, DeliveryVehicleNavigationStatus_value

var (
	DeliveryVehicleNavigationStatus_name = map[int32]string{
		0: "UNKNOWN_NAVIGATION_STATUS",
		1: "NO_GUIDANCE",
		2: "ENROUTE_TO_DESTINATION",
		3: "OFF_ROUTE",
		4: "ARRIVED_AT_DESTINATION",
	}
	DeliveryVehicleNavigationStatus_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 DeliveryVehicleNavigationStatus.

DeliveryVehicle_DeliveryVehicleType_name, DeliveryVehicle_DeliveryVehicleType_value

var (
	DeliveryVehicle_DeliveryVehicleType_name = map[int32]string{
		0: "DELIVERY_VEHICLE_TYPE_UNSPECIFIED",
		1: "AUTO",
		2: "TWO_WHEELER",
		3: "BICYCLE",
		4: "PEDESTRIAN",
	}
	DeliveryVehicle_DeliveryVehicleType_value = map[string]int32{
		"DELIVERY_VEHICLE_TYPE_UNSPECIFIED": 0,
		"AUTO":                              1,
		"TWO_WHEELER":                       2,
		"BICYCLE":                           3,
		"PEDESTRIAN":                        4,
	}
)

Enum value maps for DeliveryVehicle_DeliveryVehicleType.

VehicleStop_State_name, VehicleStop_State_value

var (
	VehicleStop_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "NEW",
		2: "ENROUTE",
		3: "ARRIVED",
	}
	VehicleStop_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"NEW":               1,
		"ENROUTE":           2,
		"ARRIVED":           3,
	}
)

Enum value maps for VehicleStop_State.

DeliveryRequestHeader_SdkType_name, DeliveryRequestHeader_SdkType_value

var (
	DeliveryRequestHeader_SdkType_name = map[int32]string{
		0: "SDK_TYPE_UNSPECIFIED",
		1: "CONSUMER",
		2: "DRIVER",
		3: "JAVASCRIPT",
	}
	DeliveryRequestHeader_SdkType_value = map[string]int32{
		"SDK_TYPE_UNSPECIFIED": 0,
		"CONSUMER":             1,
		"DRIVER":               2,
		"JAVASCRIPT":           3,
	}
)

Enum value maps for DeliveryRequestHeader_SdkType.

DeliveryRequestHeader_Platform_name, DeliveryRequestHeader_Platform_value

var (
	DeliveryRequestHeader_Platform_name = map[int32]string{
		0: "PLATFORM_UNSPECIFIED",
		1: "ANDROID",
		2: "IOS",
		3: "WEB",
	}
	DeliveryRequestHeader_Platform_value = map[string]int32{
		"PLATFORM_UNSPECIFIED": 0,
		"ANDROID":              1,
		"IOS":                  2,
		"WEB":                  3,
	}
)

Enum value maps for DeliveryRequestHeader_Platform.

Task_Type_name, Task_Type_value

var (
	Task_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "PICKUP",
		2: "DELIVERY",
		3: "SCHEDULED_STOP",
		4: "UNAVAILABLE",
	}
	Task_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED": 0,
		"PICKUP":           1,
		"DELIVERY":         2,
		"SCHEDULED_STOP":   3,
		"UNAVAILABLE":      4,
	}
)

Enum value maps for Task_Type.

Task_State_name, Task_State_value

var (
	Task_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "OPEN",
		2: "CLOSED",
	}
	Task_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"OPEN":              1,
		"CLOSED":            2,
	}
)

Enum value maps for Task_State.

Task_TaskOutcome_name, Task_TaskOutcome_value

var (
	Task_TaskOutcome_name = map[int32]string{
		0: "TASK_OUTCOME_UNSPECIFIED",
		1: "SUCCEEDED",
		2: "FAILED",
	}
	Task_TaskOutcome_value = map[string]int32{
		"TASK_OUTCOME_UNSPECIFIED": 0,
		"SUCCEEDED":                1,
		"FAILED":                   2,
	}
)

Enum value maps for Task_TaskOutcome.

Task_TaskOutcomeLocationSource_name, Task_TaskOutcomeLocationSource_value

var (
	Task_TaskOutcomeLocationSource_name = map[int32]string{
		0: "TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED",
		2: "PROVIDER",
		3: "LAST_VEHICLE_LOCATION",
	}
	Task_TaskOutcomeLocationSource_value = map[string]int32{
		"TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED": 0,
		"PROVIDER":              2,
		"LAST_VEHICLE_LOCATION": 3,
	}
)

Enum value maps for Task_TaskOutcomeLocationSource.

DeliveryService_ServiceDesc

var DeliveryService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "maps.fleetengine.delivery.v1.DeliveryService",
	HandlerType: (*DeliveryServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateDeliveryVehicle",
			Handler:    _DeliveryService_CreateDeliveryVehicle_Handler,
		},
		{
			MethodName: "GetDeliveryVehicle",
			Handler:    _DeliveryService_GetDeliveryVehicle_Handler,
		},
		{
			MethodName: "DeleteDeliveryVehicle",
			Handler:    _DeliveryService_DeleteDeliveryVehicle_Handler,
		},
		{
			MethodName: "UpdateDeliveryVehicle",
			Handler:    _DeliveryService_UpdateDeliveryVehicle_Handler,
		},
		{
			MethodName: "BatchCreateTasks",
			Handler:    _DeliveryService_BatchCreateTasks_Handler,
		},
		{
			MethodName: "CreateTask",
			Handler:    _DeliveryService_CreateTask_Handler,
		},
		{
			MethodName: "GetTask",
			Handler:    _DeliveryService_GetTask_Handler,
		},
		{
			MethodName: "DeleteTask",
			Handler:    _DeliveryService_DeleteTask_Handler,
		},
		{
			MethodName: "UpdateTask",
			Handler:    _DeliveryService_UpdateTask_Handler,
		},
		{
			MethodName: "ListTasks",
			Handler:    _DeliveryService_ListTasks_Handler,
		},
		{
			MethodName: "GetTaskTrackingInfo",
			Handler:    _DeliveryService_GetTaskTrackingInfo_Handler,
		},
		{
			MethodName: "ListDeliveryVehicles",
			Handler:    _DeliveryService_ListDeliveryVehicles_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/maps/fleetengine/delivery/v1/delivery_api.proto",
}

DeliveryService_ServiceDesc is the grpc.ServiceDesc for DeliveryService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

File_google_maps_fleetengine_delivery_v1_common_proto

var File_google_maps_fleetengine_delivery_v1_common_proto protoreflect.FileDescriptor

File_google_maps_fleetengine_delivery_v1_delivery_api_proto

var File_google_maps_fleetengine_delivery_v1_delivery_api_proto protoreflect.FileDescriptor

File_google_maps_fleetengine_delivery_v1_delivery_vehicles_proto

var File_google_maps_fleetengine_delivery_v1_delivery_vehicles_proto protoreflect.FileDescriptor

File_google_maps_fleetengine_delivery_v1_header_proto

var File_google_maps_fleetengine_delivery_v1_header_proto protoreflect.FileDescriptor

File_google_maps_fleetengine_delivery_v1_task_tracking_info_proto

var File_google_maps_fleetengine_delivery_v1_task_tracking_info_proto protoreflect.FileDescriptor

File_google_maps_fleetengine_delivery_v1_tasks_proto

var File_google_maps_fleetengine_delivery_v1_tasks_proto protoreflect.FileDescriptor

Functions

func RegisterDeliveryServiceServer

func RegisterDeliveryServiceServer(s grpc.ServiceRegistrar, srv DeliveryServiceServer)

BatchCreateTasksRequest

type BatchCreateTasksRequest struct {

	// Optional. The standard Delivery API request header.
	// Note: If you set this field, then the header field in the
	// `CreateTaskRequest` messages must either be empty, or it must match this
	// field.
	Header *DeliveryRequestHeader `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
	// Required. The parent resource shared by all tasks. This value must be in
	// the format `providers/{provider}`. The `provider` must be the Google Cloud
	// Project ID. For example, `sample-cloud-project`. The parent field in the
	// `CreateTaskRequest` messages must either  be empty, or it must match this
	// field.
	Parent string `protobuf:"bytes,3,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The request message that specifies the resources to create.
	// Note: You can create a maximum of 500 tasks in a batch.
	Requests []*CreateTaskRequest `protobuf:"bytes,4,rep,name=requests,proto3" json:"requests,omitempty"`
	// contains filtered or unexported fields
}

The BatchCreateTask request message.

func (*BatchCreateTasksRequest) Descriptor

func (*BatchCreateTasksRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchCreateTasksRequest.ProtoReflect.Descriptor instead.

func (*BatchCreateTasksRequest) GetHeader

func (x *BatchCreateTasksRequest) GetHeader() *DeliveryRequestHeader

func (*BatchCreateTasksRequest) GetParent

func (x *BatchCreateTasksRequest) GetParent() string

func (*BatchCreateTasksRequest) GetRequests

func (x *BatchCreateTasksRequest) GetRequests() []*CreateTaskRequest

func (*BatchCreateTasksRequest) ProtoMessage

func (*BatchCreateTasksRequest) ProtoMessage()

func (*BatchCreateTasksRequest) ProtoReflect

func (x *BatchCreateTasksRequest) ProtoReflect() protoreflect.Message

func (*BatchCreateTasksRequest) Reset

func (x *BatchCreateTasksRequest) Reset()

func (*BatchCreateTasksRequest) String

func (x *BatchCreateTasksRequest) String() string

BatchCreateTasksResponse

type BatchCreateTasksResponse struct {

	// The created Tasks.
	Tasks []*Task `protobuf:"bytes,1,rep,name=tasks,proto3" json:"tasks,omitempty"`
	// contains filtered or unexported fields
}

The BatchCreateTask response message.

func (*BatchCreateTasksResponse) Descriptor

func (*BatchCreateTasksResponse) Descriptor() ([]byte, []int)

Deprecated: Use BatchCreateTasksResponse.ProtoReflect.Descriptor instead.

func (*BatchCreateTasksResponse) GetTasks

func (x *BatchCreateTasksResponse) GetTasks() []*Task

func (*BatchCreateTasksResponse) ProtoMessage

func (*BatchCreateTasksResponse) ProtoMessage()

func (*BatchCreateTasksResponse) ProtoReflect

func (x *BatchCreateTasksResponse) ProtoReflect() protoreflect.Message

func (*BatchCreateTasksResponse) Reset

func (x *BatchCreateTasksResponse) Reset()

func (*BatchCreateTasksResponse) String

func (x *BatchCreateTasksResponse) String() string

CreateDeliveryVehicleRequest

type CreateDeliveryVehicleRequest struct {

	// Optional. The standard Delivery API request header.
	Header *DeliveryRequestHeader `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
	// Required. Must be in the format `providers/{provider}`. The provider must
	// be the Google Cloud Project ID. For example, `sample-cloud-project`.
	Parent string `protobuf:"bytes,3,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The Delivery Vehicle ID must be unique and 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 '#'.
	DeliveryVehicleId string `protobuf:"bytes,4,opt,name=delivery_vehicle_id,json=deliveryVehicleId,proto3" json:"delivery_vehicle_id,omitempty"`
	// Required. The `DeliveryVehicle` entity to create. When creating a new
	// delivery vehicle, you may set the following optional fields:
	//
	// * type
	// * last_location
	// * attributes
	//
	// Note: The DeliveryVehicle's `name` field is ignored. All other
	// DeliveryVehicle fields must not be set; otherwise, an error is returned.
	DeliveryVehicle *DeliveryVehicle `protobuf:"bytes,5,opt,name=delivery_vehicle,json=deliveryVehicle,proto3" json:"delivery_vehicle,omitempty"`
	// contains filtered or unexported fields
}

The CreateDeliveryVehicle request message.

func (*CreateDeliveryVehicleRequest) Descriptor

func (*CreateDeliveryVehicleRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateDeliveryVehicleRequest.ProtoReflect.Descriptor instead.

func (*CreateDeliveryVehicleRequest) GetDeliveryVehicle

func (x *CreateDeliveryVehicleRequest) GetDeliveryVehicle() *DeliveryVehicle

func (*CreateDeliveryVehicleRequest) GetDeliveryVehicleId

func (x *CreateDeliveryVehicleRequest) GetDeliveryVehicleId() string

func (*CreateDeliveryVehicleRequest) GetHeader

func (x *CreateDeliveryVehicleRequest) GetHeader() *DeliveryRequestHeader

func (*CreateDeliveryVehicleRequest) GetParent

func (x *CreateDeliveryVehicleRequest) GetParent() string

func (*CreateDeliveryVehicleRequest) ProtoMessage

func (*CreateDeliveryVehicleRequest) ProtoMessage()

func (*CreateDeliveryVehicleRequest) ProtoReflect

func (x *CreateDeliveryVehicleRequest) ProtoReflect() protoreflect.Message

func (*CreateDeliveryVehicleRequest) Reset

func (x *CreateDeliveryVehicleRequest) Reset()

func (*CreateDeliveryVehicleRequest) String

func (x *CreateDeliveryVehicleRequest) String() string

CreateTaskRequest

type CreateTaskRequest struct {

	// Optional. The standard Delivery API request header.
	Header *DeliveryRequestHeader `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
	// Required. Must be in the format `providers/{provider}`. The `provider` must
	// be the Google Cloud Project ID. For example, `sample-cloud-project`.
	Parent string `protobuf:"bytes,3,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The Task ID must be unique, but it should be not a shipment
	// tracking ID. To store a shipment tracking ID, use the `tracking_id` field.
	// Note that multiple tasks can have the same `tracking_id`. Task IDs are
	// 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 '#'.
	TaskId string `protobuf:"bytes,5,opt,name=task_id,json=taskId,proto3" json:"task_id,omitempty"`
	// Required. The Task entity to create.
	// When creating a Task, the following fields are required:
	//
	// * `type`
	// * `state` (must be set to `OPEN`)
	// * `tracking_id` (must not be set for `UNAVAILABLE` or `SCHEDULED_STOP`
	// tasks, but required for all other task types)
	// * `planned_location` (optional for `UNAVAILABLE` tasks)
	// * `task_duration`
	//
	// The following fields can be optionally set:
	//
	// * `target_time_window`
	// * `task_tracking_view_config`
	// * `attributes`
	//
	// Note: The Task's `name` field is ignored. All other Task fields must not be
	// set; otherwise, an error is returned.
	Task *Task `protobuf:"bytes,4,opt,name=task,proto3" json:"task,omitempty"`
	// contains filtered or unexported fields
}

The CreateTask request message.

func (*CreateTaskRequest) Descriptor

func (*CreateTaskRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateTaskRequest.ProtoReflect.Descriptor instead.

func (*CreateTaskRequest) GetHeader

func (x *CreateTaskRequest) GetHeader() *DeliveryRequestHeader

func (*CreateTaskRequest) GetParent

func (x *CreateTaskRequest) GetParent() string

func (*CreateTaskRequest) GetTask

func (x *CreateTaskRequest) GetTask() *Task

func (*CreateTaskRequest) GetTaskId

func (x *CreateTaskRequest) GetTaskId() string

func (*CreateTaskRequest) ProtoMessage

func (*CreateTaskRequest) ProtoMessage()

func (*CreateTaskRequest) ProtoReflect

func (x *CreateTaskRequest) ProtoReflect() protoreflect.Message

func (*CreateTaskRequest) Reset

func (x *CreateTaskRequest) Reset()

func (*CreateTaskRequest) String

func (x *CreateTaskRequest) String() string

DeleteDeliveryVehicleRequest

type DeleteDeliveryVehicleRequest struct {

	// Optional. The standard Delivery API request header.
	Header *DeliveryRequestHeader `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
	// Required. Must be in the format
	// `providers/{provider}/deliveryVehicles/{delivery_vehicle}`.
	// The `provider` must be the Google Cloud Project ID. For example,
	// `sample-cloud-project`.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

DeleteDeliveryVehicle request message.

func (*DeleteDeliveryVehicleRequest) Descriptor

func (*DeleteDeliveryVehicleRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteDeliveryVehicleRequest.ProtoReflect.Descriptor instead.

func (*DeleteDeliveryVehicleRequest) GetHeader

func (x *DeleteDeliveryVehicleRequest) GetHeader() *DeliveryRequestHeader

func (*DeleteDeliveryVehicleRequest) GetName

func (x *DeleteDeliveryVehicleRequest) GetName() string

func (*DeleteDeliveryVehicleRequest) ProtoMessage

func (*DeleteDeliveryVehicleRequest) ProtoMessage()

func (*DeleteDeliveryVehicleRequest) ProtoReflect

func (x *DeleteDeliveryVehicleRequest) ProtoReflect() protoreflect.Message

func (*DeleteDeliveryVehicleRequest) Reset

func (x *DeleteDeliveryVehicleRequest) Reset()

func (*DeleteDeliveryVehicleRequest) String

func (x *DeleteDeliveryVehicleRequest) String() string

DeleteTaskRequest

type DeleteTaskRequest struct {

	// Optional. The standard Delivery API request header.
	Header *DeliveryRequestHeader `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
	// Required. Must be in the format `providers/{provider}/tasks/{task}`. The
	// `provider` must be the Google Cloud Project ID. For example,
	// `sample-cloud-project`.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

DeleteTask request message.

func (*DeleteTaskRequest) Descriptor

func (*DeleteTaskRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteTaskRequest.ProtoReflect.Descriptor instead.

func (*DeleteTaskRequest) GetHeader

func (x *DeleteTaskRequest) GetHeader() *DeliveryRequestHeader

func (*DeleteTaskRequest) GetName

func (x *DeleteTaskRequest) GetName() string

func (*DeleteTaskRequest) ProtoMessage

func (*DeleteTaskRequest) ProtoMessage()

func (*DeleteTaskRequest) ProtoReflect

func (x *DeleteTaskRequest) ProtoReflect() protoreflect.Message

func (*DeleteTaskRequest) Reset

func (x *DeleteTaskRequest) Reset()

func (*DeleteTaskRequest) String

func (x *DeleteTaskRequest) String() string

DeliveryRequestHeader

type DeliveryRequestHeader 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 DeliveryRequestHeader_SdkType `protobuf:"varint,6,opt,name=sdk_type,json=sdkType,proto3,enum=maps.fleetengine.delivery.v1.DeliveryRequestHeader_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 DeliveryRequestHeader_Platform `protobuf:"varint,9,opt,name=platform,proto3,enum=maps.fleetengine.delivery.v1.DeliveryRequestHeader_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 Delivery RPC requests.

func (*DeliveryRequestHeader) Descriptor

func (*DeliveryRequestHeader) Descriptor() ([]byte, []int)

Deprecated: Use DeliveryRequestHeader.ProtoReflect.Descriptor instead.

func (*DeliveryRequestHeader) GetAndroidApiLevel

func (x *DeliveryRequestHeader) GetAndroidApiLevel() int32

func (*DeliveryRequestHeader) GetDeviceModel

func (x *DeliveryRequestHeader) GetDeviceModel() string

func (*DeliveryRequestHeader) GetLanguageCode

func (x *DeliveryRequestHeader) GetLanguageCode() string

func (*DeliveryRequestHeader) GetManufacturer

func (x *DeliveryRequestHeader) GetManufacturer() string

func (*DeliveryRequestHeader) GetMapsSdkVersion

func (x *DeliveryRequestHeader) GetMapsSdkVersion() string

func (*DeliveryRequestHeader) GetNavSdkVersion

func (x *DeliveryRequestHeader) GetNavSdkVersion() string

func (*DeliveryRequestHeader) GetOsVersion

func (x *DeliveryRequestHeader) GetOsVersion() string

func (*DeliveryRequestHeader) GetPlatform

func (x *DeliveryRequestHeader) GetPlatform() DeliveryRequestHeader_Platform

func (*DeliveryRequestHeader) GetRegionCode

func (x *DeliveryRequestHeader) GetRegionCode() string

func (*DeliveryRequestHeader) GetSdkType

func (x *DeliveryRequestHeader) GetSdkType() DeliveryRequestHeader_SdkType

func (*DeliveryRequestHeader) GetSdkVersion

func (x *DeliveryRequestHeader) GetSdkVersion() string

func (*DeliveryRequestHeader) GetTraceId

func (x *DeliveryRequestHeader) GetTraceId() string

func (*DeliveryRequestHeader) ProtoMessage

func (*DeliveryRequestHeader) ProtoMessage()

func (*DeliveryRequestHeader) ProtoReflect

func (x *DeliveryRequestHeader) ProtoReflect() protoreflect.Message

func (*DeliveryRequestHeader) Reset

func (x *DeliveryRequestHeader) Reset()

func (*DeliveryRequestHeader) String

func (x *DeliveryRequestHeader) String() string

DeliveryRequestHeader_Platform

type DeliveryRequestHeader_Platform int32

The platform of the calling SDK.

DeliveryRequestHeader_PLATFORM_UNSPECIFIED, DeliveryRequestHeader_ANDROID, DeliveryRequestHeader_IOS, DeliveryRequestHeader_WEB

const (
	// The default value. This value is used if the platform is omitted.
	DeliveryRequestHeader_PLATFORM_UNSPECIFIED DeliveryRequestHeader_Platform = 0
	// The request is coming from Android.
	DeliveryRequestHeader_ANDROID DeliveryRequestHeader_Platform = 1
	// The request is coming from iOS.
	DeliveryRequestHeader_IOS DeliveryRequestHeader_Platform = 2
	// The request is coming from the web.
	DeliveryRequestHeader_WEB DeliveryRequestHeader_Platform = 3
)

func (DeliveryRequestHeader_Platform) Descriptor

func (DeliveryRequestHeader_Platform) Descriptor() protoreflect.EnumDescriptor

func (DeliveryRequestHeader_Platform) Enum

func (x DeliveryRequestHeader_Platform) Enum() *DeliveryRequestHeader_Platform

func (DeliveryRequestHeader_Platform) EnumDescriptor

func (DeliveryRequestHeader_Platform) EnumDescriptor() ([]byte, []int)

Deprecated: Use DeliveryRequestHeader_Platform.Descriptor instead.

func (DeliveryRequestHeader_Platform) Number

func (x DeliveryRequestHeader_Platform) Number() protoreflect.EnumNumber

func (DeliveryRequestHeader_Platform) String

func (x DeliveryRequestHeader_Platform) String() string

func (DeliveryRequestHeader_Platform) Type

func (DeliveryRequestHeader_Platform) Type() protoreflect.EnumType

DeliveryRequestHeader_SdkType

type DeliveryRequestHeader_SdkType int32

Possible types of SDK.

DeliveryRequestHeader_SDK_TYPE_UNSPECIFIED, DeliveryRequestHeader_CONSUMER, DeliveryRequestHeader_DRIVER, DeliveryRequestHeader_JAVASCRIPT

const (
	// The default value. This value is used if the `sdk_type` is omitted.
	DeliveryRequestHeader_SDK_TYPE_UNSPECIFIED DeliveryRequestHeader_SdkType = 0
	// The calling SDK is Consumer.
	DeliveryRequestHeader_CONSUMER DeliveryRequestHeader_SdkType = 1
	// The calling SDK is Driver.
	DeliveryRequestHeader_DRIVER DeliveryRequestHeader_SdkType = 2
	// The calling SDK is JavaScript.
	DeliveryRequestHeader_JAVASCRIPT DeliveryRequestHeader_SdkType = 3
)

func (DeliveryRequestHeader_SdkType) Descriptor

func (DeliveryRequestHeader_SdkType) Descriptor() protoreflect.EnumDescriptor

func (DeliveryRequestHeader_SdkType) Enum

func (x DeliveryRequestHeader_SdkType) Enum() *DeliveryRequestHeader_SdkType

func (DeliveryRequestHeader_SdkType) EnumDescriptor

func (DeliveryRequestHeader_SdkType) EnumDescriptor() ([]byte, []int)

Deprecated: Use DeliveryRequestHeader_SdkType.Descriptor instead.

func (DeliveryRequestHeader_SdkType) Number

func (x DeliveryRequestHeader_SdkType) Number() protoreflect.EnumNumber

func (DeliveryRequestHeader_SdkType) String

func (x DeliveryRequestHeader_SdkType) String() string

func (DeliveryRequestHeader_SdkType) Type

func (DeliveryRequestHeader_SdkType) Type() protoreflect.EnumType

DeliveryServiceClient

type DeliveryServiceClient interface {
	// Creates and returns a new `DeliveryVehicle`.
	CreateDeliveryVehicle(ctx context.Context, in *CreateDeliveryVehicleRequest, opts ...grpc.CallOption) (*DeliveryVehicle, error)
	// Returns the specified `DeliveryVehicle` instance.
	GetDeliveryVehicle(ctx context.Context, in *GetDeliveryVehicleRequest, opts ...grpc.CallOption) (*DeliveryVehicle, error)
	// Deletes a DeliveryVehicle from the Fleet Engine.
	//
	// Returns FAILED_PRECONDITION if the DeliveryVehicle has OPEN Tasks
	// assigned to it.
	DeleteDeliveryVehicle(ctx context.Context, in *DeleteDeliveryVehicleRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Writes updated `DeliveryVehicle` data to Fleet Engine, and assigns
	// `Tasks` to the `DeliveryVehicle`. You cannot update the name of the
	// `DeliveryVehicle`. You *can* update `remaining_vehicle_journey_segments`,
	// but it must contain all of the `VehicleJourneySegment`s to be persisted on
	// the `DeliveryVehicle`. The `task_id`s are retrieved from
	// `remaining_vehicle_journey_segments`, and their corresponding `Tasks` are
	// assigned to the `DeliveryVehicle` if they have not yet been assigned.
	UpdateDeliveryVehicle(ctx context.Context, in *UpdateDeliveryVehicleRequest, opts ...grpc.CallOption) (*DeliveryVehicle, error)
	// Creates and returns a batch of new `Task` objects.
	BatchCreateTasks(ctx context.Context, in *BatchCreateTasksRequest, opts ...grpc.CallOption) (*BatchCreateTasksResponse, error)
	// Creates and returns a new `Task` object.
	CreateTask(ctx context.Context, in *CreateTaskRequest, opts ...grpc.CallOption) (*Task, error)
	// Gets information about a `Task`.
	GetTask(ctx context.Context, in *GetTaskRequest, opts ...grpc.CallOption) (*Task, error)
	// Deletes a single Task.
	//
	// Returns FAILED_PRECONDITION if the Task is OPEN and assigned to a
	// DeliveryVehicle.
	DeleteTask(ctx context.Context, in *DeleteTaskRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Updates `Task` data.
	UpdateTask(ctx context.Context, in *UpdateTaskRequest, opts ...grpc.CallOption) (*Task, error)
	// Gets all `Task`s that meet the specified filtering criteria.
	ListTasks(ctx context.Context, in *ListTasksRequest, opts ...grpc.CallOption) (*ListTasksResponse, error)
	// Returns the specified `TaskTrackingInfo` instance.
	GetTaskTrackingInfo(ctx context.Context, in *GetTaskTrackingInfoRequest, opts ...grpc.CallOption) (*TaskTrackingInfo, error)
	// Gets all `DeliveryVehicle`s that meet the specified filtering criteria.
	ListDeliveryVehicles(ctx context.Context, in *ListDeliveryVehiclesRequest, opts ...grpc.CallOption) (*ListDeliveryVehiclesResponse, error)
}

DeliveryServiceClient is the client API for DeliveryService 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 NewDeliveryServiceClient

func NewDeliveryServiceClient(cc grpc.ClientConnInterface) DeliveryServiceClient

DeliveryServiceServer

type DeliveryServiceServer interface {
	// Creates and returns a new `DeliveryVehicle`.
	CreateDeliveryVehicle(context.Context, *CreateDeliveryVehicleRequest) (*DeliveryVehicle, error)
	// Returns the specified `DeliveryVehicle` instance.
	GetDeliveryVehicle(context.Context, *GetDeliveryVehicleRequest) (*DeliveryVehicle, error)
	// Deletes a DeliveryVehicle from the Fleet Engine.
	//
	// Returns FAILED_PRECONDITION if the DeliveryVehicle has OPEN Tasks
	// assigned to it.
	DeleteDeliveryVehicle(context.Context, *DeleteDeliveryVehicleRequest) (*emptypb.Empty, error)
	// Writes updated `DeliveryVehicle` data to Fleet Engine, and assigns
	// `Tasks` to the `DeliveryVehicle`. You cannot update the name of the
	// `DeliveryVehicle`. You *can* update `remaining_vehicle_journey_segments`,
	// but it must contain all of the `VehicleJourneySegment`s to be persisted on
	// the `DeliveryVehicle`. The `task_id`s are retrieved from
	// `remaining_vehicle_journey_segments`, and their corresponding `Tasks` are
	// assigned to the `DeliveryVehicle` if they have not yet been assigned.
	UpdateDeliveryVehicle(context.Context, *UpdateDeliveryVehicleRequest) (*DeliveryVehicle, error)
	// Creates and returns a batch of new `Task` objects.
	BatchCreateTasks(context.Context, *BatchCreateTasksRequest) (*BatchCreateTasksResponse, error)
	// Creates and returns a new `Task` object.
	CreateTask(context.Context, *CreateTaskRequest) (*Task, error)
	// Gets information about a `Task`.
	GetTask(context.Context, *GetTaskRequest) (*Task, error)
	// Deletes a single Task.
	//
	// Returns FAILED_PRECONDITION if the Task is OPEN and assigned to a
	// DeliveryVehicle.
	DeleteTask(context.Context, *DeleteTaskRequest) (*emptypb.Empty, error)
	// Updates `Task` data.
	UpdateTask(context.Context, *UpdateTaskRequest) (*Task, error)
	// Gets all `Task`s that meet the specified filtering criteria.
	ListTasks(context.Context, *ListTasksRequest) (*ListTasksResponse, error)
	// Returns the specified `TaskTrackingInfo` instance.
	GetTaskTrackingInfo(context.Context, *GetTaskTrackingInfoRequest) (*TaskTrackingInfo, error)
	// Gets all `DeliveryVehicle`s that meet the specified filtering criteria.
	ListDeliveryVehicles(context.Context, *ListDeliveryVehiclesRequest) (*ListDeliveryVehiclesResponse, error)
}

DeliveryServiceServer is the server API for DeliveryService service. All implementations should embed UnimplementedDeliveryServiceServer for forward compatibility

DeliveryVehicle

type DeliveryVehicle struct {

	// The unique name of this Delivery Vehicle.
	// The format is `providers/{provider}/deliveryVehicles/{vehicle}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The last reported location of the Delivery Vehicle.
	LastLocation *DeliveryVehicleLocation `protobuf:"bytes,2,opt,name=last_location,json=lastLocation,proto3" json:"last_location,omitempty"`
	// Input only. Locations where this Delivery Vehicle has been in the past that
	// haven't yet been reported to Fleet Engine. This is used in
	// `UpdateDeliveryVehicleRequest` to record locations which were previously
	// unable to be sent to the server. Typically this happens when the Delivery
	// Vehicle does not have internet connectivity.
	PastLocations []*DeliveryVehicleLocation `protobuf:"bytes,12,rep,name=past_locations,json=pastLocations,proto3" json:"past_locations,omitempty"`
	// The Delivery Vehicle's navigation status.
	NavigationStatus DeliveryVehicleNavigationStatus `protobuf:"varint,3,opt,name=navigation_status,json=navigationStatus,proto3,enum=maps.fleetengine.delivery.v1.DeliveryVehicleNavigationStatus" json:"navigation_status,omitempty"`
	// The encoded polyline specifying the route that the navigation recommends
	// taking to the next waypoint. Your driver app updates this when a
	// stop is reached or passed, and when the navigation reroutes. These
	// `LatLng`s are returned in
	// `Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path`
	// (gRPC) or `Task.journeySharingInfo.remainingVehicleJourneySegments[0].path`
	// (REST) for all active Tasks assigned to the Vehicle.
	//
	// There are a few cases where this field might not be used to populate
	// `Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path`
	// (gRPC) or `Task.journeySharingInfo.remainingVehicleJourneySegments[0].path`
	// (REST):
	//
	// * The endpoint of the `current_route_segment` does not match
	// `DeliveryVehicle.remaining_vehicle_journey_segments[0].stop` (gRPC) or
	// `DeliveryVehicle.remainingVehicleJourneySegments[0].stop` (REST).
	//
	// * The driver app has not updated its location recently, so the last
	// updated value for this field might be stale.
	//
	// * The driver app has recently updated its location, but the
	// `current_route_segment` is stale, and points to a previous vehicle stop.
	//
	// In these cases, Fleet Engine populates this field with a route from the
	// most recently passed VehicleStop to the upcoming VehicleStop to ensure that
	// the consumer of this field has the best available information on the
	// current path of the Delivery Vehicle.
	CurrentRouteSegment []byte `protobuf:"bytes,4,opt,name=current_route_segment,json=currentRouteSegment,proto3" json:"current_route_segment,omitempty"`
	// The location where the `current_route_segment` ends. This is not currently
	// populated by the driver app, but you can supply it on
	// `UpdateDeliveryVehicle` calls. It is either the `LatLng` from the upcoming
	// vehicle stop, or the last `LatLng` of the `current_route_segment`. Fleet
	// Engine will then do its best to interpolate to an actual `VehicleStop`.
	//
	// This field is ignored in `UpdateDeliveryVehicle` calls if the
	// `current_route_segment` field is empty.
	CurrentRouteSegmentEndPoint *latlng.LatLng `protobuf:"bytes,5,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`.
	// The Driver app typically provides this field, but there are some
	// circumstances in which Fleet Engine will override the value sent by the
	// app. For more information, see
	// [DeliveryVehicle.current_route_segment][maps.fleetengine.delivery.v1.DeliveryVehicle.current_route_segment].
	// This field is returned in
	// `Task.remaining_vehicle_journey_segments[0].driving_distance_meters` (gRPC)
	// or `Task.remainingVehicleJourneySegments[0].drivingDistanceMeters` (REST)
	// for all active `Task`s assigned to the Delivery Vehicle.
	//
	// Fleet Engine ignores this field in `UpdateDeliveryVehicleRequest` if the
	// `current_route_segment` field is empty.
	RemainingDistanceMeters *wrapperspb.Int32Value `protobuf:"bytes,6,opt,name=remaining_distance_meters,json=remainingDistanceMeters,proto3" json:"remaining_distance_meters,omitempty"`
	// The remaining driving time for the `current_route_segment`.
	// The Driver app typically provides this field, but there are some
	// circumstances in which Fleet Engine will override the value sent by the
	// app.  For more information, see
	// [DeliveryVehicle.current_route_segment][maps.fleetengine.delivery.v1.DeliveryVehicle.current_route_segment].
	// This field is returned in
	// `Task.remaining_vehicle_journey_segments[0].driving_duration` (gRPC) or
	// `Task.remainingVehicleJourneySegments[0].drivingDuration` (REST) for all
	// active tasks assigned to the Delivery Vehicle.
	//
	// Fleet Engine ignores this field in `UpdateDeliveryVehicleRequest` if the
	// `current_route_segment` field is empty.
	RemainingDuration *durationpb.Duration `protobuf:"bytes,7,opt,name=remaining_duration,json=remainingDuration,proto3" json:"remaining_duration,omitempty"`
	// The journey segments assigned to this Delivery Vehicle, starting from the
	// Vehicle's most recently reported location. This field won't be populated
	// in the response of `ListDeliveryVehicles`.
	RemainingVehicleJourneySegments []*VehicleJourneySegment `protobuf:"bytes,8,rep,name=remaining_vehicle_journey_segments,json=remainingVehicleJourneySegments,proto3" json:"remaining_vehicle_journey_segments,omitempty"`
	// A list of custom Delivery Vehicle attributes. A Delivery Vehicle can have
	// at most 100 attributes, and each attribute must have a unique key.
	Attributes []*DeliveryVehicleAttribute `protobuf:"bytes,9,rep,name=attributes,proto3" json:"attributes,omitempty"`
	// The type of this delivery vehicle. If unset, this will default to `AUTO`.
	Type DeliveryVehicle_DeliveryVehicleType `protobuf:"varint,10,opt,name=type,proto3,enum=maps.fleetengine.delivery.v1.DeliveryVehicle_DeliveryVehicleType" json:"type,omitempty"`
	// contains filtered or unexported fields
}

The DeliveryVehicle message. A delivery vehicle transports shipments from a depot to a delivery location, and from a pickup location to the depot. In some cases, delivery vehicles also transport shipments directly from the pickup location to the delivery location.

Note: gRPC and REST APIs use different field naming conventions. For example, the DeliveryVehicle.current_route_segment field in the gRPC API and the DeliveryVehicle.currentRouteSegment field in the REST API refer to the same field.

func (*DeliveryVehicle) Descriptor

func (*DeliveryVehicle) Descriptor() ([]byte, []int)

Deprecated: Use DeliveryVehicle.ProtoReflect.Descriptor instead.

func (*DeliveryVehicle) GetAttributes

func (x *DeliveryVehicle) GetAttributes() []*DeliveryVehicleAttribute

func (*DeliveryVehicle) GetCurrentRouteSegment

func (x *DeliveryVehicle) GetCurrentRouteSegment() []byte

func (*DeliveryVehicle) GetCurrentRouteSegmentEndPoint

func (x *DeliveryVehicle) GetCurrentRouteSegmentEndPoint() *latlng.LatLng

func (*DeliveryVehicle) GetLastLocation

func (x *DeliveryVehicle) GetLastLocation() *DeliveryVehicleLocation

func (*DeliveryVehicle) GetName

func (x *DeliveryVehicle) GetName() string

func (*DeliveryVehicle) GetNavigationStatus

func (x *DeliveryVehicle) GetNavigationStatus() DeliveryVehicleNavigationStatus

func (*DeliveryVehicle) GetPastLocations

func (x *DeliveryVehicle) GetPastLocations() []*DeliveryVehicleLocation

func (*DeliveryVehicle) GetRemainingDistanceMeters

func (x *DeliveryVehicle) GetRemainingDistanceMeters() *wrapperspb.Int32Value

func (*DeliveryVehicle) GetRemainingDuration

func (x *DeliveryVehicle) GetRemainingDuration() *durationpb.Duration

func (*DeliveryVehicle) GetRemainingVehicleJourneySegments

func (x *DeliveryVehicle) GetRemainingVehicleJourneySegments() []*VehicleJourneySegment

func (*DeliveryVehicle) GetType

func (x *DeliveryVehicle) GetType() DeliveryVehicle_DeliveryVehicleType

func (*DeliveryVehicle) ProtoMessage

func (*DeliveryVehicle) ProtoMessage()

func (*DeliveryVehicle) ProtoReflect

func (x *DeliveryVehicle) ProtoReflect() protoreflect.Message

func (*DeliveryVehicle) Reset

func (x *DeliveryVehicle) Reset()

func (*DeliveryVehicle) String

func (x *DeliveryVehicle) String() string

DeliveryVehicleAttribute

type DeliveryVehicleAttribute struct {

	// The attribute's key.
	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 valid to be assigned to DeliveryVehicleAttributeValue:
	//
	//	*DeliveryVehicleAttribute_StringValue
	//	*DeliveryVehicleAttribute_BoolValue
	//	*DeliveryVehicleAttribute_NumberValue
	DeliveryVehicleAttributeValue isDeliveryVehicleAttribute_DeliveryVehicleAttributeValue `protobuf_oneof:"delivery_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 (*DeliveryVehicleAttribute) Descriptor

func (*DeliveryVehicleAttribute) Descriptor() ([]byte, []int)

Deprecated: Use DeliveryVehicleAttribute.ProtoReflect.Descriptor instead.

func (*DeliveryVehicleAttribute) GetBoolValue

func (x *DeliveryVehicleAttribute) GetBoolValue() bool

func (*DeliveryVehicleAttribute) GetDeliveryVehicleAttributeValue

func (x *DeliveryVehicleAttribute) GetDeliveryVehicleAttributeValue() isDeliveryVehicleAttribute_DeliveryVehicleAttributeValue

func (*DeliveryVehicleAttribute) GetKey

func (x *DeliveryVehicleAttribute) GetKey() string

func (*DeliveryVehicleAttribute) GetNumberValue

func (x *DeliveryVehicleAttribute) GetNumberValue() float64

func (*DeliveryVehicleAttribute) GetStringValue

func (x *DeliveryVehicleAttribute) GetStringValue() string

func (*DeliveryVehicleAttribute) GetValue

func (x *DeliveryVehicleAttribute) GetValue() string

func (*DeliveryVehicleAttribute) ProtoMessage

func (*DeliveryVehicleAttribute) ProtoMessage()

func (*DeliveryVehicleAttribute) ProtoReflect

func (x *DeliveryVehicleAttribute) ProtoReflect() protoreflect.Message

func (*DeliveryVehicleAttribute) Reset

func (x *DeliveryVehicleAttribute) Reset()

func (*DeliveryVehicleAttribute) String

func (x *DeliveryVehicleAttribute) String() string

DeliveryVehicleAttribute_BoolValue

type DeliveryVehicleAttribute_BoolValue struct {
	// Boolean typed attribute value.
	BoolValue bool `protobuf:"varint,4,opt,name=bool_value,json=boolValue,proto3,oneof"`
}

DeliveryVehicleAttribute_NumberValue

type DeliveryVehicleAttribute_NumberValue struct {
	// Double typed attribute value.
	NumberValue float64 `protobuf:"fixed64,5,opt,name=number_value,json=numberValue,proto3,oneof"`
}

DeliveryVehicleAttribute_StringValue

type DeliveryVehicleAttribute_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"`
}

DeliveryVehicleLocation

type DeliveryVehicleLocation 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/delivery/v1/common.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/delivery/v1/common.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/delivery/v1/common.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/delivery/v1/common.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 DeliveryVehicleLocationSensor `protobuf:"varint,11,opt,name=location_sensor,json=locationSensor,proto3,enum=maps.fleetengine.delivery.v1.DeliveryVehicleLocationSensor" 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/delivery/v1/common.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 DeliveryVehicleLocationSensor `protobuf:"varint,28,opt,name=raw_location_sensor,json=rawLocationSensor,proto3,enum=maps.fleetengine.delivery.v1.DeliveryVehicleLocationSensor" 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 the `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 DeliveryVehicleLocationSensor `protobuf:"varint,20,opt,name=supplemental_location_sensor,json=supplementalLocationSensor,proto3,enum=maps.fleetengine.delivery.v1.DeliveryVehicleLocationSensor" 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/delivery/v1/common.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 (*DeliveryVehicleLocation) Descriptor

func (*DeliveryVehicleLocation) Descriptor() ([]byte, []int)

Deprecated: Use DeliveryVehicleLocation.ProtoReflect.Descriptor instead.

func (*DeliveryVehicleLocation) GetAltitude

func (x *DeliveryVehicleLocation) GetAltitude() *wrapperspb.DoubleValue

func (*DeliveryVehicleLocation) GetAltitudeAccuracy

func (x *DeliveryVehicleLocation) GetAltitudeAccuracy() *wrapperspb.DoubleValue

func (*DeliveryVehicleLocation) GetBearingAccuracy

func (x *DeliveryVehicleLocation) GetBearingAccuracy() *wrapperspb.DoubleValue

Deprecated: Marked as deprecated in google/maps/fleetengine/delivery/v1/common.proto.

func (*DeliveryVehicleLocation) GetFlpHeadingDegrees

func (x *DeliveryVehicleLocation) GetFlpHeadingDegrees() *wrapperspb.Int32Value

func (*DeliveryVehicleLocation) GetFlpLatlngAccuracyMeters

func (x *DeliveryVehicleLocation) GetFlpLatlngAccuracyMeters() *wrapperspb.DoubleValue

func (*DeliveryVehicleLocation) GetFlpLocation

func (x *DeliveryVehicleLocation) GetFlpLocation() *latlng.LatLng

func (*DeliveryVehicleLocation) GetFlpUpdateTime

func (x *DeliveryVehicleLocation) GetFlpUpdateTime() *timestamppb.Timestamp

func (*DeliveryVehicleLocation) GetHeading

func (x *DeliveryVehicleLocation) GetHeading() *wrapperspb.Int32Value

func (*DeliveryVehicleLocation) GetHeadingAccuracy

func (x *DeliveryVehicleLocation) GetHeadingAccuracy() *wrapperspb.DoubleValue

func (*DeliveryVehicleLocation) GetHorizontalAccuracy

func (x *DeliveryVehicleLocation) GetHorizontalAccuracy() *wrapperspb.DoubleValue

Deprecated: Marked as deprecated in google/maps/fleetengine/delivery/v1/common.proto.

func (*DeliveryVehicleLocation) GetIsGpsSensorEnabled

func (x *DeliveryVehicleLocation) GetIsGpsSensorEnabled() *wrapperspb.BoolValue

func (*DeliveryVehicleLocation) GetIsRoadSnapped

func (x *DeliveryVehicleLocation) GetIsRoadSnapped() *wrapperspb.BoolValue

func (*DeliveryVehicleLocation) GetLatlngAccuracy

func (x *DeliveryVehicleLocation) GetLatlngAccuracy() *wrapperspb.DoubleValue

func (*DeliveryVehicleLocation) GetLocation

func (x *DeliveryVehicleLocation) GetLocation() *latlng.LatLng

func (*DeliveryVehicleLocation) GetLocationSensor

func (x *DeliveryVehicleLocation) GetLocationSensor() DeliveryVehicleLocationSensor

func (*DeliveryVehicleLocation) GetNumStaleUpdates

func (x *DeliveryVehicleLocation) GetNumStaleUpdates() *wrapperspb.Int32Value

Deprecated: Marked as deprecated in google/maps/fleetengine/delivery/v1/common.proto.

func (*DeliveryVehicleLocation) GetRawLocation

func (x *DeliveryVehicleLocation) GetRawLocation() *latlng.LatLng

func (*DeliveryVehicleLocation) GetRawLocationAccuracy

func (x *DeliveryVehicleLocation) GetRawLocationAccuracy() *wrapperspb.DoubleValue

func (*DeliveryVehicleLocation) GetRawLocationSensor

func (x *DeliveryVehicleLocation) GetRawLocationSensor() DeliveryVehicleLocationSensor

func (*DeliveryVehicleLocation) GetRawLocationTime

func (x *DeliveryVehicleLocation) GetRawLocationTime() *timestamppb.Timestamp

func (*DeliveryVehicleLocation) GetRoadSnapped

func (x *DeliveryVehicleLocation) GetRoadSnapped() bool

Deprecated: Marked as deprecated in google/maps/fleetengine/delivery/v1/common.proto.

func (*DeliveryVehicleLocation) GetServerTime

func (x *DeliveryVehicleLocation) GetServerTime() *timestamppb.Timestamp

func (*DeliveryVehicleLocation) GetSpeed

func (x *DeliveryVehicleLocation) GetSpeed() *wrapperspb.DoubleValue

func (*DeliveryVehicleLocation) GetSpeedAccuracy

func (x *DeliveryVehicleLocation) GetSpeedAccuracy() *wrapperspb.DoubleValue

func (*DeliveryVehicleLocation) GetSpeedKmph

func (x *DeliveryVehicleLocation) GetSpeedKmph() *wrapperspb.Int32Value

Deprecated: Marked as deprecated in google/maps/fleetengine/delivery/v1/common.proto.

func (*DeliveryVehicleLocation) GetSupplementalLocation

func (x *DeliveryVehicleLocation) GetSupplementalLocation() *latlng.LatLng

func (*DeliveryVehicleLocation) GetSupplementalLocationAccuracy

func (x *DeliveryVehicleLocation) GetSupplementalLocationAccuracy() *wrapperspb.DoubleValue

func (*DeliveryVehicleLocation) GetSupplementalLocationSensor

func (x *DeliveryVehicleLocation) GetSupplementalLocationSensor() DeliveryVehicleLocationSensor

func (*DeliveryVehicleLocation) GetSupplementalLocationTime

func (x *DeliveryVehicleLocation) GetSupplementalLocationTime() *timestamppb.Timestamp

func (*DeliveryVehicleLocation) GetTimeSinceUpdate

func (x *DeliveryVehicleLocation) GetTimeSinceUpdate() *wrapperspb.Int32Value

func (*DeliveryVehicleLocation) GetUpdateTime

func (x *DeliveryVehicleLocation) GetUpdateTime() *timestamppb.Timestamp

func (*DeliveryVehicleLocation) GetVerticalAccuracy

func (x *DeliveryVehicleLocation) GetVerticalAccuracy() *wrapperspb.DoubleValue

Deprecated: Marked as deprecated in google/maps/fleetengine/delivery/v1/common.proto.

func (*DeliveryVehicleLocation) ProtoMessage

func (*DeliveryVehicleLocation) ProtoMessage()

func (*DeliveryVehicleLocation) ProtoReflect

func (x *DeliveryVehicleLocation) ProtoReflect() protoreflect.Message

func (*DeliveryVehicleLocation) Reset

func (x *DeliveryVehicleLocation) Reset()

func (*DeliveryVehicleLocation) String

func (x *DeliveryVehicleLocation) String() string

DeliveryVehicleLocationSensor

type DeliveryVehicleLocationSensor int32

The sensor or methodology used to determine the location.

DeliveryVehicleLocationSensor_UNKNOWN_SENSOR, DeliveryVehicleLocationSensor_GPS, DeliveryVehicleLocationSensor_NETWORK, DeliveryVehicleLocationSensor_PASSIVE, DeliveryVehicleLocationSensor_ROAD_SNAPPED_LOCATION_PROVIDER, DeliveryVehicleLocationSensor_CUSTOMER_SUPPLIED_LOCATION, DeliveryVehicleLocationSensor_FLEET_ENGINE_LOCATION, DeliveryVehicleLocationSensor_FUSED_LOCATION_PROVIDER, DeliveryVehicleLocationSensor_CORE_LOCATION

const (
	// The sensor is unspecified or unknown.
	DeliveryVehicleLocationSensor_UNKNOWN_SENSOR DeliveryVehicleLocationSensor = 0
	// GPS or Assisted GPS.
	DeliveryVehicleLocationSensor_GPS DeliveryVehicleLocationSensor = 1
	// Assisted GPS, cell tower ID, or WiFi access point.
	DeliveryVehicleLocationSensor_NETWORK DeliveryVehicleLocationSensor = 2
	// Cell tower ID or WiFi access point.
	DeliveryVehicleLocationSensor_PASSIVE DeliveryVehicleLocationSensor = 3
	// A location determined by the mobile device to be the most likely
	// road position.
	DeliveryVehicleLocationSensor_ROAD_SNAPPED_LOCATION_PROVIDER DeliveryVehicleLocationSensor = 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 DeliveryVehicle's
	// `last_location.supplemental_location_sensor`.
	DeliveryVehicleLocationSensor_CUSTOMER_SUPPLIED_LOCATION DeliveryVehicleLocationSensor = 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.
	DeliveryVehicleLocationSensor_FLEET_ENGINE_LOCATION DeliveryVehicleLocationSensor = 6
	// Android's Fused Location Provider.
	DeliveryVehicleLocationSensor_FUSED_LOCATION_PROVIDER DeliveryVehicleLocationSensor = 100
	// The location provider on Apple operating systems.
	DeliveryVehicleLocationSensor_CORE_LOCATION DeliveryVehicleLocationSensor = 200
)

func (DeliveryVehicleLocationSensor) Descriptor

func (DeliveryVehicleLocationSensor) Descriptor() protoreflect.EnumDescriptor

func (DeliveryVehicleLocationSensor) Enum

func (x DeliveryVehicleLocationSensor) Enum() *DeliveryVehicleLocationSensor

func (DeliveryVehicleLocationSensor) EnumDescriptor

func (DeliveryVehicleLocationSensor) EnumDescriptor() ([]byte, []int)

Deprecated: Use DeliveryVehicleLocationSensor.Descriptor instead.

func (DeliveryVehicleLocationSensor) Number

func (x DeliveryVehicleLocationSensor) Number() protoreflect.EnumNumber

func (DeliveryVehicleLocationSensor) String

func (x DeliveryVehicleLocationSensor) String() string

func (DeliveryVehicleLocationSensor) Type

func (DeliveryVehicleLocationSensor) Type() protoreflect.EnumType

DeliveryVehicleNavigationStatus

type DeliveryVehicleNavigationStatus int32

The vehicle's navigation status.

DeliveryVehicleNavigationStatus_UNKNOWN_NAVIGATION_STATUS, DeliveryVehicleNavigationStatus_NO_GUIDANCE, DeliveryVehicleNavigationStatus_ENROUTE_TO_DESTINATION, DeliveryVehicleNavigationStatus_OFF_ROUTE, DeliveryVehicleNavigationStatus_ARRIVED_AT_DESTINATION

const (
	// Unspecified navigation status.
	DeliveryVehicleNavigationStatus_UNKNOWN_NAVIGATION_STATUS DeliveryVehicleNavigationStatus = 0
	// The Driver app's navigation is in `FREE_NAV` mode.
	DeliveryVehicleNavigationStatus_NO_GUIDANCE DeliveryVehicleNavigationStatus = 1
	// Turn-by-turn navigation is available and the Driver app navigation has
	// entered `GUIDED_NAV` mode.
	DeliveryVehicleNavigationStatus_ENROUTE_TO_DESTINATION DeliveryVehicleNavigationStatus = 2
	// The vehicle has gone off the suggested route.
	DeliveryVehicleNavigationStatus_OFF_ROUTE DeliveryVehicleNavigationStatus = 3
	// The vehicle is within approximately 50m of the destination.
	DeliveryVehicleNavigationStatus_ARRIVED_AT_DESTINATION DeliveryVehicleNavigationStatus = 4
)

func (DeliveryVehicleNavigationStatus) Descriptor

func (DeliveryVehicleNavigationStatus) Descriptor() protoreflect.EnumDescriptor

func (DeliveryVehicleNavigationStatus) Enum

func (x DeliveryVehicleNavigationStatus) Enum() *DeliveryVehicleNavigationStatus

func (DeliveryVehicleNavigationStatus) EnumDescriptor

func (DeliveryVehicleNavigationStatus) EnumDescriptor() ([]byte, []int)

Deprecated: Use DeliveryVehicleNavigationStatus.Descriptor instead.

func (DeliveryVehicleNavigationStatus) Number

func (x DeliveryVehicleNavigationStatus) Number() protoreflect.EnumNumber

func (DeliveryVehicleNavigationStatus) String

func (x DeliveryVehicleNavigationStatus) String() string

func (DeliveryVehicleNavigationStatus) Type

func (DeliveryVehicleNavigationStatus) Type() protoreflect.EnumType

DeliveryVehicle_DeliveryVehicleType

type DeliveryVehicle_DeliveryVehicleType int32

The type of delivery vehicle.

DeliveryVehicle_DELIVERY_VEHICLE_TYPE_UNSPECIFIED, DeliveryVehicle_AUTO, DeliveryVehicle_TWO_WHEELER, DeliveryVehicle_BICYCLE, DeliveryVehicle_PEDESTRIAN

const (
	// The value is unused.
	DeliveryVehicle_DELIVERY_VEHICLE_TYPE_UNSPECIFIED DeliveryVehicle_DeliveryVehicleType = 0
	// An automobile.
	DeliveryVehicle_AUTO DeliveryVehicle_DeliveryVehicleType = 1
	// A motorcycle, moped, or other two-wheeled vehicle
	DeliveryVehicle_TWO_WHEELER DeliveryVehicle_DeliveryVehicleType = 2
	// Human-powered transport.
	DeliveryVehicle_BICYCLE DeliveryVehicle_DeliveryVehicleType = 3
	// A human transporter, typically walking or running, traveling along
	// pedestrian pathways.
	DeliveryVehicle_PEDESTRIAN DeliveryVehicle_DeliveryVehicleType = 4
)

func (DeliveryVehicle_DeliveryVehicleType) Descriptor

func (DeliveryVehicle_DeliveryVehicleType) Descriptor() protoreflect.EnumDescriptor

func (DeliveryVehicle_DeliveryVehicleType) Enum

func (x DeliveryVehicle_DeliveryVehicleType) Enum() *DeliveryVehicle_DeliveryVehicleType

func (DeliveryVehicle_DeliveryVehicleType) EnumDescriptor

func (DeliveryVehicle_DeliveryVehicleType) EnumDescriptor() ([]byte, []int)

Deprecated: Use DeliveryVehicle_DeliveryVehicleType.Descriptor instead.

func (DeliveryVehicle_DeliveryVehicleType) Number

func (x DeliveryVehicle_DeliveryVehicleType) Number() protoreflect.EnumNumber

func (DeliveryVehicle_DeliveryVehicleType) String

func (x DeliveryVehicle_DeliveryVehicleType) String() string

func (DeliveryVehicle_DeliveryVehicleType) Type

func (DeliveryVehicle_DeliveryVehicleType) Type() protoreflect.EnumType

GetDeliveryVehicleRequest

type GetDeliveryVehicleRequest struct {

	// Optional. The standard Delivery API request header.
	Header *DeliveryRequestHeader `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
	// Required. Must be in the format
	// `providers/{provider}/deliveryVehicles/{delivery_vehicle}`.
	// The `provider` must be the Google Cloud Project ID. For example,
	// `sample-cloud-project`.
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The GetDeliveryVehicle request message.

func (*GetDeliveryVehicleRequest) Descriptor

func (*GetDeliveryVehicleRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetDeliveryVehicleRequest.ProtoReflect.Descriptor instead.

func (*GetDeliveryVehicleRequest) GetHeader

func (x *GetDeliveryVehicleRequest) GetHeader() *DeliveryRequestHeader

func (*GetDeliveryVehicleRequest) GetName

func (x *GetDeliveryVehicleRequest) GetName() string

func (*GetDeliveryVehicleRequest) ProtoMessage

func (*GetDeliveryVehicleRequest) ProtoMessage()

func (*GetDeliveryVehicleRequest) ProtoReflect

func (x *GetDeliveryVehicleRequest) ProtoReflect() protoreflect.Message

func (*GetDeliveryVehicleRequest) Reset

func (x *GetDeliveryVehicleRequest) Reset()

func (*GetDeliveryVehicleRequest) String

func (x *GetDeliveryVehicleRequest) String() string

GetTaskRequest

type GetTaskRequest struct {

	// Optional. The standard Delivery API request header.
	Header *DeliveryRequestHeader `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
	// Required. Must be in the format `providers/{provider}/tasks/{task}`. The
	// `provider` must be the Google Cloud Project ID. For example,
	// `sample-cloud-project`.
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The GetTask request message.

func (*GetTaskRequest) Descriptor

func (*GetTaskRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetTaskRequest.ProtoReflect.Descriptor instead.

func (*GetTaskRequest) GetHeader

func (x *GetTaskRequest) GetHeader() *DeliveryRequestHeader

func (*GetTaskRequest) GetName

func (x *GetTaskRequest) GetName() string

func (*GetTaskRequest) ProtoMessage

func (*GetTaskRequest) ProtoMessage()

func (*GetTaskRequest) ProtoReflect

func (x *GetTaskRequest) ProtoReflect() protoreflect.Message

func (*GetTaskRequest) Reset

func (x *GetTaskRequest) Reset()

func (*GetTaskRequest) String

func (x *GetTaskRequest) String() string

GetTaskTrackingInfoRequest

type GetTaskTrackingInfoRequest struct {

	// Optional. The standard Delivery API request header.
	Header *DeliveryRequestHeader `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
	// Required. Must be in the format
	// `providers/{provider}/taskTrackingInfo/{tracking_id}`. The `provider`
	// must be the Google Cloud Project ID, and the `tracking_id` must be the
	// tracking ID associated with the task. An example name can be
	// `providers/sample-cloud-project/taskTrackingInfo/sample-tracking-id`.
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The GetTaskTrackingInfoRequest request message.

func (*GetTaskTrackingInfoRequest) Descriptor

func (*GetTaskTrackingInfoRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetTaskTrackingInfoRequest.ProtoReflect.Descriptor instead.

func (*GetTaskTrackingInfoRequest) GetHeader

func (x *GetTaskTrackingInfoRequest) GetHeader() *DeliveryRequestHeader

func (*GetTaskTrackingInfoRequest) GetName

func (x *GetTaskTrackingInfoRequest) GetName() string

func (*GetTaskTrackingInfoRequest) ProtoMessage

func (*GetTaskTrackingInfoRequest) ProtoMessage()

func (*GetTaskTrackingInfoRequest) ProtoReflect

func (x *GetTaskTrackingInfoRequest) ProtoReflect() protoreflect.Message

func (*GetTaskTrackingInfoRequest) Reset

func (x *GetTaskTrackingInfoRequest) Reset()

func (*GetTaskTrackingInfoRequest) String

func (x *GetTaskTrackingInfoRequest) String() string

ListDeliveryVehiclesRequest

type ListDeliveryVehiclesRequest struct {

	// Optional. The standard Delivery API request header.
	Header *DeliveryRequestHeader `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
	// Required. Must be in the format `providers/{provider}`.
	// The `provider` must be the Google Cloud Project ID.
	// For example, `sample-cloud-project`.
	Parent string `protobuf:"bytes,3,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The maximum number of vehicles to return. The service may return
	// fewer than this number. If you don't specify this number, then the server
	// determines the number of results to return.
	PageSize int32 `protobuf:"varint,4,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A page token, received from a previous `ListDeliveryVehicles`
	// call. You must provide this in order to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to `ListDeliveryVehicles`
	// must match the call that provided the page token.
	PageToken string `protobuf:"bytes,5,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. A filter query to apply when listing delivery vehicles. See
	// http://aip.dev/160 for examples of the filter syntax. If you don't specify
	// a value, or if you specify an empty string for the filter, then all
	// delivery vehicles are returned.
	//
	// Note that the only queries supported for `ListDeliveryVehicles` are
	// on vehicle attributes (for example, `attributes.

The ListDeliveryVehicles request message.

func (*ListDeliveryVehiclesRequest) Descriptor

func (*ListDeliveryVehiclesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListDeliveryVehiclesRequest.ProtoReflect.Descriptor instead.

func (*ListDeliveryVehiclesRequest) GetFilter

func (x *ListDeliveryVehiclesRequest) GetFilter() string

func (*ListDeliveryVehiclesRequest) GetHeader

func (x *ListDeliveryVehiclesRequest) GetHeader() *DeliveryRequestHeader

func (*ListDeliveryVehiclesRequest) GetPageSize

func (x *ListDeliveryVehiclesRequest) GetPageSize() int32

func (*ListDeliveryVehiclesRequest) GetPageToken

func (x *ListDeliveryVehiclesRequest) GetPageToken() string

func (*ListDeliveryVehiclesRequest) GetParent

func (x *ListDeliveryVehiclesRequest) GetParent() string

func (*ListDeliveryVehiclesRequest) GetViewport

func (x *ListDeliveryVehiclesRequest) GetViewport() *viewport.Viewport

func (*ListDeliveryVehiclesRequest) ProtoMessage

func (*ListDeliveryVehiclesRequest) ProtoMessage()

func (*ListDeliveryVehiclesRequest) ProtoReflect

func (x *ListDeliveryVehiclesRequest) ProtoReflect() protoreflect.Message

func (*ListDeliveryVehiclesRequest) Reset

func (x *ListDeliveryVehiclesRequest) Reset()

func (*ListDeliveryVehiclesRequest) String

func (x *ListDeliveryVehiclesRequest) String() string

ListDeliveryVehiclesResponse

type ListDeliveryVehiclesResponse struct {

	// The set of delivery vehicles that meet the requested filtering criteria.
	// When no filter is specified, the request returns all delivery vehicles. A
	// successful response can also be empty. An empty response indicates that no
	// delivery vehicles were found meeting the requested filter criteria.
	DeliveryVehicles []*DeliveryVehicle `protobuf:"bytes,1,rep,name=delivery_vehicles,json=deliveryVehicles,proto3" json:"delivery_vehicles,omitempty"`
	// You can pass this token in the `ListDeliveryVehiclesRequest` to continue to
	// list results. When all of the results are returned, this field won't be in
	// the response, or it will be an empty string.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// The total number of delivery vehicles that match 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
}

The ListDeliveryVehicles response message.

func (*ListDeliveryVehiclesResponse) Descriptor

func (*ListDeliveryVehiclesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListDeliveryVehiclesResponse.ProtoReflect.Descriptor instead.

func (*ListDeliveryVehiclesResponse) GetDeliveryVehicles

func (x *ListDeliveryVehiclesResponse) GetDeliveryVehicles() []*DeliveryVehicle

func (*ListDeliveryVehiclesResponse) GetNextPageToken

func (x *ListDeliveryVehiclesResponse) GetNextPageToken() string

func (*ListDeliveryVehiclesResponse) GetTotalSize

func (x *ListDeliveryVehiclesResponse) GetTotalSize() int64

func (*ListDeliveryVehiclesResponse) ProtoMessage

func (*ListDeliveryVehiclesResponse) ProtoMessage()

func (*ListDeliveryVehiclesResponse) ProtoReflect

func (x *ListDeliveryVehiclesResponse) ProtoReflect() protoreflect.Message

func (*ListDeliveryVehiclesResponse) Reset

func (x *ListDeliveryVehiclesResponse) Reset()

func (*ListDeliveryVehiclesResponse) String

func (x *ListDeliveryVehiclesResponse) String() string

ListTasksRequest

type ListTasksRequest struct {

	// Optional. The standard Delivery API request header.
	Header *DeliveryRequestHeader `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
	// Required. Must be in the format `providers/{provider}`.
	// The `provider` must be the Google Cloud Project ID. For example,
	// `sample-cloud-project`.
	Parent string `protobuf:"bytes,3,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The maximum number of Tasks to return. The service may return
	// fewer than this value. If you don't specify this value, then the server
	// determines the number of results to return.
	PageSize int32 `protobuf:"varint,4,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A page token received from a previous `ListTasks` call.
	// You can provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to `ListTasks` must match
	// the call that provided the page token.
	PageToken string `protobuf:"bytes,5,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. A filter query to apply when listing Tasks. See
	// http://aip.dev/160 for examples of filter syntax. If you don't specify a
	// value, or if you filter on an empty string, then all Tasks are returned.
	// For information about the Task properties that you can filter on, see [List
	// tasks](https://developers.google.com/maps/documentation/mobility/fleet-engine/journeys/tasks/find-tasks#filter_listed_tasks).
	Filter string `protobuf:"bytes,6,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

The ListTasks request message.

func (*ListTasksRequest) Descriptor

func (*ListTasksRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListTasksRequest.ProtoReflect.Descriptor instead.

func (*ListTasksRequest) GetFilter

func (x *ListTasksRequest) GetFilter() string

func (*ListTasksRequest) GetHeader

func (x *ListTasksRequest) GetHeader() *DeliveryRequestHeader

func (*ListTasksRequest) GetPageSize

func (x *ListTasksRequest) GetPageSize() int32

func (*ListTasksRequest) GetPageToken

func (x *ListTasksRequest) GetPageToken() string

func (*ListTasksRequest) GetParent

func (x *ListTasksRequest) GetParent() string

func (*ListTasksRequest) ProtoMessage

func (*ListTasksRequest) ProtoMessage()

func (*ListTasksRequest) ProtoReflect

func (x *ListTasksRequest) ProtoReflect() protoreflect.Message

func (*ListTasksRequest) Reset

func (x *ListTasksRequest) Reset()

func (*ListTasksRequest) String

func (x *ListTasksRequest) String() string

ListTasksResponse

type ListTasksResponse struct {

	// The set of Tasks that meet the requested filtering criteria. When no filter
	// is specified, the request returns all tasks. A successful response can also
	// be empty. An empty response indicates that no Tasks were found meeting the
	// requested filter criteria.
	Tasks []*Task `protobuf:"bytes,1,rep,name=tasks,proto3" json:"tasks,omitempty"`
	// Pass this token in the `ListTasksRequest` to continue to list results.
	// If all results have been returned, then this field is either an empty
	// string, or it doesn't appear in the response.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// The total number of Tasks that match 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
}

The ListTasks response that contains the set of Tasks that meet the filter criteria in the ListTasksRequest.

func (*ListTasksResponse) Descriptor

func (*ListTasksResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListTasksResponse.ProtoReflect.Descriptor instead.

func (*ListTasksResponse) GetNextPageToken

func (x *ListTasksResponse) GetNextPageToken() string

func (*ListTasksResponse) GetTasks

func (x *ListTasksResponse) GetTasks() []*Task

func (*ListTasksResponse) GetTotalSize

func (x *ListTasksResponse) GetTotalSize() int64

func (*ListTasksResponse) ProtoMessage

func (*ListTasksResponse) ProtoMessage()

func (*ListTasksResponse) ProtoReflect

func (x *ListTasksResponse) ProtoReflect() protoreflect.Message

func (*ListTasksResponse) Reset

func (x *ListTasksResponse) Reset()

func (*ListTasksResponse) String

func (x *ListTasksResponse) String() string

LocationInfo

type LocationInfo struct {

	// The location's coordinates.
	Point *latlng.LatLng `protobuf:"bytes,1,opt,name=point,proto3" json:"point,omitempty"`
	// contains filtered or unexported fields
}

A location with any additional identifiers.

func (*LocationInfo) Descriptor

func (*LocationInfo) Descriptor() ([]byte, []int)

Deprecated: Use LocationInfo.ProtoReflect.Descriptor instead.

func (*LocationInfo) GetPoint

func (x *LocationInfo) GetPoint() *latlng.LatLng

func (*LocationInfo) ProtoMessage

func (*LocationInfo) ProtoMessage()

func (*LocationInfo) ProtoReflect

func (x *LocationInfo) ProtoReflect() protoreflect.Message

func (*LocationInfo) Reset

func (x *LocationInfo) Reset()

func (*LocationInfo) String

func (x *LocationInfo) String() string

Task

type Task struct {

	// Must be in the format `providers/{provider}/tasks/{task}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. Immutable. Defines the type of the Task. For example, a break or
	// shipment.
	Type Task_Type `protobuf:"varint,2,opt,name=type,proto3,enum=maps.fleetengine.delivery.v1.Task_Type" json:"type,omitempty"`
	// Required. The current execution state of the Task.
	State Task_State `protobuf:"varint,3,opt,name=state,proto3,enum=maps.fleetengine.delivery.v1.Task_State" json:"state,omitempty"`
	// The outcome of the Task.
	TaskOutcome Task_TaskOutcome `protobuf:"varint,9,opt,name=task_outcome,json=taskOutcome,proto3,enum=maps.fleetengine.delivery.v1.Task_TaskOutcome" json:"task_outcome,omitempty"`
	// The timestamp that indicates when the `Task`'s outcome was set by the
	// provider.
	TaskOutcomeTime *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=task_outcome_time,json=taskOutcomeTime,proto3" json:"task_outcome_time,omitempty"`
	// The location where the `Task`'s outcome was set. This value is updated as
	// part of `UpdateTask`. If this value isn't explicitly updated by the
	// provider, then Fleet Engine populates it by default with the last known
	// vehicle location (the *raw* location).
	TaskOutcomeLocation *LocationInfo `protobuf:"bytes,11,opt,name=task_outcome_location,json=taskOutcomeLocation,proto3" json:"task_outcome_location,omitempty"`
	// Indicates where the value of the `task_outcome_location` came from.
	TaskOutcomeLocationSource Task_TaskOutcomeLocationSource `protobuf:"varint,12,opt,name=task_outcome_location_source,json=taskOutcomeLocationSource,proto3,enum=maps.fleetengine.delivery.v1.Task_TaskOutcomeLocationSource" json:"task_outcome_location_source,omitempty"`
	// Immutable. This field facilitates the storing of an ID so you can avoid
	// using a complicated mapping. You cannot set `tracking_id` for Tasks of type
	// `UNAVAILABLE` and `SCHEDULED_STOP`. These IDs are 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 '#'.
	TrackingId string `protobuf:"bytes,4,opt,name=tracking_id,json=trackingId,proto3" json:"tracking_id,omitempty"`
	// Output only. The ID of the vehicle that is executing this Task. Delivery
	// Vehicle IDs are 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 '#'.
	DeliveryVehicleId string `protobuf:"bytes,5,opt,name=delivery_vehicle_id,json=deliveryVehicleId,proto3" json:"delivery_vehicle_id,omitempty"`
	// Immutable. The location where the Task will be completed.
	// Optional for `UNAVAILABLE` Tasks, but required for all other Tasks.
	PlannedLocation *LocationInfo `protobuf:"bytes,6,opt,name=planned_location,json=plannedLocation,proto3" json:"planned_location,omitempty"`
	// Required. Immutable. The time needed to execute a Task at this location.
	TaskDuration *durationpb.Duration `protobuf:"bytes,7,opt,name=task_duration,json=taskDuration,proto3" json:"task_duration,omitempty"`
	// The time window during which the task should be completed.
	TargetTimeWindow *TimeWindow `protobuf:"bytes,14,opt,name=target_time_window,json=targetTimeWindow,proto3" json:"target_time_window,omitempty"`
	// Output only. Journey sharing-specific fields. Not populated when state is
	// `CLOSED`.
	JourneySharingInfo *Task_JourneySharingInfo `protobuf:"bytes,8,opt,name=journey_sharing_info,json=journeySharingInfo,proto3" json:"journey_sharing_info,omitempty"`
	// The configuration for task tracking that specifies which data elements are
	// visible to the end users under what circumstances.
	TaskTrackingViewConfig *TaskTrackingViewConfig `protobuf:"bytes,13,opt,name=task_tracking_view_config,json=taskTrackingViewConfig,proto3" json:"task_tracking_view_config,omitempty"`
	// A list of custom Task attributes. Each attribute must have a unique key.
	Attributes []*TaskAttribute `protobuf:"bytes,15,rep,name=attributes,proto3" json:"attributes,omitempty"`
	// contains filtered or unexported fields
}

A Task in the Delivery API represents a single action to track. In general, there is a distinction between shipment-related Tasks and break Tasks. A shipment can have multiple Tasks associated with it. For example, there could be one Task for the pickup, and one for the drop-off or transfer. Also, different Tasks for a given shipment can be handled by different vehicles. For example, one vehicle could handle the pickup, driving the shipment to the hub, while another vehicle drives the same shipment from the hub to the drop-off location.

Note: gRPC and REST APIs use different field naming conventions. For example, the Task.journey_sharing_info field in the gRPC API and the Task.journeySharingInfo field in the REST API refer to the same field.

func (*Task) Descriptor

func (*Task) Descriptor() ([]byte, []int)

Deprecated: Use Task.ProtoReflect.Descriptor instead.

func (*Task) GetAttributes

func (x *Task) GetAttributes() []*TaskAttribute

func (*Task) GetDeliveryVehicleId

func (x *Task) GetDeliveryVehicleId() string

func (*Task) GetJourneySharingInfo

func (x *Task) GetJourneySharingInfo() *Task_JourneySharingInfo

func (*Task) GetName

func (x *Task) GetName() string

func (*Task) GetPlannedLocation

func (x *Task) GetPlannedLocation() *LocationInfo

func (*Task) GetState

func (x *Task) GetState() Task_State

func (*Task) GetTargetTimeWindow

func (x *Task) GetTargetTimeWindow() *TimeWindow

func (*Task) GetTaskDuration

func (x *Task) GetTaskDuration() *durationpb.Duration

func (*Task) GetTaskOutcome

func (x *Task) GetTaskOutcome() Task_TaskOutcome

func (*Task) GetTaskOutcomeLocation

func (x *Task) GetTaskOutcomeLocation() *LocationInfo

func (*Task) GetTaskOutcomeLocationSource

func (x *Task) GetTaskOutcomeLocationSource() Task_TaskOutcomeLocationSource

func (*Task) GetTaskOutcomeTime

func (x *Task) GetTaskOutcomeTime() *timestamppb.Timestamp

func (*Task) GetTaskTrackingViewConfig

func (x *Task) GetTaskTrackingViewConfig() *TaskTrackingViewConfig

func (*Task) GetTrackingId

func (x *Task) GetTrackingId() string

func (*Task) GetType

func (x *Task) GetType() Task_Type

func (*Task) ProtoMessage

func (*Task) ProtoMessage()

func (*Task) ProtoReflect

func (x *Task) ProtoReflect() protoreflect.Message

func (*Task) Reset

func (x *Task) Reset()

func (*Task) String

func (x *Task) String() string

TaskAttribute

type TaskAttribute 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. If none are
	// set the TaskAttribute string_value will be stored as the empty string "".
	//
	// Types that are valid to be assigned to TaskAttributeValue:
	//
	//	*TaskAttribute_StringValue
	//	*TaskAttribute_BoolValue
	//	*TaskAttribute_NumberValue
	TaskAttributeValue isTaskAttribute_TaskAttributeValue `protobuf_oneof:"task_attribute_value"`
	// contains filtered or unexported fields
}

Describes a task attribute as a key-value pair. The "key:value" string length cannot exceed 256 characters.

func (*TaskAttribute) Descriptor

func (*TaskAttribute) Descriptor() ([]byte, []int)

Deprecated: Use TaskAttribute.ProtoReflect.Descriptor instead.

func (*TaskAttribute) GetBoolValue

func (x *TaskAttribute) GetBoolValue() bool

func (*TaskAttribute) GetKey

func (x *TaskAttribute) GetKey() string

func (*TaskAttribute) GetNumberValue

func (x *TaskAttribute) GetNumberValue() float64

func (*TaskAttribute) GetStringValue

func (x *TaskAttribute) GetStringValue() string

func (*TaskAttribute) GetTaskAttributeValue

func (x *TaskAttribute) GetTaskAttributeValue() isTaskAttribute_TaskAttributeValue

func (*TaskAttribute) ProtoMessage

func (*TaskAttribute) ProtoMessage()

func (*TaskAttribute) ProtoReflect

func (x *TaskAttribute) ProtoReflect() protoreflect.Message

func (*TaskAttribute) Reset

func (x *TaskAttribute) Reset()

func (*TaskAttribute) String

func (x *TaskAttribute) String() string

TaskAttribute_BoolValue

type TaskAttribute_BoolValue struct {
	// Boolean typed attribute value.
	BoolValue bool `protobuf:"varint,3,opt,name=bool_value,json=boolValue,proto3,oneof"`
}

TaskAttribute_NumberValue

type TaskAttribute_NumberValue struct {
	// Double typed attribute value.
	NumberValue float64 `protobuf:"fixed64,4,opt,name=number_value,json=numberValue,proto3,oneof"`
}

TaskAttribute_StringValue

type TaskAttribute_StringValue struct {
	// String typed attribute value.
	StringValue string `protobuf:"bytes,2,opt,name=string_value,json=stringValue,proto3,oneof"`
}

TaskTrackingInfo

type TaskTrackingInfo struct {

	// Must be in the format `providers/{provider}/taskTrackingInfo/{tracking}`,
	// where `tracking` represents the tracking ID.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Immutable. The tracking ID of a Task.
	// * 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 '#'.
	TrackingId string `protobuf:"bytes,2,opt,name=tracking_id,json=trackingId,proto3" json:"tracking_id,omitempty"`
	// The vehicle's last location.
	VehicleLocation *DeliveryVehicleLocation `protobuf:"bytes,3,opt,name=vehicle_location,json=vehicleLocation,proto3" json:"vehicle_location,omitempty"`
	// A list of points which when connected forms a polyline of the vehicle's
	// expected route to the location of this task.
	RoutePolylinePoints []*latlng.LatLng `protobuf:"bytes,4,rep,name=route_polyline_points,json=routePolylinePoints,proto3" json:"route_polyline_points,omitempty"`
	// Indicates the number of stops the vehicle remaining until the task stop is
	// reached, including the task stop. For example, if the vehicle's next stop
	// is the task stop, the value will be 1.
	RemainingStopCount *wrapperspb.Int32Value `protobuf:"bytes,5,opt,name=remaining_stop_count,json=remainingStopCount,proto3" json:"remaining_stop_count,omitempty"`
	// The total remaining distance in meters to the `VehicleStop` of interest.
	RemainingDrivingDistanceMeters *wrapperspb.Int32Value `protobuf:"bytes,6,opt,name=remaining_driving_distance_meters,json=remainingDrivingDistanceMeters,proto3" json:"remaining_driving_distance_meters,omitempty"`
	// The timestamp that indicates the estimated arrival time to the stop
	// location.
	EstimatedArrivalTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=estimated_arrival_time,json=estimatedArrivalTime,proto3" json:"estimated_arrival_time,omitempty"`
	// The timestamp that indicates the estimated completion time of a Task.
	EstimatedTaskCompletionTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=estimated_task_completion_time,json=estimatedTaskCompletionTime,proto3" json:"estimated_task_completion_time,omitempty"`
	// The current execution state of the Task.
	State Task_State `protobuf:"varint,11,opt,name=state,proto3,enum=maps.fleetengine.delivery.v1.Task_State" json:"state,omitempty"`
	// The outcome of attempting to execute a Task.
	TaskOutcome Task_TaskOutcome `protobuf:"varint,9,opt,name=task_outcome,json=taskOutcome,proto3,enum=maps.fleetengine.delivery.v1.Task_TaskOutcome" json:"task_outcome,omitempty"`
	// The timestamp that indicates when the Task's outcome was set by the
	// provider.
	TaskOutcomeTime *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=task_outcome_time,json=taskOutcomeTime,proto3" json:"task_outcome_time,omitempty"`
	// Immutable. The location where the Task will be completed.
	PlannedLocation *LocationInfo `protobuf:"bytes,10,opt,name=planned_location,json=plannedLocation,proto3" json:"planned_location,omitempty"`
	// The time window during which the task should be completed.
	TargetTimeWindow *TimeWindow `protobuf:"bytes,13,opt,name=target_time_window,json=targetTimeWindow,proto3" json:"target_time_window,omitempty"`
	// The custom attributes set on the task.
	Attributes []*TaskAttribute `protobuf:"bytes,14,rep,name=attributes,proto3" json:"attributes,omitempty"`
	// contains filtered or unexported fields
}

The TaskTrackingInfo message. The message contains task tracking information which will be used for display. If a tracking ID is associated with multiple Tasks, Fleet Engine uses a heuristic to decide which Task's TaskTrackingInfo to select.

func (*TaskTrackingInfo) Descriptor

func (*TaskTrackingInfo) Descriptor() ([]byte, []int)

Deprecated: Use TaskTrackingInfo.ProtoReflect.Descriptor instead.

func (*TaskTrackingInfo) GetAttributes

func (x *TaskTrackingInfo) GetAttributes() []*TaskAttribute

func (*TaskTrackingInfo) GetEstimatedArrivalTime

func (x *TaskTrackingInfo) GetEstimatedArrivalTime() *timestamppb.Timestamp

func (*TaskTrackingInfo) GetEstimatedTaskCompletionTime

func (x *TaskTrackingInfo) GetEstimatedTaskCompletionTime() *timestamppb.Timestamp

func (*TaskTrackingInfo) GetName

func (x *TaskTrackingInfo) GetName() string

func (*TaskTrackingInfo) GetPlannedLocation

func (x *TaskTrackingInfo) GetPlannedLocation() *LocationInfo

func (*TaskTrackingInfo) GetRemainingDrivingDistanceMeters

func (x *TaskTrackingInfo) GetRemainingDrivingDistanceMeters() *wrapperspb.Int32Value

func (*TaskTrackingInfo) GetRemainingStopCount

func (x *TaskTrackingInfo) GetRemainingStopCount() *wrapperspb.Int32Value

func (*TaskTrackingInfo) GetRoutePolylinePoints

func (x *TaskTrackingInfo) GetRoutePolylinePoints() []*latlng.LatLng

func (*TaskTrackingInfo) GetState

func (x *TaskTrackingInfo) GetState() Task_State

func (*TaskTrackingInfo) GetTargetTimeWindow

func (x *TaskTrackingInfo) GetTargetTimeWindow() *TimeWindow

func (*TaskTrackingInfo) GetTaskOutcome

func (x *TaskTrackingInfo) GetTaskOutcome() Task_TaskOutcome

func (*TaskTrackingInfo) GetTaskOutcomeTime

func (x *TaskTrackingInfo) GetTaskOutcomeTime() *timestamppb.Timestamp

func (*TaskTrackingInfo) GetTrackingId

func (x *TaskTrackingInfo) GetTrackingId() string

func (*TaskTrackingInfo) GetVehicleLocation

func (x *TaskTrackingInfo) GetVehicleLocation() *DeliveryVehicleLocation

func (*TaskTrackingInfo) ProtoMessage

func (*TaskTrackingInfo) ProtoMessage()

func (*TaskTrackingInfo) ProtoReflect

func (x *TaskTrackingInfo) ProtoReflect() protoreflect.Message

func (*TaskTrackingInfo) Reset

func (x *TaskTrackingInfo) Reset()

func (*TaskTrackingInfo) String

func (x *TaskTrackingInfo) String() string

TaskTrackingViewConfig

type TaskTrackingViewConfig struct {

	// The field that specifies when route polyline points can be visible. If this
	// field is not specified, the project level default visibility configuration
	// for this data will be used.
	RoutePolylinePointsVisibility *TaskTrackingViewConfig_VisibilityOption `protobuf:"bytes,1,opt,name=route_polyline_points_visibility,json=routePolylinePointsVisibility,proto3" json:"route_polyline_points_visibility,omitempty"`
	// The field that specifies when estimated arrival time can be visible. If
	// this field is not specified, the project level default visibility
	// configuration for this data will be used.
	EstimatedArrivalTimeVisibility *TaskTrackingViewConfig_VisibilityOption `protobuf:"bytes,2,opt,name=estimated_arrival_time_visibility,json=estimatedArrivalTimeVisibility,proto3" json:"estimated_arrival_time_visibility,omitempty"`
	// The field that specifies when estimated task completion time can be
	// visible. If this field is not specified, the project level default
	// visibility configuration for this data will be used.
	EstimatedTaskCompletionTimeVisibility *TaskTrackingViewConfig_VisibilityOption `protobuf:"bytes,3,opt,name=estimated_task_completion_time_visibility,json=estimatedTaskCompletionTimeVisibility,proto3" json:"estimated_task_completion_time_visibility,omitempty"`
	// The field that specifies when remaining driving distance can be visible. If
	// this field is not specified, the project level default visibility
	// configuration for this data will be used.
	RemainingDrivingDistanceVisibility *TaskTrackingViewConfig_VisibilityOption `protobuf:"bytes,4,opt,name=remaining_driving_distance_visibility,json=remainingDrivingDistanceVisibility,proto3" json:"remaining_driving_distance_visibility,omitempty"`
	// The field that specifies when remaining stop count can be visible. If this
	// field is not specified, the project level default visibility configuration
	// for this data will be used.
	RemainingStopCountVisibility *TaskTrackingViewConfig_VisibilityOption `protobuf:"bytes,5,opt,name=remaining_stop_count_visibility,json=remainingStopCountVisibility,proto3" json:"remaining_stop_count_visibility,omitempty"`
	// The field that specifies when vehicle location can be visible. If this
	// field is not specified, the project level default visibility configuration
	// for this data will be used.
	VehicleLocationVisibility *TaskTrackingViewConfig_VisibilityOption `protobuf:"bytes,6,opt,name=vehicle_location_visibility,json=vehicleLocationVisibility,proto3" json:"vehicle_location_visibility,omitempty"`
	// contains filtered or unexported fields
}

The configuration message that defines when a data element of a Task should be visible to the end users.

func (*TaskTrackingViewConfig) Descriptor

func (*TaskTrackingViewConfig) Descriptor() ([]byte, []int)

Deprecated: Use TaskTrackingViewConfig.ProtoReflect.Descriptor instead.

func (*TaskTrackingViewConfig) GetEstimatedArrivalTimeVisibility

func (x *TaskTrackingViewConfig) GetEstimatedArrivalTimeVisibility() *TaskTrackingViewConfig_VisibilityOption

func (*TaskTrackingViewConfig) GetEstimatedTaskCompletionTimeVisibility

func (x *TaskTrackingViewConfig) GetEstimatedTaskCompletionTimeVisibility() *TaskTrackingViewConfig_VisibilityOption

func (*TaskTrackingViewConfig) GetRemainingDrivingDistanceVisibility

func (x *TaskTrackingViewConfig) GetRemainingDrivingDistanceVisibility() *TaskTrackingViewConfig_VisibilityOption

func (*TaskTrackingViewConfig) GetRemainingStopCountVisibility

func (x *TaskTrackingViewConfig) GetRemainingStopCountVisibility() *TaskTrackingViewConfig_VisibilityOption

func (*TaskTrackingViewConfig) GetRoutePolylinePointsVisibility

func (x *TaskTrackingViewConfig) GetRoutePolylinePointsVisibility() *TaskTrackingViewConfig_VisibilityOption

func (*TaskTrackingViewConfig) GetVehicleLocationVisibility

func (x *TaskTrackingViewConfig) GetVehicleLocationVisibility() *TaskTrackingViewConfig_VisibilityOption

func (*TaskTrackingViewConfig) ProtoMessage

func (*TaskTrackingViewConfig) ProtoMessage()

func (*TaskTrackingViewConfig) ProtoReflect

func (x *TaskTrackingViewConfig) ProtoReflect() protoreflect.Message

func (*TaskTrackingViewConfig) Reset

func (x *TaskTrackingViewConfig) Reset()

func (*TaskTrackingViewConfig) String

func (x *TaskTrackingViewConfig) String() string

TaskTrackingViewConfig_VisibilityOption

type TaskTrackingViewConfig_VisibilityOption struct {

	// The specific visibility option chosen.
	//
	// Types that are valid to be assigned to VisibilityOption:
	//
	//	*TaskTrackingViewConfig_VisibilityOption_RemainingStopCountThreshold
	//	*TaskTrackingViewConfig_VisibilityOption_DurationUntilEstimatedArrivalTimeThreshold
	//	*TaskTrackingViewConfig_VisibilityOption_RemainingDrivingDistanceMetersThreshold
	//	*TaskTrackingViewConfig_VisibilityOption_Always
	//	*TaskTrackingViewConfig_VisibilityOption_Never
	VisibilityOption isTaskTrackingViewConfig_VisibilityOption_VisibilityOption `protobuf_oneof:"visibility_option"`
	// contains filtered or unexported fields
}

The option message that defines when a data element should be visible to the end users.

func (*TaskTrackingViewConfig_VisibilityOption) Descriptor

func (*TaskTrackingViewConfig_VisibilityOption) Descriptor() ([]byte, []int)

Deprecated: Use TaskTrackingViewConfig_VisibilityOption.ProtoReflect.Descriptor instead.

func (*TaskTrackingViewConfig_VisibilityOption) GetAlways

func (x *TaskTrackingViewConfig_VisibilityOption) GetAlways() bool

func (*TaskTrackingViewConfig_VisibilityOption) GetDurationUntilEstimatedArrivalTimeThreshold

func (x *TaskTrackingViewConfig_VisibilityOption) GetDurationUntilEstimatedArrivalTimeThreshold() *durationpb.Duration

func (*TaskTrackingViewConfig_VisibilityOption) GetNever

func (x *TaskTrackingViewConfig_VisibilityOption) GetNever() bool

func (*TaskTrackingViewConfig_VisibilityOption) GetRemainingDrivingDistanceMetersThreshold

func (x *TaskTrackingViewConfig_VisibilityOption) GetRemainingDrivingDistanceMetersThreshold() int32

func (*TaskTrackingViewConfig_VisibilityOption) GetRemainingStopCountThreshold

func (x *TaskTrackingViewConfig_VisibilityOption) GetRemainingStopCountThreshold() int32

func (*TaskTrackingViewConfig_VisibilityOption) GetVisibilityOption

func (x *TaskTrackingViewConfig_VisibilityOption) GetVisibilityOption() isTaskTrackingViewConfig_VisibilityOption_VisibilityOption

func (*TaskTrackingViewConfig_VisibilityOption) ProtoMessage

func (*TaskTrackingViewConfig_VisibilityOption) ProtoMessage()

func (*TaskTrackingViewConfig_VisibilityOption) ProtoReflect

func (x *TaskTrackingViewConfig_VisibilityOption) ProtoReflect() protoreflect.Message

func (*TaskTrackingViewConfig_VisibilityOption) Reset

func (x *TaskTrackingViewConfig_VisibilityOption) Reset()

func (*TaskTrackingViewConfig_VisibilityOption) String

func (x *TaskTrackingViewConfig_VisibilityOption) String() string

TaskTrackingViewConfig_VisibilityOption_Always

type TaskTrackingViewConfig_VisibilityOption_Always struct {
	// If set to true, this data element is always visible to the end users
	// with no thresholds. This field cannot be set to false.
	Always bool `protobuf:"varint,4,opt,name=always,proto3,oneof"`
}

TaskTrackingViewConfig_VisibilityOption_DurationUntilEstimatedArrivalTimeThreshold

type TaskTrackingViewConfig_VisibilityOption_DurationUntilEstimatedArrivalTimeThreshold struct {
	// This data element is visible to the end users if the ETA to the stop
	// <= duration_until_estimated_arrival_time_threshold.="" durationuntilestimatedarrivaltimethreshold="" *durationpb.duration="" `protobuf:"bytes,2,opt,name="duration_until_estimated_arrival_time_threshold,json=durationUntilEstimatedArrivalTimeThreshold,proto3,oneof" `"="">

TaskTrackingViewConfig_VisibilityOption_Never

type TaskTrackingViewConfig_VisibilityOption_Never struct {
	// If set to true, this data element is always hidden from the end users
	// with no thresholds. This field cannot be set to false.
	Never bool `protobuf:"varint,5,opt,name=never,proto3,oneof"`
}

TaskTrackingViewConfig_VisibilityOption_RemainingDrivingDistanceMetersThreshold

type TaskTrackingViewConfig_VisibilityOption_RemainingDrivingDistanceMetersThreshold struct {
	// This data element is visible to the end users if the remaining
	// driving distance in meters <= remaining_driving_distance_meters_threshold.="" remainingdrivingdistancemetersthreshold="">int32 `protobuf:"varint,3,opt,name=remaining_driving_distance_meters_threshold,json=remainingDrivingDistanceMetersThreshold,proto3,oneof"`
}

TaskTrackingViewConfig_VisibilityOption_RemainingStopCountThreshold

type TaskTrackingViewConfig_VisibilityOption_RemainingStopCountThreshold struct {
	// This data element is visible to the end users if the remaining stop
	// count <= remaining_stop_count_threshold.="" remainingstopcountthreshold="">int32 `protobuf:"varint,1,opt,name=remaining_stop_count_threshold,json=remainingStopCountThreshold,proto3,oneof"`
}

Task_JourneySharingInfo

type Task_JourneySharingInfo struct {

	// Tracking information for the stops that the assigned vehicle will make
	// before it completes this Task. Note that this list can contain stops
	// from other tasks.
	//
	// The first segment,
	// `Task.journey_sharing_info.remaining_vehicle_journey_segments[0]` (gRPC)
	// or `Task.journeySharingInfo.remainingVehicleJourneySegments[0]` (REST),
	// contains route information from the driver's last known location to the
	// upcoming `VehicleStop`. Current route information usually comes from the
	// driver app, except for some cases noted in the documentation for
	// [DeliveryVehicle.current_route_segment][maps.fleetengine.delivery.v1.DeliveryVehicle.current_route_segment].
	// The other segments in
	// `Task.journey_sharing_info.remaining_vehicle_journey_segments` (gRPC) or
	// `Task.journeySharingInfo.remainingVehicleJourneySegments` (REST) are
	// populated by Fleet Engine. They provide route information between the
	// remaining `VehicleStops`.
	RemainingVehicleJourneySegments []*VehicleJourneySegment `protobuf:"bytes,1,rep,name=remaining_vehicle_journey_segments,json=remainingVehicleJourneySegments,proto3" json:"remaining_vehicle_journey_segments,omitempty"`
	// Indicates the vehicle's last reported location of the assigned vehicle.
	LastLocation *DeliveryVehicleLocation `protobuf:"bytes,2,opt,name=last_location,json=lastLocation,proto3" json:"last_location,omitempty"`
	// Indicates whether the vehicle's lastLocation can be snapped to
	// the `current_route_segment`. This value is False if either
	// `last_location` or `current_route_segment` don't exist. This value is
	// computed by Fleet Engine. Updates from clients are ignored.
	LastLocationSnappable bool `protobuf:"varint,3,opt,name=last_location_snappable,json=lastLocationSnappable,proto3" json:"last_location_snappable,omitempty"`
	// contains filtered or unexported fields
}

Journey sharing specific fields.

func (*Task_JourneySharingInfo) Descriptor

func (*Task_JourneySharingInfo) Descriptor() ([]byte, []int)

Deprecated: Use Task_JourneySharingInfo.ProtoReflect.Descriptor instead.

func (*Task_JourneySharingInfo) GetLastLocation

func (x *Task_JourneySharingInfo) GetLastLocation() *DeliveryVehicleLocation

func (*Task_JourneySharingInfo) GetLastLocationSnappable

func (x *Task_JourneySharingInfo) GetLastLocationSnappable() bool

func (*Task_JourneySharingInfo) GetRemainingVehicleJourneySegments

func (x *Task_JourneySharingInfo) GetRemainingVehicleJourneySegments() []*VehicleJourneySegment

func (*Task_JourneySharingInfo) ProtoMessage

func (*Task_JourneySharingInfo) ProtoMessage()

func (*Task_JourneySharingInfo) ProtoReflect

func (x *Task_JourneySharingInfo) ProtoReflect() protoreflect.Message

func (*Task_JourneySharingInfo) Reset

func (x *Task_JourneySharingInfo) Reset()

func (*Task_JourneySharingInfo) String

func (x *Task_JourneySharingInfo) String() string

Task_State

type Task_State int32

The state of a Task. This indicates the Tasks's progress.

Task_STATE_UNSPECIFIED, Task_OPEN, Task_CLOSED

const (
	// Default. Used for an unspecified or unrecognized Task state.
	Task_STATE_UNSPECIFIED Task_State = 0
	// Either the Task has not yet been assigned to a delivery vehicle, or the
	// delivery vehicle has not yet passed the `Task`'s assigned vehicle stop.
	Task_OPEN Task_State = 1
	// When the vehicle passes the vehicle stop for this Task.
	Task_CLOSED Task_State = 2
)

func (Task_State) Descriptor

func (Task_State) Descriptor() protoreflect.EnumDescriptor

func (Task_State) Enum

func (x Task_State) Enum() *Task_State

func (Task_State) EnumDescriptor

func (Task_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Task_State.Descriptor instead.

func (Task_State) Number

func (x Task_State) Number() protoreflect.EnumNumber

func (Task_State) String

func (x Task_State) String() string

func (Task_State) Type

func (Task_State) Type() protoreflect.EnumType

Task_TaskOutcome

type Task_TaskOutcome int32

The outcome of attempting to execute a Task. When TaskState is closed, TaskOutcome indicates whether it was completed successfully.

Task_TASK_OUTCOME_UNSPECIFIED, Task_SUCCEEDED, Task_FAILED

const (
	// The Task outcome before its value is set.
	Task_TASK_OUTCOME_UNSPECIFIED Task_TaskOutcome = 0
	// The Task completed successfully.
	Task_SUCCEEDED Task_TaskOutcome = 1
	// Either the Task couldn't be completed, or it was cancelled.
	Task_FAILED Task_TaskOutcome = 2
)

func (Task_TaskOutcome) Descriptor

func (Task_TaskOutcome) Descriptor() protoreflect.EnumDescriptor

func (Task_TaskOutcome) Enum

func (x Task_TaskOutcome) Enum() *Task_TaskOutcome

func (Task_TaskOutcome) EnumDescriptor

func (Task_TaskOutcome) EnumDescriptor() ([]byte, []int)

Deprecated: Use Task_TaskOutcome.Descriptor instead.

func (Task_TaskOutcome) Number

func (x Task_TaskOutcome) Number() protoreflect.EnumNumber

func (Task_TaskOutcome) String

func (x Task_TaskOutcome) String() string

func (Task_TaskOutcome) Type

func (Task_TaskOutcome) Type() protoreflect.EnumType

Task_TaskOutcomeLocationSource

type Task_TaskOutcomeLocationSource int32

The identity of the source that populated the task_outcome_location.

Task_TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED, Task_PROVIDER, Task_LAST_VEHICLE_LOCATION

const (
	// The task outcome before it is set.
	Task_TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED Task_TaskOutcomeLocationSource = 0
	// The provider-specified the `task_outcome_location`.
	Task_PROVIDER Task_TaskOutcomeLocationSource = 2
	// The provider didn't specify the `task_outcome_location`, so Fleet Engine
	// used the last known vehicle location.
	Task_LAST_VEHICLE_LOCATION Task_TaskOutcomeLocationSource = 3
)

func (Task_TaskOutcomeLocationSource) Descriptor

func (Task_TaskOutcomeLocationSource) Descriptor() protoreflect.EnumDescriptor

func (Task_TaskOutcomeLocationSource) Enum

func (x Task_TaskOutcomeLocationSource) Enum() *Task_TaskOutcomeLocationSource

func (Task_TaskOutcomeLocationSource) EnumDescriptor

func (Task_TaskOutcomeLocationSource) EnumDescriptor() ([]byte, []int)

Deprecated: Use Task_TaskOutcomeLocationSource.Descriptor instead.

func (Task_TaskOutcomeLocationSource) Number

func (x Task_TaskOutcomeLocationSource) Number() protoreflect.EnumNumber

func (Task_TaskOutcomeLocationSource) String

func (x Task_TaskOutcomeLocationSource) String() string

func (Task_TaskOutcomeLocationSource) Type

func (Task_TaskOutcomeLocationSource) Type() protoreflect.EnumType

Task_Type

type Task_Type int32

The type of Task.

Task_TYPE_UNSPECIFIED, Task_PICKUP, Task_DELIVERY, Task_SCHEDULED_STOP, Task_UNAVAILABLE

const (
	// Default, the Task type is unknown.
	Task_TYPE_UNSPECIFIED Task_Type = 0
	// A pickup Task is the action taken for picking up a shipment from a
	// customer. Depot or feeder vehicle pickups should use the `SCHEDULED_STOP`
	// type.
	Task_PICKUP Task_Type = 1
	// A delivery Task is the action taken for delivering a shipment to an end
	// customer. Depot or feeder vehicle dropoffs should use the
	// `SCHEDULED_STOP` type.
	Task_DELIVERY Task_Type = 2
	// A scheduled stop Task is used for planning purposes. For example, it
	// could represent picking up or dropping off shipments from feeder vehicles
	// or depots. It shouldn't be used for any shipments that are picked up or
	// dropped off from an end customer.
	Task_SCHEDULED_STOP Task_Type = 3
	// A Task that means the Vehicle is not available for service. For example,
	// this can happen when the driver takes a break, or when the vehicle
	// is being refueled.
	Task_UNAVAILABLE Task_Type = 4
)

func (Task_Type) Descriptor

func (Task_Type) Descriptor() protoreflect.EnumDescriptor

func (Task_Type) Enum

func (x Task_Type) Enum() *Task_Type

func (Task_Type) EnumDescriptor

func (Task_Type) EnumDescriptor() ([]byte, []int)

Deprecated: Use Task_Type.Descriptor instead.

func (Task_Type) Number

func (x Task_Type) Number() protoreflect.EnumNumber

func (Task_Type) String

func (x Task_Type) String() string

func (Task_Type) Type

func (Task_Type) Type() protoreflect.EnumType

TimeWindow

type TimeWindow struct {

	// Required. The start time of the time window (inclusive).
	StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// Required. The end time of the time window (inclusive).
	EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// contains filtered or unexported fields
}

A time range.

func (*TimeWindow) Descriptor

func (*TimeWindow) Descriptor() ([]byte, []int)

Deprecated: Use TimeWindow.ProtoReflect.Descriptor instead.

func (*TimeWindow) GetEndTime

func (x *TimeWindow) GetEndTime() *timestamppb.Timestamp

func (*TimeWindow) GetStartTime

func (x *TimeWindow) GetStartTime() *timestamppb.Timestamp

func (*TimeWindow) ProtoMessage

func (*TimeWindow) ProtoMessage()

func (*TimeWindow) ProtoReflect

func (x *TimeWindow) ProtoReflect() protoreflect.Message

func (*TimeWindow) Reset

func (x *TimeWindow) Reset()

func (*TimeWindow) String

func (x *TimeWindow) String() string

UnimplementedDeliveryServiceServer

type UnimplementedDeliveryServiceServer struct {
}

UnimplementedDeliveryServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedDeliveryServiceServer) BatchCreateTasks

func (UnimplementedDeliveryServiceServer) BatchCreateTasks(context.Context, *BatchCreateTasksRequest) (*BatchCreateTasksResponse, error)

func (UnimplementedDeliveryServiceServer) CreateDeliveryVehicle

func (UnimplementedDeliveryServiceServer) CreateDeliveryVehicle(context.Context, *CreateDeliveryVehicleRequest) (*DeliveryVehicle, error)

func (UnimplementedDeliveryServiceServer) CreateTask

func (UnimplementedDeliveryServiceServer) CreateTask(context.Context, *CreateTaskRequest) (*Task, error)

func (UnimplementedDeliveryServiceServer) DeleteDeliveryVehicle

func (UnimplementedDeliveryServiceServer) DeleteDeliveryVehicle(context.Context, *DeleteDeliveryVehicleRequest) (*emptypb.Empty, error)

func (UnimplementedDeliveryServiceServer) DeleteTask

func (UnimplementedDeliveryServiceServer) DeleteTask(context.Context, *DeleteTaskRequest) (*emptypb.Empty, error)

func (UnimplementedDeliveryServiceServer) GetDeliveryVehicle

func (UnimplementedDeliveryServiceServer) GetDeliveryVehicle(context.Context, *GetDeliveryVehicleRequest) (*DeliveryVehicle, error)

func (UnimplementedDeliveryServiceServer) GetTask

func (UnimplementedDeliveryServiceServer) GetTask(context.Context, *GetTaskRequest) (*Task, error)

func (UnimplementedDeliveryServiceServer) GetTaskTrackingInfo

func (UnimplementedDeliveryServiceServer) GetTaskTrackingInfo(context.Context, *GetTaskTrackingInfoRequest) (*TaskTrackingInfo, error)

func (UnimplementedDeliveryServiceServer) ListDeliveryVehicles

func (UnimplementedDeliveryServiceServer) ListDeliveryVehicles(context.Context, *ListDeliveryVehiclesRequest) (*ListDeliveryVehiclesResponse, error)

func (UnimplementedDeliveryServiceServer) ListTasks

func (UnimplementedDeliveryServiceServer) ListTasks(context.Context, *ListTasksRequest) (*ListTasksResponse, error)

func (UnimplementedDeliveryServiceServer) UpdateDeliveryVehicle

func (UnimplementedDeliveryServiceServer) UpdateDeliveryVehicle(context.Context, *UpdateDeliveryVehicleRequest) (*DeliveryVehicle, error)

func (UnimplementedDeliveryServiceServer) UpdateTask

func (UnimplementedDeliveryServiceServer) UpdateTask(context.Context, *UpdateTaskRequest) (*Task, error)

UnsafeDeliveryServiceServer

type UnsafeDeliveryServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeDeliveryServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to DeliveryServiceServer will result in compilation errors.

UpdateDeliveryVehicleRequest

type UpdateDeliveryVehicleRequest struct {

	// Optional. The standard Delivery API request header.
	Header *DeliveryRequestHeader `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
	// Required. The `DeliveryVehicle` entity update to apply.
	// Note: You cannot update the name of the `DeliveryVehicle`.
	DeliveryVehicle *DeliveryVehicle `protobuf:"bytes,3,opt,name=delivery_vehicle,json=deliveryVehicle,proto3" json:"delivery_vehicle,omitempty"`
	// Required. A field mask that indicates which `DeliveryVehicle` fields to
	// update. Note that the update_mask must contain at least one field.
	//
	// This is a comma-separated list of fully qualified names of fields. Example:
	// `"remaining_vehicle_journey_segments"`.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,4,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

The UpdateDeliveryVehicle request message.

func (*UpdateDeliveryVehicleRequest) Descriptor

func (*UpdateDeliveryVehicleRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateDeliveryVehicleRequest.ProtoReflect.Descriptor instead.

func (*UpdateDeliveryVehicleRequest) GetDeliveryVehicle

func (x *UpdateDeliveryVehicleRequest) GetDeliveryVehicle() *DeliveryVehicle

func (*UpdateDeliveryVehicleRequest) GetHeader

func (x *UpdateDeliveryVehicleRequest) GetHeader() *DeliveryRequestHeader

func (*UpdateDeliveryVehicleRequest) GetUpdateMask

func (x *UpdateDeliveryVehicleRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateDeliveryVehicleRequest) ProtoMessage

func (*UpdateDeliveryVehicleRequest) ProtoMessage()

func (*UpdateDeliveryVehicleRequest) ProtoReflect

func (x *UpdateDeliveryVehicleRequest) ProtoReflect() protoreflect.Message

func (*UpdateDeliveryVehicleRequest) Reset

func (x *UpdateDeliveryVehicleRequest) Reset()

func (*UpdateDeliveryVehicleRequest) String

func (x *UpdateDeliveryVehicleRequest) String() string

UpdateTaskRequest

type UpdateTaskRequest struct {

	// Optional. The standard Delivery API request header.
	Header *DeliveryRequestHeader `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
	// Required. The Task associated with the update.
	// The following fields are maintained by Fleet Engine. Do not update
	// them using `Task.update`.
	//
	//   - `last_location`.
	//   - `last_location_snappable`.
	//   - `name`.
	//   - `remaining_vehicle_journey_segments`.
	//   - `task_outcome_location_source`.
	//
	// Note: You cannot change the value of `task_outcome` once you set it.
	//
	// If the Task has been assigned to a delivery vehicle, then don't set the
	// Task state to CLOSED using `Task.update`. Instead, remove the `VehicleStop`
	// that contains the Task from the delivery vehicle, which automatically sets
	// the Task state to CLOSED.
	Task *Task `protobuf:"bytes,3,opt,name=task,proto3" json:"task,omitempty"`
	// Required. The field mask that indicates which Task fields to update.
	// Note: The `update_mask` must contain at least one field.
	//
	// This is a comma-separated list of fully qualified names of fields. Example:
	// `"task_outcome,task_outcome_time,task_outcome_location"`.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,4,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

The UpdateTask request message.

func (*UpdateTaskRequest) Descriptor

func (*UpdateTaskRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateTaskRequest.ProtoReflect.Descriptor instead.

func (*UpdateTaskRequest) GetHeader

func (x *UpdateTaskRequest) GetHeader() *DeliveryRequestHeader

func (*UpdateTaskRequest) GetTask

func (x *UpdateTaskRequest) GetTask() *Task

func (*UpdateTaskRequest) GetUpdateMask

func (x *UpdateTaskRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateTaskRequest) ProtoMessage

func (*UpdateTaskRequest) ProtoMessage()

func (*UpdateTaskRequest) ProtoReflect

func (x *UpdateTaskRequest) ProtoReflect() protoreflect.Message

func (*UpdateTaskRequest) Reset

func (x *UpdateTaskRequest) Reset()

func (*UpdateTaskRequest) String

func (x *UpdateTaskRequest) String() string

VehicleJourneySegment

type VehicleJourneySegment struct {

	// Specifies the stop location, along with the `Task`s associated with
	// the stop. Some fields of the VehicleStop might not be present if this
	// journey segment is part of `JourneySharingInfo`.
	Stop *VehicleStop `protobuf:"bytes,1,opt,name=stop,proto3" json:"stop,omitempty"`
	// Output only. The travel distance from the previous stop to this stop.
	// If the current stop is the first stop in the list of journey
	// segments, then the starting point is the vehicle's location recorded
	// at the time that this stop was added to the list. This field might not be
	// present if this journey segment is part of `JourneySharingInfo`.
	DrivingDistanceMeters *wrapperspb.Int32Value `protobuf:"bytes,2,opt,name=driving_distance_meters,json=drivingDistanceMeters,proto3" json:"driving_distance_meters,omitempty"`
	// Output only. The travel time from the previous stop to this stop.
	// If the current stop is the first stop in the list of journey
	// segments, then the starting point is the Vehicle's location recorded
	// at the time that this stop was added to the list.
	//
	// If this field is defined in the path
	// `Task.remaining_vehicle_journey_segments[0].driving_duration` (gRPC) or
	// `Task.remainingVehicleJourneySegments[0].drivingDuration` (REST),
	// then it may be populated with the value from
	// `DeliveryVehicle.remaining_duration` (gRPC) or
	// `DeliveryVehicle.remainingDuration` (REST).
	// This provides the remaining driving duration from the driver app's latest
	// known location rather than the driving time from the previous stop.
	DrivingDuration *durationpb.Duration `protobuf:"bytes,3,opt,name=driving_duration,json=drivingDuration,proto3" json:"driving_duration,omitempty"`
	// Output only. The path from the previous stop to this stop. If the current
	// stop is the first stop in the list of journey segments, then this is the
	// path from the vehicle's current location to this stop at the time that the
	// stop was added to the list. This field might not be present if this journey
	// segment is part of `JourneySharingInfo`.
	//
	// If this field is defined in the path
	// `Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path`
	// (gRPC) or `Task.journeySharingInfo.remainingVehicleJourneySegments[0].path`
	// (REST), then it may be populated with the `LatLng`s decoded from
	// `DeliveryVehicle.current_route_segment` (gRPC) or
	// `DeliveryVehicle.currentRouteSegment` (REST). This provides the driving
	// path from the driver app's latest known location rather than the path from
	// the previous stop.
	Path []*latlng.LatLng `protobuf:"bytes,5,rep,name=path,proto3" json:"path,omitempty"`
	// contains filtered or unexported fields
}

Represents a Vehicle’s travel segment - from its previous stop to the current stop. If it is the first active stop, then it is from the Vehicle’s current location to this stop.

func (*VehicleJourneySegment) Descriptor

func (*VehicleJourneySegment) Descriptor() ([]byte, []int)

Deprecated: Use VehicleJourneySegment.ProtoReflect.Descriptor instead.

func (*VehicleJourneySegment) GetDrivingDistanceMeters

func (x *VehicleJourneySegment) GetDrivingDistanceMeters() *wrapperspb.Int32Value

func (*VehicleJourneySegment) GetDrivingDuration

func (x *VehicleJourneySegment) GetDrivingDuration() *durationpb.Duration

func (*VehicleJourneySegment) GetPath

func (x *VehicleJourneySegment) GetPath() []*latlng.LatLng

func (*VehicleJourneySegment) GetStop

func (x *VehicleJourneySegment) GetStop() *VehicleStop

func (*VehicleJourneySegment) ProtoMessage

func (*VehicleJourneySegment) ProtoMessage()

func (*VehicleJourneySegment) ProtoReflect

func (x *VehicleJourneySegment) ProtoReflect() protoreflect.Message

func (*VehicleJourneySegment) Reset

func (x *VehicleJourneySegment) Reset()

func (*VehicleJourneySegment) String

func (x *VehicleJourneySegment) String() string

VehicleStop

type VehicleStop struct {

	// Required. The location of the stop. Note that the locations in the `Task`s
	// might not exactly match this location, but will be within a short distance
	// of it. This field won't be populated in the response of a `GetTask` call.
	PlannedLocation *LocationInfo `protobuf:"bytes,1,opt,name=planned_location,json=plannedLocation,proto3" json:"planned_location,omitempty"`
	// The list of `Task`s to be performed at this stop. This field won't be
	// populated in the response of a `GetTask` call.
	Tasks []*VehicleStop_TaskInfo `protobuf:"bytes,2,rep,name=tasks,proto3" json:"tasks,omitempty"`
	// The state of the `VehicleStop`. This field won't be populated in the
	// response of a `GetTask` call.
	State VehicleStop_State `protobuf:"varint,3,opt,name=state,proto3,enum=maps.fleetengine.delivery.v1.VehicleStop_State" json:"state,omitempty"`
	// contains filtered or unexported fields
}

Describes a point where a Vehicle stops to perform one or more Tasks.

func (*VehicleStop) Descriptor

func (*VehicleStop) Descriptor() ([]byte, []int)

Deprecated: Use VehicleStop.ProtoReflect.Descriptor instead.

func (*VehicleStop) GetPlannedLocation

func (x *VehicleStop) GetPlannedLocation() *LocationInfo

func (*VehicleStop) GetState

func (x *VehicleStop) GetState() VehicleStop_State

func (*VehicleStop) GetTasks

func (x *VehicleStop) GetTasks() []*VehicleStop_TaskInfo

func (*VehicleStop) ProtoMessage

func (*VehicleStop) ProtoMessage()

func (*VehicleStop) ProtoReflect

func (x *VehicleStop) ProtoReflect() protoreflect.Message

func (*VehicleStop) Reset

func (x *VehicleStop) Reset()

func (*VehicleStop) String

func (x *VehicleStop) String() string

VehicleStop_State

type VehicleStop_State int32

The current state of a VehicleStop.

VehicleStop_STATE_UNSPECIFIED, VehicleStop_NEW, VehicleStop_ENROUTE, VehicleStop_ARRIVED

const (
	// Unknown.
	VehicleStop_STATE_UNSPECIFIED VehicleStop_State = 0
	// Created, but not actively routing.
	VehicleStop_NEW VehicleStop_State = 1
	// Assigned and actively routing.
	VehicleStop_ENROUTE VehicleStop_State = 2
	// Arrived at stop. Assumes that when the Vehicle is routing to the next
	// stop, that all previous stops have been completed.
	VehicleStop_ARRIVED VehicleStop_State = 3
)

func (VehicleStop_State) Descriptor

func (VehicleStop_State) Descriptor() protoreflect.EnumDescriptor

func (VehicleStop_State) Enum

func (x VehicleStop_State) Enum() *VehicleStop_State

func (VehicleStop_State) EnumDescriptor

func (VehicleStop_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use VehicleStop_State.Descriptor instead.

func (VehicleStop_State) Number

func (x VehicleStop_State) Number() protoreflect.EnumNumber

func (VehicleStop_State) String

func (x VehicleStop_State) String() string

func (VehicleStop_State) Type

func (VehicleStop_State) Type() protoreflect.EnumType

VehicleStop_TaskInfo

type VehicleStop_TaskInfo struct {

	// The Task ID. This field won't be populated in the response of a `GetTask`
	// call. Task IDs are 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 '#'.
	TaskId string `protobuf:"bytes,1,opt,name=task_id,json=taskId,proto3" json:"task_id,omitempty"`
	// Output only. The time required to perform the Task.
	TaskDuration *durationpb.Duration `protobuf:"bytes,2,opt,name=task_duration,json=taskDuration,proto3" json:"task_duration,omitempty"`
	// Output only. The time window during which the task should be completed.
	// This is only set in the response to `GetDeliveryVehicle`.
	TargetTimeWindow *TimeWindow `protobuf:"bytes,3,opt,name=target_time_window,json=targetTimeWindow,proto3" json:"target_time_window,omitempty"`
	// contains filtered or unexported fields
}

Additional information about the Task performed at this stop.

func (*VehicleStop_TaskInfo) Descriptor

func (*VehicleStop_TaskInfo) Descriptor() ([]byte, []int)

Deprecated: Use VehicleStop_TaskInfo.ProtoReflect.Descriptor instead.

func (*VehicleStop_TaskInfo) GetTargetTimeWindow

func (x *VehicleStop_TaskInfo) GetTargetTimeWindow() *TimeWindow

func (*VehicleStop_TaskInfo) GetTaskDuration

func (x *VehicleStop_TaskInfo) GetTaskDuration() *durationpb.Duration

func (*VehicleStop_TaskInfo) GetTaskId

func (x *VehicleStop_TaskInfo) GetTaskId() string

func (*VehicleStop_TaskInfo) ProtoMessage

func (*VehicleStop_TaskInfo) ProtoMessage()

func (*VehicleStop_TaskInfo) ProtoReflect

func (x *VehicleStop_TaskInfo) ProtoReflect() protoreflect.Message

func (*VehicleStop_TaskInfo) Reset

func (x *VehicleStop_TaskInfo) Reset()

func (*VehicleStop_TaskInfo) String

func (x *VehicleStop_TaskInfo) String() string