Method: networks.vehicles.makeUnavailable
Stay organized with collections
Save and categorize content based on your preferences.
Makes a vehicle unavailable.
HTTP request
POST https://middlemileoptimization.googleapis.com/v1/{name=networks/*/vehicles/*}:makeUnavailable
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. The name of the vehicle to make unavailable. Format: "networks/{network}/vehicles/{vehicle}"
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"unavailabilityStarts": [
{
object (DateTime)
}
]
} |
| Fields |
unavailabilityStarts[] |
object (DateTime)
Required. The periods where unavailability will start. They must be points in time in the future. If this field is absent, unavailability starts when the message is received.
|
Response body
The response message for vehicles.makeUnavailable method.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"name": string,
"path": [
{
object (Path)
}
]
} |
| Fields |
name |
string
The name of the vehicle whose unavailability was updated. Format: "networks/{network}/vehicles/{vehicle}"
|
path[] |
object (Path)
The paths that were updated.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-14 UTC."],[[["This endpoint, `vehicles.makeUnavailable`, is used to make a vehicle unavailable for scheduling, effectively removing it from the pool of available resources."],["To utilize this endpoint, a POST request must be sent to the specified URL, including the vehicle's name in the path parameters."],["The request body can optionally include `unavailabilityStarts`, specifying the periods when the vehicle becomes unavailable, with future timestamps; if omitted, unavailability starts immediately."],["Upon success, the response provides the vehicle's name and a list of updated paths (`path[]`) impacted by the vehicle's unavailability."]]],["This outlines the process to mark a vehicle as unavailable via an HTTP POST request to a specific URL endpoint. The request requires the vehicle's name in the URL path and includes a body specifying when the unavailability starts, as a DateTime object array. If successful, the response includes the updated vehicle's name and the updated paths. If the unavailability start is not specified in the request, it begins at the message reception.\n"]]