Skip to main content

locations

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

Overview

Namelocations
TypeResource
Idgoogle.bigtableadmin.locations

Fields

The following fields are returned by SELECT queries:

Successful response

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

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectprojectsIdfilter, pageSize, pageToken, extraLocationTypesLists information about the supported locations for this service.

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.

NameDatatypeDescription
projectsIdstring
extraLocationTypesstring
filterstring
pageSizeinteger (int32)
pageTokenstring

SELECT examples

Lists information about the supported locations for this service.

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