Gcp/cloudlocationfinder
@swamp/gcp/cloudlocationfinderv2026.09.15.1
01README
Google Cloud cloudlocationfinder infrastructure models
02Release Notes
- Updated: cloudlocations
03Models
@swamp/gcp/cloudlocationfinder/cloudlocationsv2026.09.15.1cloudlocations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a cloudLocations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the cloudLocations |
fn sync(identifier?: string)
Sync cloudLocations state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific cloudLocations by name (e.g. one discovered by list) |
fn list(filter?: string, pageSize?: number, maxPages?: number)
List cloudLocations resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. A filter expression that filters resources listed in the response. The expression is in the form of field=value. For example, 'cloud_location_type=CLOUD_LOCATION_TYPE_REGION'. Multiple filter queries are space-separated. For example, 'cloud_location_type=CLOUD_LOCATION_TYPE_REGION territory_code=\ |
| pageSize? | number | Optional. The maximum number of cloud locations to return per page. The service might return fewer cloud locations than this value. If unspecified, server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn search(pageSize?: any, pageToken?: any, query?: any, sourceCloudLocation?: any)
search
| Argument | Type | Description |
|---|---|---|
| pageSize? | any | |
| pageToken? | any | |
| query? | any | |
| sourceCloudLocation? | any |
Resources
state(infinite)— Represents resource cloud locations.
@swamp/gcp/cloudlocationfinder/locationsv2026.08.12.2locations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| name | string | The resource that owns the locations collection, if applicable. |
fn get(identifier: string)
Get a locations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the locations |
fn sync(identifier?: string)
Sync locations state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific locations by name (e.g. one discovered by list) |
fn list(extraLocationTypes?: string, filter?: string, pageSize?: number, maxPages?: number)
List locations resources
| Argument | Type | Description |
|---|---|---|
| extraLocationTypes? | string | Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. |
| filter? | string | A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). |
| pageSize? | number | The maximum number of results to return. If not set, the service selects a default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A resource that represents a Google Cloud location.
04Previous Versions
2026.09.07.1
- Updated: cloudlocations
2026.08.12.2
- Updated: locations, cloudlocations
2026.07.29.1
- Updated: locations, cloudlocations
2026.07.21.3
- Updated: locations
2026.07.20.2
- Updated: locations
2026.07.20.1
- Updated: locations, cloudlocations
2026.07.19.2
- Updated: locations
2026.07.19.1
- Updated: locations, cloudlocations
2026.07.18.2
- Updated: locations, cloudlocations
2026.07.17.1
- Updated: cloudlocations
2026.06.08.2
- Updated: locations, cloudlocations
2026.06.07.1
- Updated: locations, cloudlocations
2026.05.26.1
- Updated: locations
2026.05.25.1
- Updated: locations, cloudlocations
Modified 2 models
2026.05.24.1
- Updated: locations, cloudlocations
2026.05.21.2
- Updated: locations, cloudlocations
2026.05.21.1
2026.05.19.2
2026.05.19.1
05Stats
A
100 / 100
Downloads
0
Archive size
27.9 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels