locations

Creates, updates, deletes, gets or lists a locations resource.

Overview

Name	locations
Type	Resource
Id	google.apihub.locations

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1"
displayName	string	The friendly name for this location, typically a nearby city name. For example, "Tokyo".
labels	object	Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
locationId	string	The canonical id for this location. For example: "us-east1".
metadata	object	Service-specific metadata. For example the available capacity at the given location.

list

Successful response

Name	Datatype	Description
name	string	Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1"
displayName	string	The friendly name for this location, typically a nearby city name. For example, "Tokyo".
labels	object	Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
locationId	string	The canonical id for this location. For example: "us-east1".
metadata	object	Service-specific metadata. For example the available capacity at the given location.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId		Gets information about a location.
list	select	projectsId	filter, pageSize, pageToken, extraLocationTypes	Lists information about the supported locations for this service.
search_resources	exec	projectsId, locationsId		Search across API-Hub resources.
collect_api_data	exec	projectsId, locationsId		Collect API data from a source and push it to Hub's collect layer.
lookup_runtime_project_attachment	exec	projectsId, locationsId		Look up a runtime project attachment. This API can be called in the context of any project.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
projectsId	string
extraLocationTypes	string
filter	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Gets information about a location.

SELECT
name,
displayName,
labels,
locationId,
metadata
FROM google.apihub.locations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required;

list

Lists information about the supported locations for this service.

SELECT
name,
displayName,
labels,
locationId,
metadata
FROM google.apihub.locations
WHERE projectsId = '{{ projectsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND extraLocationTypes = '{{ extraLocationTypes }}';

Lifecycle Methods

search_resources

Search across API-Hub resources.

EXEC google.apihub.locations.search_resources 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required 
@@json=
'{
"query": "{{ query }}", 
"filter": "{{ filter }}", 
"pageSize": {{ pageSize }}, 
"pageToken": "{{ pageToken }}"
}';

collect_api_data

Collect API data from a source and push it to Hub's collect layer.

EXEC google.apihub.locations.collect_api_data 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required 
@@json=
'{
"collectionType": "{{ collectionType }}", 
"pluginInstance": "{{ pluginInstance }}", 
"actionId": "{{ actionId }}", 
"apiData": "{{ apiData }}"
}';

lookup_runtime_project_attachment

Look up a runtime project attachment. This API can be called in the context of any project.

EXEC google.apihub.locations.lookup_runtime_project_attachment 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required;