available_locations
Creates, updates, deletes, gets or lists an available_locations resource.
Overview
| Name | available_locations |
| Type | Resource |
| Id | firebase.firebase.available_locations |
Fields
The following fields are returned by SELECT queries:
- list
Successful response
| Name | Datatype | Description |
|---|---|---|
features | array | Products and services that are available in the location for default Google Cloud resources. |
locationId | string | The ID of the Project's location for default Google Cloud resources. It will be one of the available Google App Engine locations. |
type | string | Indicates whether the location for default Google Cloud resources is a regional or multi-regional location for data replication. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | projectsId | pageToken, pageSize | DECOMMISSIONED. If called, this endpoint will return a 404 error. Instead, use the applicable resource-specific REST API (or associated documentation, as needed) to determine valid locations for each resource used in your Project. Lists the valid "locations for default Google Cloud resources" for the specified Project (including a FirebaseProject). One of these locations can be selected as the Project's location for default Google Cloud resources, which is the geographical location where the Project's resources associated with Google App Engine (such as the default Cloud Firestore instance) will be provisioned by default. However, if the location for default Google Cloud resources has already been set for the Project, then this setting cannot be changed. This call checks for any possible location restrictions for the specified Project and, thus, might return a subset of all possible locations. To list all locations (regardless of any restrictions), call the endpoint without specifying a unique project identifier (that is, /v1beta1/{parent=projects/-}/listAvailableLocations). To call ListAvailableLocations with a specified project, a member must be at minimum a Viewer of the Project. Calls without a specified project do not require any specific project permissions. |
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 |
|---|---|---|
projectsId | string | |
pageSize | integer (int32) | |
pageToken | string |
SELECT examples
- list
DECOMMISSIONED. If called, this endpoint will return a 404 error. Instead, use the applicable resource-specific REST API (or associated documentation, as needed) to determine valid locations for each resource used in your Project. Lists the valid "locations for default Google Cloud resources" for the specified Project (including a FirebaseProject). One of these locations can be selected as the Project's location for default Google Cloud resources, which is the geographical location where the Project's resources associated with Google App Engine (such as the default Cloud Firestore instance) will be provisioned by default. However, if the location for default Google Cloud resources has already been set for the Project, then this setting cannot be changed. This call checks for any possible location restrictions for the specified Project and, thus, might return a subset of all possible locations. To list all locations (regardless of any restrictions), call the endpoint without specifying a unique project identifier (that is, /v1beta1/{parent=projects/-}/listAvailableLocations). To call ListAvailableLocations with a specified project, a member must be at minimum a Viewer of the Project. Calls without a specified project do not require any specific project permissions.
SELECT
features,
locationId,
type
FROM firebase.firebase.available_locations
WHERE projectsId = '{{ projectsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}';