Skip to main content
← back to extensions

Gcp/analyticshub

@swamp/gcp/analyticshubv2026.10.23.1· AGPL-3.0-or-later(was none)· 9d agoBEHAVIORS
01README

Google Cloud analyticshub infrastructure models

02Release Notes
  • Updated: dataexchanges, dataexchanges_listings, dataexchanges_querytemplates, subscriptions
03Behaviors4
@swamp/gcp/analyticshub/dataexchangesv2026.10.23.1dataexchanges.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.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
organizationstringRequired. The organization resource path of the projects containing DataExchanges. e.g. `organizations/myorg/locations/us`.
fn get(identifier: string)
Get a dataExchanges
ArgumentTypeDescription
identifierstringThe name of the dataExchanges
fn sync(identifier?: string)
Sync dataExchanges state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific dataExchanges by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List dataExchanges resources
ArgumentTypeDescription
pageSize?numberThe maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— A data exchange is a container that lets you share data. Along with the descr...
@swamp/gcp/analyticshub/dataexchanges-listingsv2026.10.23.1dataexchanges_listings.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.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
allowOnlyMetadataSharing?booleanOptional. If true, the listing is only available to get the resource metadata. Listing is non subscribable.
bigqueryDataset?objectShared dataset i.e. BigQuery dataset source.
categories?arrayOptional. Categories of the listing. Up to five categories are allowed.
dataProvider?objectOptional. Details of the data provider who owns the source data.
description?stringOptional. Short description of the listing. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
discoveryType?enumOptional. Type of discovery of the listing on the discovery page.
displayName?stringRequired. Human-readable display name of the listing. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces (), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
documentation?stringOptional. Documentation describing the listing.
icon?stringOptional. Base64 encoded image representing the listing. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the contents of the field are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
logLinkedDatasetQueryUserEmail?booleanOptional. By default, false. If true, the Listing has an email sharing mandate enabled.
primaryContact?stringOptional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.
publisher?objectOptional. Details of the publisher who owns the listing and who can share the source data.
pubsubTopic?objectPub/Sub topic source.
requestAccess?stringOptional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.
restrictedExportConfig?objectOptional. If set, restricted export configuration will be propagated and enforced on the linked dataset.
storedProcedureConfig?objectOptional. If set, stored procedure configuration will be propagated and enforced on the linked dataset.
listingId?stringRequired. The ID of the listing to create. Must contain only Unicode letters, numbers (0-9), underscores (_). Max length: 100 bytes.
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(waitForReady?: boolean)
Create a listings
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
fn get(identifier: string)
Get a listings
ArgumentTypeDescription
identifierstringThe name of the listings
fn update(identifier?: string, waitForReady?: boolean)
Update listings attributes
ArgumentTypeDescription
identifier?stringTarget a specific listings by name (e.g. one discovered by list)
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
fn delete(identifier: string)
Delete the listings
ArgumentTypeDescription
identifierstringThe name of the listings
fn sync(identifier?: string)
Sync listings state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific listings by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List listings resources
ArgumentTypeDescription
pageSize?numberThe maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_iam_policy(options?: any)
get iam policy
ArgumentTypeDescription
options?any
fn list_subscriptions(includeDeletedSubscriptions?: any, pageSize?: any, pageToken?: any)
list subscriptions
ArgumentTypeDescription
includeDeletedSubscriptions?any
pageSize?any
pageToken?any
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
ArgumentTypeDescription
policy?any
updateMask?any
fn subscribe(destinationDataset?: any, destinationPubsubSubscription?: any)
subscribe
ArgumentTypeDescription
destinationDataset?any
destinationPubsubSubscription?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any

Resources

state(infinite)— A listing is what gets published into a data exchange that a subscriber can s...
@swamp/gcp/analyticshub/dataexchanges-querytemplatesv2026.10.23.1dataexchanges_querytemplates.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.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
description?stringOptional. Short description of the QueryTemplate. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
displayName?stringRequired. Human-readable display name of the QueryTemplate. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces (), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
documentation?stringOptional. Documentation describing the QueryTemplate.
encryptionConfiguration?objectOptional. Encryption configuration for the query template. If set, the customer-managed KMS key is used to encrypt the query template definition body.
primaryContact?stringOptional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
routine?objectOptional. The routine associated with the QueryTemplate.
queryTemplateId?stringRequired. The ID of the QueryTemplate to create. Must contain only Unicode letters, numbers (0-9), underscores (_). Max length: 100 bytes.
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 queryTemplates
fn get(identifier: string)
Get a queryTemplates
ArgumentTypeDescription
identifierstringThe name of the queryTemplates
fn update(identifier?: string)
Update queryTemplates attributes
ArgumentTypeDescription
identifier?stringTarget a specific queryTemplates by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the queryTemplates
ArgumentTypeDescription
identifierstringThe name of the queryTemplates
fn sync(identifier?: string)
Sync queryTemplates state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific queryTemplates by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List queryTemplates resources
ArgumentTypeDescription
pageSize?numberOptional. The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn approve()
approve
fn submit()
submit

