Method: networks.listPaths
Stay organized with collections
Save and categorize content based on your preferences.
Returns all the paths that are currently available. This method is idempotent and has no side effect.
HTTP request
GET https://middlemileoptimization.googleapis.com/v1/{parent=networks/*}:listPaths
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
parent |
string
Required. The name of the network for which paths must be sent. Format: "networks/{network}"
|
Query parameters
Parameters |
pageSize |
integer
Optional. The maximum number of networks to return. The service may return fewer than this value. If unspecified, at most 50 networks 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 networks.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to networks.list must match the call that provided the page token.
|
Request body
The request body must be empty.
Response body
The response message for networks.listPaths
method.
If successful, the response body contains data with the following structure:
JSON representation |
{
"paths": [
{
object (Path )
}
],
"nextPageToken": string
} |
Fields |
paths[] |
object (Path )
The list of paths.
|
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.
|
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."],[[["Lists all available paths within a specified network."],["Request parameters allow for filtering by network name and pagination."],["Response includes a list of paths and a token for retrieving subsequent pages."],["The method is idempotent and doesn't change any existing data."]]],["This `GET` request, `listPaths`, retrieves all available paths for a specified network (`parent`). It's idempotent with no side effects. The request requires the network name in the URL. Optional query parameters include `pageSize` (max 1000, default 50) and `pageToken` for pagination. The request body is empty. The response contains a list of `paths` and a `nextPageToken` for further results if present.\n"]]