Skip to main content

@swamp/gcp/analyticshub

v2026.04.23.1

Google Cloud analyticshub infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Labels

gcpgoogle-cloudanalyticshubcloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/gcp/analyticshub

@swamp/gcp/analyticshub/dataexchangesv2026.04.23.1dataexchanges.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a dataExchanges
ArgumentTypeDescription
identifierstringThe name of the dataExchanges
syncSync dataExchanges state from GCP

Resources

state(infinite)— A data exchange is a container that lets you share data. Along with the descr...
@swamp/gcp/analyticshub/dataexchanges-listingsv2026.04.23.1dataexchanges_listings.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
allowOnlyMetadataSharing?booleanOptional. If true, the listing is only available to get the resource metadata. Listing is non subscribable.
bigqueryDataset?objectA reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber's subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber's project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset.
categories?arrayOptional. Categories of the listing. Up to five categories are allowed.
commercialInfo?objectCommercial info contains the information about the commercial data products associated with the listing.
dataProvider?objectContains details of the data provider.
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?objectContains details of the listing publisher.
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?objectRestricted export config, used to configure restricted export on linked dataset.
storedProcedureConfig?objectStored procedure configuration, used to configure stored procedure sharing on linked dataset.
listingId?stringRequired. The ID of the listing to create. Must contain only Unicode letters, numbers (0-9), underscores (_). Max length: 100 bytes.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a listings
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a listings
ArgumentTypeDescription
identifierstringThe name of the listings
updateUpdate listings attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the listings
ArgumentTypeDescription
identifierstringThe name of the listings
syncSync listings state from GCP
list_subscriptionslist subscriptions
subscribesubscribe
ArgumentTypeDescription
destinationDataset?any
destinationPubsubSubscription?any

Resources

state(infinite)— A listing is what gets published into a data exchange that a subscriber can s...
@swamp/gcp/analyticshub/dataexchanges-querytemplatesv2026.04.23.1dataexchanges_querytemplates.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
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.
primaryContact?stringOptional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
proposer?stringOptional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
routine?objectRepresents a bigquery routine.
queryTemplateId?stringRequired. The ID of the QueryTemplate to create. Must contain only Unicode letters, numbers (0-9), underscores (_). Max length: 100 bytes.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a queryTemplates
getGet a queryTemplates
ArgumentTypeDescription
identifierstringThe name of the queryTemplates
updateUpdate queryTemplates attributes
deleteDelete the queryTemplates
ArgumentTypeDescription
identifierstringThe name of the queryTemplates
syncSync queryTemplates state from GCP
approveapprove
submitsubmit

Resources

state(infinite)— A query template is a container for sharing table-valued functions defined by...
@swamp/gcp/analyticshub/subscriptionsv2026.04.23.1subscriptions.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a subscriptions
ArgumentTypeDescription
identifierstringThe name of the subscriptions
deleteDelete the subscriptions
ArgumentTypeDescription
identifierstringThe name of the subscriptions
syncSync subscriptions state from GCP
refreshrefresh
revokerevoke
ArgumentTypeDescription
revokeCommercial?any

Resources

state(infinite)— A subscription represents a subscribers' access to a particular set of publis...