Namespace Google.Maps.FleetEngine.Delivery.V1
Classes
BatchCreateTasksRequest
The BatchCreateTask
request message.
BatchCreateTasksResponse
The BatchCreateTask
response message.
CreateDeliveryVehicleRequest
The CreateDeliveryVehicle
request message.
CreateTaskRequest
The CreateTask
request message.
DeliveryRequestHeader
A RequestHeader contains fields common to all Delivery RPC requests.
DeliveryRequestHeader.Types
Container for nested types declared in the DeliveryRequestHeader message type.
DeliveryService
The Last Mile Delivery service.
DeliveryService.DeliveryServiceBase
Base class for server-side implementations of DeliveryService
DeliveryService.DeliveryServiceClient
Client for DeliveryService
DeliveryServiceClient
DeliveryService client wrapper, for convenient use.
DeliveryServiceClientBuilder
Builder class for DeliveryServiceClient to provide simple configuration of credentials, endpoint etc.
DeliveryServiceClientImpl
DeliveryService client wrapper implementation, for convenient use.
DeliveryServiceSettings
Settings for DeliveryServiceClient instances.
DeliveryVehicle
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.
DeliveryVehicle.Types
Container for nested types declared in the DeliveryVehicle message type.
DeliveryVehicleAttribute
Describes a vehicle attribute as a key-value pair. The "key:value" string length cannot exceed 256 characters.
DeliveryVehicleLocation
The location, speed, and heading of a vehicle at a point in time.
DeliveryVehicleName
Resource name for the DeliveryVehicle
resource.
GetDeliveryVehicleRequest
The GetDeliveryVehicle
request message.
GetTaskRequest
The GetTask
request message.
GetTaskTrackingInfoRequest
The GetTaskTrackingInfoRequest
request message.
ListDeliveryVehiclesRequest
The ListDeliveryVehicles
request message.
ListDeliveryVehiclesResponse
The ListDeliveryVehicles
response message.
ListTasksRequest
The ListTasks
request message.
ListTasksResponse
The ListTasks
response that contains the set of Tasks that meet the filter
criteria in the ListTasksRequest
.
LocationInfo
A location with any additional identifiers.
ProviderName
Resource name for the Provider
resource.
Task
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.
Task.Types
Container for nested types declared in the Task message type.
Task.Types.JourneySharingInfo
Journey sharing specific fields.
TaskAttribute
Describes a task attribute as a key-value pair. The "key:value" string length cannot exceed 256 characters.
TaskName
Resource name for the Task
resource.
TaskTrackingInfo
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.
TaskTrackingInfoName
Resource name for the TaskTrackingInfo
resource.
TaskTrackingViewConfig
The configuration message that defines when a data element of a Task should be visible to the end users.
TaskTrackingViewConfig.Types
Container for nested types declared in the TaskTrackingViewConfig message type.
TaskTrackingViewConfig.Types.VisibilityOption
The option message that defines when a data element should be visible to the end users.
TimeWindow
A time range.
UpdateDeliveryVehicleRequest
The UpdateDeliveryVehicle
request message.
UpdateTaskRequest
The UpdateTask
request message.
VehicleJourneySegment
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.
VehicleStop
Describes a point where a Vehicle stops to perform one or more Task
s.
VehicleStop.Types
Container for nested types declared in the VehicleStop message type.
VehicleStop.Types.TaskInfo
Additional information about the Task performed at this stop.
Enums
DeliveryRequestHeader.Types.Platform
The platform of the calling SDK.
DeliveryRequestHeader.Types.SdkType
Possible types of SDK.
DeliveryVehicle.Types.DeliveryVehicleType
The type of delivery vehicle.
DeliveryVehicleAttribute.DeliveryVehicleAttributeValueOneofCase
Enum of possible cases for the "delivery_vehicle_attribute_value" oneof.
DeliveryVehicleLocationSensor
The sensor or methodology used to determine the location.
DeliveryVehicleName.ResourceNameType
The possible contents of DeliveryVehicleName.
DeliveryVehicleNavigationStatus
The vehicle's navigation status.
ProviderName.ResourceNameType
The possible contents of ProviderName.
Task.Types.State
The state of a Task. This indicates the Tasks's progress.
Task.Types.TaskOutcome
The outcome of attempting to execute a Task. When TaskState
is closed,
TaskOutcome
indicates whether it was completed successfully.
Task.Types.TaskOutcomeLocationSource
The identity of the source that populated the task_outcome_location
.
Task.Types.Type
The type of Task.
TaskAttribute.TaskAttributeValueOneofCase
Enum of possible cases for the "task_attribute_value" oneof.
TaskName.ResourceNameType
The possible contents of TaskName.
TaskTrackingInfoName.ResourceNameType
The possible contents of TaskTrackingInfoName.
TaskTrackingViewConfig.Types.VisibilityOption.VisibilityOptionOneofCase
Enum of possible cases for the "visibility_option" oneof.
VehicleStop.Types.State
The current state of a VehicleStop
.