Resources

state(infinite)— A query template is a container for sharing table-valued functions defined by...
@swamp/gcp/analyticshub/subscriptionsv2026.10.23.1subscriptions.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.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn get(identifier: string)
Get a subscriptions
ArgumentTypeDescription
identifierstringThe name of the subscriptions
fn delete(identifier: string)
Delete the subscriptions
ArgumentTypeDescription
identifierstringThe name of the subscriptions
fn sync(identifier?: string)
Sync subscriptions state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific subscriptions by name (e.g. one discovered by list)
fn list(filter?: string, pageSize?: number, maxPages?: number)
List subscriptions resources
ArgumentTypeDescription
filter?stringAn expression for filtering the results of the request. Eligible fields for filtering are: + `listing` + `data_exchange` Alternatively, a literal wrapped in double quotes may be provided. This will be checked for an exact match against both fields above. In all cases, the full Data Exchange or Listing resource name must be provided. Some example of using filters: + data_exchange="projects/myproject/locations/us/dataExchanges/123" + listing="projects/123/locations/us/dataExchanges/456/listings/78
pageSize?numberThe maximum number of results to return in a single response page.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_iam_policy(options?: any)
get iam policy
ArgumentTypeDescription
options?any
fn refresh()
refresh
fn revoke(revokeCommercial?: any)
revoke
ArgumentTypeDescription
revokeCommercial?any
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
ArgumentTypeDescription
policy?any
updateMask?any

Resources

state(infinite)— A subscription represents a subscribers' access to a particular set of publis...
04Previous Versions19
2026.10.13.1
  • Updated: dataexchanges, dataexchanges_listings, dataexchanges_querytemplates, subscriptions
2026.09.19.1
  • Updated: dataexchanges_querytemplates
2026.09.07.1
  • Updated: dataexchanges_listings
2026.08.12.2
  • Updated: dataexchanges, dataexchanges_listings, dataexchanges_querytemplates, subscriptions
2026.08.03.1
  • Updated: dataexchanges_querytemplates
2026.07.29.1
  • Updated: dataexchanges, dataexchanges_listings, dataexchanges_querytemplates, subscriptions
2026.07.21.3
  • Updated: dataexchanges, dataexchanges_listings, dataexchanges_querytemplates, subscriptions
2026.07.21.1
  • Updated: dataexchanges_listings, dataexchanges_querytemplates
2026.07.20.1
  • Updated: dataexchanges, dataexchanges_listings, dataexchanges_querytemplates, subscriptions
2026.07.19.2
  • Updated: dataexchanges
2026.07.19.1
  • Updated: dataexchanges, dataexchanges_listings, dataexchanges_querytemplates, subscriptions
2026.07.18.2
  • Updated: dataexchanges, dataexchanges_listings, dataexchanges_querytemplates, subscriptions
2026.07.17.2
  • Updated: dataexchanges_listings, dataexchanges_querytemplates
2026.07.17.1
  • Updated: dataexchanges_listings, dataexchanges_querytemplates, subscriptions
2026.06.08.2
  • Updated: dataexchanges, dataexchanges_listings, dataexchanges_querytemplates, subscriptions
2026.06.07.1
  • Updated: dataexchanges, dataexchanges_listings, dataexchanges_querytemplates, subscriptions
2026.05.25.1
  • Updated: dataexchanges, dataexchanges_listings, dataexchanges_querytemplates, subscriptions

Modified 4 behaviors

2026.05.24.1
  • Updated: dataexchanges, dataexchanges_listings, dataexchanges_querytemplates, subscriptions
2026.05.21.2
  • Updated: dataexchanges, dataexchanges_listings, dataexchanges_querytemplates, subscriptions
05Stats
A
100 / 100
Downloads
35
Archive size
52.2 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
  • Docs keep secrets in a vault1/1earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License2/2earned
  • Verified public repository2/2earned
Repository
https://github.com/swamp-club/swamp-extensions
06Platforms
07Labels
#gcp#google-cloud#analyticshub#cloud#infrastructure