Method: networks.lines.makeUnavailable
Stay organized with collections
Save and categorize content based on your preferences.
Makes a line unavailable.
HTTP request
POST https://middlemileoptimization.googleapis.com/v1/{name=networks/*/lines/*}:makeUnavailable
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
name |
string
Required. The name of the line to make unavailable. Format: "networks/{network}/lines/{line}"
|
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 lines.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 line whose unavailability was updated. Format: "networks/{network}/lines/{line}"
|
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."],[[["Makes a line in a network unavailable for use, potentially impacting paths utilizing it."],["Requires specifying the network and line using a specific format within the request."],["Optionally allows defining unavailability start times, otherwise defaulting to immediate unavailability upon request receipt."],["A successful operation returns the updated line name and any affected paths within the network."],["Utilizes gRPC Transcoding syntax for the HTTP request and provides structured request/response bodies in JSON format."]]],["A `POST` request to `https://middlemileoptimization.googleapis.com/v1/{name=networks/*/lines/*}:makeUnavailable` makes a specified line unavailable. The `name` parameter, formatted as \"networks/{network}/lines/{line}\", identifies the line. The request body requires `unavailabilityStarts`, an array of future DateTime objects, defining when unavailability begins. If absent, it starts immediately. The successful response includes the updated line's `name` and an array of updated `path` objects.\n"]]