Skip to main content

locations

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

Overview

Namelocations
TypeResource
Idgoogle.bigquerydatatransfer.locations

Fields

NameDatatypeDescription
namestringResource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1"
displayNamestringThe friendly name for this location, typically a nearby city name. For example, "Tokyo".
labelsobjectCross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
locationIdstringThe canonical id for this location. For example: "us-east1".
metadataobjectService-specific metadata. For example the available capacity at the given location.

Methods

NameAccessible byRequired ParamsDescription
projects_locations_getSELECTlocationsId, projectsIdGets information about a location.
projects_locations_listSELECTprojectsIdLists information about the supported locations for this service.
projects_locations_enroll_data_sourcesEXEClocationsId, projectsIdEnroll 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_sourcesEXEClocationsId, projectsIdUnenroll 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.

SELECT examples

Lists information about the supported locations for this service.

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