Method: locations.list

Full name: projects.locations.list

Lists information about the supported locations for this service.

HTTP request

GET https://{endpoint}/v1beta3/{name}/locations

Where {endpoint} is one of the supported service endpoints.

Path parameters

Parameters

Parameters
`name`	`string` The resource that owns the locations collection, if applicable. It takes the form `projects/{project}`.

name

string

The resource that owns the locations collection, if applicable. It takes the form projects/{project}.

Query parameters

Parameters

Parameters
`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.

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.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ListLocationsResponse.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

documentai.locations.list

For more information, see the IAM documentation.