Method: networks.lines.makeUnavailable

  • 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.

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.