2025-06-27
▼ ▲ cloudlocationfinder.projects.locations.list
Path : v1alpha/{+name}/locations
Flat Path : v1alpha/projects/{projectsId}/locations
HTTP Method : GET
Parameters :
name
Description : The resource that owns the locations collection, if applicable.
Pattern : ^projects/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : 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](https://google.aip.dev/160).
Location : query
Type : string
pageSize
Description : The maximum number of results to return. If not set, the service selects a default.
Location : query
Type : integer
Format : int32
pageToken
Description : A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Location : query
Type : string
extraLocationTypes
Description : Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.
Location : query
Repeated : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists information about the supported locations for this service.
▼ ▲ cloudlocationfinder.projects.locations.get
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}
HTTP Method : GET
Parameters :
name
Description : Resource name for the location.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets information about a location.
▼ ▲ cloudlocationfinder.projects.locations.cloudLocations.list
Path : v1alpha/{+parent}/cloudLocations
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/cloudLocations
HTTP Method : GET
Parameters :
parent
Description : Required. The parent, which owns this collection of cloud locations. Format: projects/{project}/locations/{location}
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of cloud locations to return per page. The service might return fewer cloud locations than this value. If unspecified, server will pick an appropriate default.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A token identifying a page of results the server should return. Provide page token returned by a previous 'ListCloudLocations' call to retrieve the next page of results. When paginating, all other parameters provided to 'ListCloudLocations' must match the call that provided the page token.
Location : query
Type : string
filter
Description : Optional. A filter expression that filters resources listed in the response. The expression is in the form of field=value. For example, 'cloud_location_type=CLOUD_LOCATION_TYPE_REGION'. Multiple filter queries are space-separated. For example, 'cloud_location_type=CLOUD_LOCATION_TYPE_REGION territory_code="US"' By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists cloud locations under a given project and location.
▼ ▲ cloudlocationfinder.projects.locations.cloudLocations.get
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/cloudLocations/{cloudLocationsId}
HTTP Method : GET
Parameters :
name
Description : Required. Name of the resource.
Pattern : ^projects/[^/]+/locations/[^/]+/cloudLocations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Retrieves a resource containing information about a cloud location.
▼ ▲ cloudlocationfinder.projects.locations.cloudLocations.search
Path : v1alpha/{+parent}/cloudLocations:search
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/cloudLocations:search
HTTP Method : GET
Parameters :
parent
Description : Required. The parent, which owns this collection of cloud locations. Format: projects/{project}/locations/{location}
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
sourceCloudLocation
Description : Required. The source cloud location to search from. Example search can be searching nearby cloud locations from the source cloud location by latency.
Location : query
Type : string
pageSize
Description : 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.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A token identifying a page of results the server should return. Provide Page token returned by a previous 'ListCloudLocations' call to retrieve the next page of results. When paginating, all other parameters provided to 'ListCloudLocations' must match the call that provided the page token.
Location : query
Type : string
query
Description : 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.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Searches for cloud locations from a given source location.