locations
Creates, updates, deletes, gets or lists a locations resource.
Overview
| Name | locations |
| Type | Resource |
| Id | google.securityposture.locations |
Fields
The following fields are returned by SELECT queries:
- get
- 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. |
| 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 |
|---|---|---|---|---|
get | select | projectsId, locationsId | Gets information about a location. | |
list | select | projectsId | pageToken, extraLocationTypes, filter, pageSize | 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. |
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
- get
- list
Gets information about a location.
SELECT
name,
displayName,
labels,
locationId,
metadata
FROM google.securityposture.locations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
;
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.securityposture.locations
WHERE projectsId = '{{ projectsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND extraLocationTypes = '{{ extraLocationTypes }}'
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
;