Method: projects.locations.cloudLocations.search

Searches for cloud locations from a given source location.

HTTP request

GET https://cloudlocationfinder.googleapis.com/v1alpha/{parent=projects/*/locations/*}/cloudLocations:search

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of cloud locations. Format: projects/{project}/locations/{location}

Query parameters

Parameters
sourceCloudLocation

string

Required. The source cloud location to search from. Example search can be searching nearby cloud locations from the source cloud location by latency.
pageSize

integer

Optional. The maximum number of cloud locations to return. The service might return fewer cloud locations than this value. If unspecified, server will pick an appropriate default.
pageToken

string

Optional. A token identifying a page of results the server should return. Provide Page token returned by a previous 'cloudLocations.list' call to retrieve the next page of results. When paginating, all other parameters provided to 'cloudLocations.list' must match the call that provided the page token.
query

string

Optional. The query string in search query syntax. While filter is used to filter the search results by attributes, query is used to specify the search requirements.

Request body

The request body must be empty.

Response body

Message for response to searching cloud locations.

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

JSON representation 
{
  "cloudLocations": [
    {
      object (CloudLocation)
    }
  ],
  "nextPageToken": string
}
Fields
cloudLocations[]

object (CloudLocation)

Output only. List of cloud locations.
nextPageToken

string

Output only. The continuation token, used to page through large result sets. Provide this value in a subsequent request as pageToken in subsequent requests to retrieve the next page. If this field is not present, there are no subsequent results.

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 parent resource:

  • cloudlocationfinder.cloudLocations.search

For more information, see the IAM documentation.