locations

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

Overview

Name	locations
Type	Resource
Id	google.dataplex.locations

Fields

The following fields are returned by SELECT queries:

projects_locations_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.

projects_locations_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
projects_locations_get	select	projectsId, locationsId		Gets information about a location.
projects_locations_list	select	projectsId	filter, pageSize, pageToken, extraLocationTypes	Lists information about the supported locations for this service.
projects_locations_lookup_entry	exec	projectsId, locationsId	view, aspectTypes, paths, entry	Looks up an entry by name using the permission on the source system.
projects_locations_search_entries	exec	projectsId, locationsId	query, pageSize, pageToken, orderBy, scope, semanticSearch	Searches for Entries matching the given query and scope.

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
aspectTypes	string
entry	string
extraLocationTypes	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
paths	string
query	string
scope	string
semanticSearch	boolean
view	string

SELECT examples

projects_locations_get

Gets information about a location.

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

projects_locations_list

Lists information about the supported locations for this service.

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

Lifecycle Methods

projects_locations_lookup_entry

Looks up an entry by name using the permission on the source system.

EXEC google.dataplex.locations.projects_locations_lookup_entry 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@view='{{ view }}', 
@aspectTypes='{{ aspectTypes }}', 
@paths='{{ paths }}', 
@entry='{{ entry }}';

projects_locations_search_entries

Searches for Entries matching the given query and scope.

EXEC google.dataplex.locations.projects_locations_search_entries 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@query='{{ query }}', 
@pageSize='{{ pageSize }}', 
@pageToken='{{ pageToken }}', 
@orderBy='{{ orderBy }}', 
@scope='{{ scope }}', 
@semanticSearch={{ semanticSearch }};