Skip to main content
← back to extensions

Gcp/observability

@swamp/gcp/observabilityv2026.07.29.1· 2d agoMODELS
01README

Google Cloud observability infrastructure models

02Release Notes
  • Updated: locations, buckets, buckets_datasets, buckets_datasets_links, buckets_datasets_views, scopes, tracescopes
03Models7
@swamp/gcp/observability/bucketsv2026.07.29.1buckets.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP 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.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn get(identifier: string)
Get a buckets
ArgumentTypeDescription
identifierstringThe name of the buckets
fn sync(identifier?: string)
Sync buckets state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific buckets by name (e.g. one discovered by list)
fn list(pageSize?: number, showDeleted?: boolean, maxPages?: number)
List buckets resources
ArgumentTypeDescription
pageSize?numberOptional. The maximum number of buckets to return. If unspecified, then at most 100 buckets are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
showDeleted?booleanOptional. If true, then the response will include deleted buckets.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— Bucket configuration for storing observability data.
@swamp/gcp/observability/buckets-datasetsv2026.07.29.1buckets_datasets.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP 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.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn get(identifier: string)
Get a datasets
ArgumentTypeDescription
identifierstringThe name of the datasets
fn sync(identifier?: string)
Sync datasets state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific datasets by name (e.g. one discovered by list)
fn list(pageSize?: number, showDeleted?: boolean, maxPages?: number)
List datasets resources
ArgumentTypeDescription
pageSize?numberOptional. The maximum number of datasets to return. If unspecified, then at most 100 datasets are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
showDeleted?booleanOptional. If true, then the response will include deleted datasets.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— A dataset is a collection of data that has a specific configuration. A datase...
@swamp/gcp/observability/buckets-datasets-linksv2026.07.29.1buckets_datasets_links.ts

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP 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.
description?stringOptional. Description of the link.
displayName?stringOptional. A user friendly display name.
name?stringIdentifier. Name of the link. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]
linkId?stringRequired. Id of the link to create.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a links
fn get(identifier: string)
Get a links
ArgumentTypeDescription
identifierstringThe name of the links
fn update(identifier?: string)
Update links attributes
ArgumentTypeDescription
identifier?stringTarget a specific links by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the links
ArgumentTypeDescription
identifierstringThe name of the links
fn sync(identifier?: string)
Sync links state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific links by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List links resources
ArgumentTypeDescription
pageSize?numberOptional. The maximum number of links to return. If unspecified, then at most 100 links are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— A link lets a dataset be accessible to BigQuery via usage of linked datasets.
@swamp/gcp/observability/buckets-datasets-viewsv2026.07.29.1buckets_datasets_views.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP 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.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn get(identifier: string)
Get a views
ArgumentTypeDescription
identifierstringThe name of the views
fn sync(identifier?: string)
Sync views state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific views by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List views resources
ArgumentTypeDescription
pageSize?numberOptional. The maximum number of views to return. If unspecified, then at most 100 views are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— A view corresponds to a read-only representation of a subset of the data in a...
@swamp/gcp/observability/locationsv2026.07.29.1locations.ts

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP 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.
namestringThe resource that owns the locations collection, if applicable.
fn get(identifier: string)
Get a locations
ArgumentTypeDescription
identifierstringThe name of the locations
fn sync(identifier?: string)
Sync locations state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific locations by name (e.g. one discovered by list)
fn list(extraLocationTypes?: string, filter?: string, pageSize?: number, maxPages?: number)
List locations resources
ArgumentTypeDescription
extraLocationTypes?stringOptional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
filter?stringA 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?numberThe maximum number of results to return. If not set, the service selects a default.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_settings()
get settings
fn update_settings(defaultStorageLocation?: any, kmsKeyName?: any, name?: any, serviceAccountId?: any)
update settings
ArgumentTypeDescription
defaultStorageLocation?any
kmsKeyName?any
name?any
serviceAccountId?any

Resources

