locations

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

Overview

Name	locations
Type	Resource
Id	google.bigquerydatatransfer.locations

Fields

The following fields are returned by SELECT queries:

projects_locations_get

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

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	extraLocationTypes, pageSize, pageToken, filter	Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * Global locations: If name is empty, the method lists the public locations available to all projects. * Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
projects_locations_enroll_data_sources	exec	projectsId, locationsId		Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the BigQuery UI, and the documents can be found in the public guide for BigQuery Web UI and Data Transfer Service.
projects_locations_unenroll_data_sources	exec	projectsId, locationsId		Unenroll data sources in a user project. This allows users to remove transfer configurations for these data sources. They will no longer appear in the ListDataSources RPC and will also no longer appear in the BigQuery UI. Data transfers configurations of unenrolled data sources will not be scheduled.

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

projects_locations_get

Gets information about a location.

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

projects_locations_list

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * Global locations: If name is empty, the method lists the public locations available to all projects. * Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

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

Lifecycle Methods

projects_locations_enroll_data_sources

Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the BigQuery UI, and the documents can be found in the public guide for BigQuery Web UI and Data Transfer Service.

EXEC google.bigquerydatatransfer.locations.projects_locations_enroll_data_sources 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required 
@@json=
'{
"dataSourceIds": "{{ dataSourceIds }}"
}'
;

projects_locations_unenroll_data_sources

Unenroll data sources in a user project. This allows users to remove transfer configurations for these data sources. They will no longer appear in the ListDataSources RPC and will also no longer appear in the BigQuery UI. Data transfers configurations of unenrolled data sources will not be scheduled.

EXEC google.bigquerydatatransfer.locations.projects_locations_unenroll_data_sources 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required 
@@json=
'{
"dataSourceIds": "{{ dataSourceIds }}"
}'
;