Skip to content

Commit

Permalink
docs: [fleetengine] clarify behavior of UpdateDeliveryVehicle (google…
Browse files Browse the repository at this point in the history
…apis#5542)

* 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: eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1hcHMtZmxlZXRlbmdpbmUvLk93bEJvdC55YW1sIiwiaCI6IjZlMWQ4MTY1MWQ5NmEyOTEyNTZiOGZhNDJmYmYzZDUwY2ExYzhkOTQifQ==

* 🦉 Updates from OwlBot post-processor

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

* 🦉 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 685a710 commit 13cfda1
Show file tree
Hide file tree
Showing 35 changed files with 183 additions and 3,047 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 @@ -29,9 +29,14 @@ option java_multiple_files = true;
option java_outer_classname = "FleetEngine";
option java_package = "google.maps.fleetengine.v1";
option objc_class_prefix = "CFE";
option php_namespace = "Google\\Maps\\FleetEngine\\V1";
option ruby_package = "Google::Maps::FleetEngine::V1";

// Identifies a terminal point.
// Deprecated: TerminalPoints are no longer supported in Fleet Engine. Use
// `TerminalLocation.point` instead.
message TerminalPointId {
option deprecated = true;

// Deprecated.
oneof Id {
// Deprecated.
Expand All @@ -41,19 +46,19 @@ message TerminalPointId {
string generated_id = 3 [deprecated = true];
}

// Unique ID of the terminal point.
string value = 4;
// Deprecated.
string value = 4 [deprecated = true];
}

// Describes the location of a waypoint.
message TerminalLocation {
// Required. Denotes the location of a trip waypoint.
google.type.LatLng point = 1 [(google.api.field_behavior) = REQUIRED];

// ID of the terminal point.
TerminalPointId terminal_point_id = 2;
// Deprecated: Specify the `point` field instead.
TerminalPointId terminal_point_id = 2 [deprecated = true];

// Deprecated.
// Deprecated: Specify the `point` field instead.
string access_point_id = 3 [deprecated = true];

// Deprecated.
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 All @@ -24,6 +24,8 @@ option java_multiple_files = true;
option java_outer_classname = "Headers";
option java_package = "google.maps.fleetengine.v1";
option objc_class_prefix = "CFE";
option php_namespace = "Google\\Maps\\FleetEngine\\V1";
option ruby_package = "Google::Maps::FleetEngine::V1";

// A RequestHeader contains fields common to all Fleet Engine RPC requests.
message RequestHeader {
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 All @@ -22,6 +22,8 @@ option java_multiple_files = true;
option java_outer_classname = "TrafficProto";
option java_package = "google.maps.fleetengine.v1";
option objc_class_prefix = "CFE";
option php_namespace = "Google\\Maps\\FleetEngine\\V1";
option ruby_package = "Google::Maps::FleetEngine::V1";

// Traffic density indicator on a contiguous segment of a path. Given a path
// with points P_0, P_1, ... , P_N (zero-based index), the SpeedReadingInterval
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 @@ -35,6 +35,8 @@ option java_multiple_files = true;
option java_outer_classname = "TripApi";
option java_package = "google.maps.fleetengine.v1";
option objc_class_prefix = "CFE";
option php_namespace = "Google\\Maps\\FleetEngine\\V1";
option ruby_package = "Google::Maps::FleetEngine::V1";

// Trip management service.
service TripService {
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 = "Trips";
option java_package = "google.maps.fleetengine.v1";
option objc_class_prefix = "CFE";
option php_namespace = "Google\\Maps\\FleetEngine\\V1";
option ruby_package = "Google::Maps::FleetEngine::V1";

// Trip metadata.
message Trip {
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 @@ -37,6 +37,8 @@ option java_multiple_files = true;
option java_outer_classname = "VehicleApi";
option java_package = "google.maps.fleetengine.v1";
option objc_class_prefix = "CFE";
option php_namespace = "Google\\Maps\\FleetEngine\\V1";
option ruby_package = "Google::Maps::FleetEngine::V1";

// Vehicle management service.
service VehicleService {
Expand Down Expand Up @@ -128,23 +130,6 @@ service VehicleService {
};
}

// Deprecated: Use the `UpdateVehicle` method instead.
// UpdateVehicleLocation updates the location of the vehicle.
rpc UpdateVehicleLocation(UpdateVehicleLocationRequest)
returns (VehicleLocation) {
option deprecated = true;
option (google.api.http) = {
put: "/v1/{name=providers/*/vehicles/*}:updateLocation"
body: "*"
};
option (google.api.routing) = {
routing_parameters {
field: "name"
path_template: "{provider_id=providers/*}"
}
};
}

// Partially updates a vehicle's attributes.
// Only the attributes mentioned in the request will be updated, other
// attributes will NOT be altered. Note: this is different in `UpdateVehicle`,
Expand Down Expand Up @@ -191,22 +176,6 @@ service VehicleService {
}
};
}

// Deprecated: Use `SearchVehicles` instead.
rpc SearchFuzzedVehicles(SearchVehiclesRequest)
returns (SearchVehiclesResponse) {
option deprecated = true;
option (google.api.http) = {
post: "/v1/{parent=providers/*}/vehicles:searchFuzzed"
body: "*"
};
option (google.api.routing) = {
routing_parameters {
field: "parent"
path_template: "{provider_id=providers/*}"
}
};
}
}

// `CreateVehicle` request message.
Expand Down Expand Up @@ -327,29 +296,6 @@ message UpdateVehicleRequest {
[(google.api.field_behavior) = REQUIRED];
}

// `UpdateVehicleLocation` request message.
message UpdateVehicleLocationRequest {
option deprecated = true;

// The standard Fleet Engine request header.
RequestHeader header = 1;

// Required. Must be in the format
// `providers/{provider}/vehicles/{vehicle}`.
// The {provider} must be the Project ID (for example, `sample-cloud-project`)
// of the Google Cloud Project of which the service account making
// this call is a member.
string name = 3 [(google.api.field_behavior) = REQUIRED];

// Required. The vehicle's most recent location. The `location` and
// `update_time` subfields are required.
VehicleLocation current_location = 4 [(google.api.field_behavior) = REQUIRED];

// Set the vehicle's state to either `ONLINE` or `OFFLINE`.
// If set to `UNKNOWN_VEHICLE_STATE`, the vehicle's state will not be altered.
VehicleState current_state = 5;
}

// `UpdateVehicleAttributes` request message.
message UpdateVehicleAttributesRequest {
// The standard Fleet Engine request header.
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 @@ -28,6 +28,8 @@ option java_multiple_files = true;
option java_outer_classname = "Vehicles";
option java_package = "google.maps.fleetengine.v1";
option objc_class_prefix = "CFE";
option php_namespace = "Google\\Maps\\FleetEngine\\V1";
option ruby_package = "Google::Maps::FleetEngine::V1";

// Vehicle metadata.
message Vehicle {
Expand Down
Loading

0 comments on commit 13cfda1

Please sign in to comment.