state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/observability/scopesv2026.07.29.1scopes.ts

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP 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.
logScope?stringRequired. The full resource name of the `LogScope`. For example: //logging.googleapis.com/projects/myproject/locations/global/logScopes/my-log-scope
name?stringIdentifier. Name of the resource. The format is: projects/{project}/locations/{location}/scopes/{scope} The `{location}` field must be set to `global`. The `{scope}` field must be set to `_Default`.
traceScope?stringRequired. The resource name of the `TraceScope`. For example: projects/myproject/locations/global/traceScopes/my-trace-scope
updateTime?stringOutput only. Update timestamp. Note: The Update timestamp for the default scope is initially unset.
fn get(identifier: string)
Get a scopes
ArgumentTypeDescription
identifierstringThe name of the scopes
fn update(identifier?: string)
Update scopes attributes
ArgumentTypeDescription
identifier?stringTarget a specific scopes by name (e.g. one discovered by list)
fn sync(identifier?: string)
Sync scopes state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific scopes by name (e.g. one discovered by list)

Resources

state(infinite)— Message describing Scope object
@swamp/gcp/observability/tracescopesv2026.07.29.1tracescopes.ts

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP 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.
description?stringOptional. Describes this trace scope. The maximum length of the description is 8000 characters.
name?stringIdentifier. The resource name of the trace scope. For example: projects/my-project/locations/global/traceScopes/my-trace-scope
resourceNames?arrayRequired. Names of the projects that are included in this trace scope. * `projects/[PROJECT_ID]` A trace scope can include a maximum of 20 projects.
traceScopeId?stringRequired. A client-assigned identifier for the trace scope.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a traceScopes
fn get(identifier: string)
Get a traceScopes
ArgumentTypeDescription
identifierstringThe name of the traceScopes
fn update(identifier?: string)
Update traceScopes attributes
ArgumentTypeDescription
identifier?stringTarget a specific traceScopes by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the traceScopes
ArgumentTypeDescription
identifierstringThe name of the traceScopes
fn sync(identifier?: string)
Sync traceScopes state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific traceScopes by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List traceScopes resources
ArgumentTypeDescription
pageSize?numberOptional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— A trace scope is a collection of resources whose traces are queried together.
04Previous Versions19
2026.07.21.3
  • Updated: locations
2026.07.20.2
  • Updated: locations
2026.07.20.1
  • Updated: locations, buckets, buckets_datasets, buckets_datasets_links, buckets_datasets_views, scopes, tracescopes
2026.07.19.2
  • Updated: locations
2026.07.19.1
  • Updated: locations, buckets, buckets_datasets, buckets_datasets_links, buckets_datasets_views, scopes, tracescopes
2026.07.18.2
  • Updated: locations, buckets, buckets_datasets, buckets_datasets_links, buckets_datasets_views, scopes, tracescopes
2026.07.17.2
  • Updated: buckets_datasets_links, scopes, tracescopes
2026.07.17.1
  • Updated: buckets, buckets_datasets, buckets_datasets_links, buckets_datasets_views, tracescopes

Added 7, removed 1 models

2026.06.08.2
  • Updated: locations, buckets, buckets_datasets, buckets_datasets_links, buckets_datasets_views, scopes, tracescopes
2026.06.07.1
  • Updated: locations, buckets, buckets_datasets, buckets_datasets_links, buckets_datasets_views, scopes, tracescopes
2026.05.26.1
  • Updated: locations
2026.05.25.1
  • Updated: locations, buckets, buckets_datasets, buckets_datasets_links, buckets_datasets_views, scopes, tracescopes

Modified 6 models

2026.05.24.1
  • Updated: locations, buckets, buckets_datasets, buckets_datasets_links, buckets_datasets_views, scopes, tracescopes
2026.05.21.2
  • Updated: locations, buckets, buckets_datasets, buckets_datasets_links, buckets_datasets_views, scopes, tracescopes
2026.05.21.1
2026.05.19.2
2026.05.19.1
2026.05.18.1
2026.04.23.1
05Stats
A
100 / 100
Downloads
0
Archive size
56.5 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
Repository
https://github.com/swamp-club/swamp-extensions
06Platforms
07Labels
#gcp#google-cloud#observability#cloud#infrastructure