Method: networks.lines.list

  • This page details the process for listing the lines within a specific network using the lines.list method.

  • The request requires specifying the parent network and allows for optional pagination using pageSize and pageToken parameters.

  • The response includes an array of Line objects representing the lines within the network and a token for retrieving subsequent pages if available.

Lists the Lines.

HTTP request

GET https://middlemileoptimization.googleapis.com/v1/{parent=networks/*}/lines

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of lines. Format: "networks/{network}"

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of lines to return. The service may return fewer than this value. If unspecified, at most 50 lines will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

Optional. A page token, received from a previous lines.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to lines.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

The response message for lines.list method.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "lines": [
    {
      object (Line)
    }
  ],
  "nextPageToken": string
}
Fields
lines[]

object (Line)

The lines from the specified network.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.