Method: networks.hubs.makeAvailable

  • Makes a hub available through an HTTP POST request to a specific endpoint.

  • Requires specifying the hub's name in the URL and optionally, future availability start periods in the request body.

  • If successful, the response includes the hub's name and the updated paths.

  • Utilizes gRPC Transcoding syntax for the URL structure.

  • The request body can define periods of availability in the future.

Makes a hub available.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

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

Request body

The request body contains data with the following structure:

JSON representation 
{
  "availabilityStarts": [
    {
      object (DateTime)
    }
  ]
}
Fields
availabilityStarts[]

object (DateTime)

Required. The periods where availability will start. They must be points in time in the future. If this field is absent, availability starts when the message is received.

Response body

The response message for hubs.makeAvailable 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.