Method: networks.hubs.makeUnavailable

  • Makes a specified hub unavailable, impacting associated paths.

  • Requires a POST request to a specific URL with the hub's name.

  • Optionally, you can define the start time for unavailability; otherwise, it begins immediately.

  • Successful responses include the hub's name and a list of affected paths.

Makes a hub unavailable.

HTTP request

POST https://middlemileoptimization.googleapis.com/v1/{name=networks/*/hubs/*}:makeUnavailable

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the hub to make unavailable. Format: "networks/{network}/hubs/{hub}"

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 hubs.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 hub whose unavailability was updated. Format: "networks/{network}/hubs/{hub}"
path[]

object (Path)

The paths that were updated.