Skip to content

Commit

Permalink
docs: [fleetengine-delivery] clarify behavior of UpdateDeliveryVehicle (
Browse files Browse the repository at this point in the history
googleapis#5543)

* docs: clarify behavior of UpdateDeliveryVehicle

PiperOrigin-RevId: 651102275

Source-Link: googleapis/googleapis@ecbfd84

Source-Link: https://github.com/googleapis/googleapis-gen/commit/6e1d81651d96a291256b8fa42fbf3d50ca1c8d94
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1hcHMtZmxlZXRlbmdpbmUtZGVsaXZlcnkvLk93bEJvdC55YW1sIiwiaCI6IjZlMWQ4MTY1MWQ5NmEyOTEyNTZiOGZhNDJmYmYzZDUwY2ExYzhkOTQifQ==

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
  • Loading branch information
gcf-owl-bot[bot] and gcf-owl-bot[bot] committed Jul 15, 2024
1 parent 13cfda1 commit 3fc430e
Show file tree
Hide file tree
Showing 16 changed files with 43 additions and 1,692 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2024 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2023 Google LLC
// Copyright 2024 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -27,6 +27,8 @@ option java_multiple_files = true;
option java_outer_classname = "Common";
option java_package = "google.maps.fleetengine.delivery.v1";
option objc_class_prefix = "CFED";
option php_namespace = "Google\\Maps\\FleetEngine\\Delivery\\V1";
option ruby_package = "Google::Maps::FleetEngine::Delivery::V1";

// Describes a vehicle attribute as a key-value pair. The "key:value" string
// length cannot exceed 256 characters.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2023 Google LLC
// Copyright 2024 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -34,6 +34,8 @@ option java_multiple_files = true;
option java_outer_classname = "DeliveryApi";
option java_package = "google.maps.fleetengine.delivery.v1";
option objc_class_prefix = "CFED";
option php_namespace = "Google\\Maps\\FleetEngine\\Delivery\\V1";
option ruby_package = "Google::Maps::FleetEngine::Delivery::V1";
option (google.api.resource_definition) = {
type: "fleetengine.googleapis.com/Provider"
pattern: "providers/{provider}"
Expand Down Expand Up @@ -78,9 +80,9 @@ service DeliveryService {

// 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`
// though, but it must contain all of the `VehicleJourneySegment`s currently
// on the `DeliveryVehicle`. The `task_id`s are retrieved from
// `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.
rpc UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest)
Expand Down Expand Up @@ -142,21 +144,6 @@ service DeliveryService {
option (google.api.method_signature) = "name";
}

// Deprecated: Use `GetTaskTrackingInfo` instead.
rpc SearchTasks(SearchTasksRequest) returns (SearchTasksResponse) {
option deprecated = true;
option (google.api.http) = {
get: "/v1/{parent=providers/*}/tasks:search"
};
option (google.api.routing) = {
routing_parameters {
field: "parent"
path_template: "{provider_id=providers/*}"
}
};
option (google.api.method_signature) = "parent";
}

// Updates `Task` data.
rpc UpdateTask(UpdateTaskRequest) returns (Task) {
option (google.api.http) = {
Expand Down Expand Up @@ -439,59 +426,6 @@ message GetTaskRequest {
];
}

// Deprecated: Issue `GetTaskTrackingInfoRequest`s to `GetTaskTrackingInfo`
// instead.
message SearchTasksRequest {
option deprecated = true;

// Optional. The standard Delivery API request header.
DeliveryRequestHeader header = 1 [(google.api.field_behavior) = OPTIONAL];

// Required. Must be in the format `providers/{provider}`.
// The provider must be the Google Cloud Project ID. For example,
// `sample-cloud-project`.
string parent = 3 [(google.api.field_behavior) = REQUIRED];

// Required. The identifier of the set of related Tasks being requested.
// Tracking 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 '#'.
string tracking_id = 4 [(google.api.field_behavior) = REQUIRED];

// 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.
int32 page_size = 5 [(google.api.field_behavior) = OPTIONAL];

// Optional. A page token, received from a previous `SearchTasks` call. You
// must provide this value to retrieve the subsequent page.
//
// When paginating, all other parameters provided to `SearchTasks` must match
// the call that provided the page token.
string page_token = 6 [(google.api.field_behavior) = OPTIONAL];
}

// The `SearchTasks` response. It contains the set of Tasks that meet the search
// criteria in the `SearchTasksRequest`.
message SearchTasksResponse {
option deprecated = true;

// The set of Tasks for the requested `tracking_id`. A successful response can
// also be empty. An empty response indicates that no Tasks are associated
// with the supplied `tracking_id`.
repeated Task tasks = 1;

// Pass this token in the `SearchTasksRequest` 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.
string next_page_token = 2;
}

// The `UpdateTask` request message.
message UpdateTaskRequest {
// Optional. The standard Delivery API request header.
Expand Down Expand Up @@ -554,8 +488,8 @@ message ListTasksRequest {
// 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 [Task
// list](/maps/documentation/transportation-logistics/last-mile-fleet-solution/fleet-performance/fleet-engine/deliveries_api#list_tasks).
// For information about the Task properties that you can filter on, see [List
// tasks](https://developers.google.com/maps/documentation/transportation-logistics/last-mile-fleet-solution/fleet-performance/fleet-engine/deliveries_api#list-tasks).
string filter = 6 [(google.api.field_behavior) = OPTIONAL];
}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2023 Google LLC
// Copyright 2024 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -29,6 +29,8 @@ option java_multiple_files = true;
option java_outer_classname = "DeliveryVehicles";
option java_package = "google.maps.fleetengine.delivery.v1";
option objc_class_prefix = "CFED";
option php_namespace = "Google\\Maps\\FleetEngine\\Delivery\\V1";
option ruby_package = "Google::Maps::FleetEngine::Delivery::V1";

// The `DeliveryVehicle` message. A delivery vehicle transports shipments from a
// depot to a delivery location, and from a pickup location to the depot. In
Expand Down Expand Up @@ -215,9 +217,8 @@ message VehicleJourneySegment {
message VehicleStop {
// Additional information about the Task performed at this stop.
message TaskInfo {
// The Task ID. This field won't be populated in the response of either a
// `GetTask`, or a `SearchTasks` call. Task IDs are subject to the following
// restrictions:
// 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.
Expand Down Expand Up @@ -255,15 +256,14 @@ message VehicleStop {

// 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 either a `GetTask`,
// or a `SearchTasks` call.
// of it. This field won't be populated in the response of a `GetTask` call.
LocationInfo planned_location = 1 [(google.api.field_behavior) = REQUIRED];

// The list of `Task`s to be performed at this stop. This field won't be
// populated in the response of either a `GetTask` or `SearchTasks` call.
// populated in the response of a `GetTask` call.
repeated TaskInfo tasks = 2;

// The state of the `VehicleStop`. This field won't be populated in the
// response of either a `GetTask`, or a `SearchTasks` call.
// response of a `GetTask` call.
State state = 3;
}
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2023 Google LLC
// Copyright 2024 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand All @@ -24,6 +24,8 @@ option java_multiple_files = true;
option java_outer_classname = "Headers";
option java_package = "google.maps.fleetengine.delivery.v1";
option objc_class_prefix = "CFED";
option php_namespace = "Google\\Maps\\FleetEngine\\Delivery\\V1";
option ruby_package = "Google::Maps::FleetEngine::Delivery::V1";

// A RequestHeader contains fields common to all Delivery RPC requests.
message DeliveryRequestHeader {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2023 Google LLC
// Copyright 2024 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -31,6 +31,8 @@ option java_multiple_files = true;
option java_outer_classname = "TaskTrackingInfoProto";
option java_package = "google.maps.fleetengine.delivery.v1";
option objc_class_prefix = "CFED";
option php_namespace = "Google\\Maps\\FleetEngine\\Delivery\\V1";
option ruby_package = "Google::Maps::FleetEngine::Delivery::V1";

// The `TaskTrackingInfo` message. The message contains task tracking
// information which will be used for display. If a tracking ID is associated
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2023 Google LLC
// Copyright 2024 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -29,6 +29,8 @@ option java_multiple_files = true;
option java_outer_classname = "Tasks";
option java_package = "google.maps.fleetengine.delivery.v1";
option objc_class_prefix = "CFED";
option php_namespace = "Google\\Maps\\FleetEngine\\Delivery\\V1";
option ruby_package = "Google::Maps::FleetEngine::Delivery::V1";

// 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
Expand Down
Loading

0 comments on commit 3fc430e

Please sign in to comment.