ListLocationsRequest

The request message for Locations.ListLocations.

JSON representation
{
  "name": string,
  "filter": string,
  "pageSize": integer,
  "pageToken": string,
  "extraLocationTypes": [
    string
  ]
}
Fields
name

string

The resource that owns the locations collection, if applicable.

filter

string

A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160.

pageSize

integer

The maximum number of results to return. If not set, the service selects a default.

pageToken

string

A page token received from the nextPageToken field in the response. Send that page token to receive the subsequent page.

extraLocationTypes[]

string

Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.

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-11-11 UTC.