GoogleBigqueryAnalyticsHubQueryTemplate class final

Factory wrapper for google_bigquery_analytics_hub_query_template.

Represents a BigQuery Query Template within a Data Exchange. This resource defines a reusable SQL routine (e.g., a TVF) that can be shared or executed via the Data Exchange. ~> Note: Approving a Query Template is not supported by Terraform. The approve flow includes steps that can only be performed through the Google Cloud console UI. You can still create a Query Template (e.g. a TVF) and add it as a listing to a Data Clean Room via Terraform, but the final approval must be done manually.

Analytics Hub query template — reusable SQL routine (typically a table-valued function) defined on a data exchange for sharing / subscription workflows.

Cost / apply: gcp-cost: no Cloud Billing Catalog SKU after MCP lookup (list_services name=Analytics → no Analytics Hub service; BigQuery 24E6-581D-38E5 list_skus keywords analytics hub / template / sharing / exchange → 0). billing-behavior: exchange metadata only — no existence or hourly charge for the template itself (query jobs that run the TVF bill normal BigQuery analysis). Sibling Analytics Hub resources already live under skip-listed bigquery_quickstart ("datapolicy + analyticshub resources require an organization"); extending that example would fail the wave skiplist gate. Ships via tool/example_debt.yaml.

Requires dataExchangeId, displayName, location, and queryTemplateId. Optional routine holds definition_body + routine_type (TABLE_VALUED_FUNCTION). Enable analyticshub.googleapis.com via GoogleProjectService before apply.

Inheritance

Object
Resource
GoogleBigqueryAnalyticsHubQueryTemplate

Constructors

GoogleBigqueryAnalyticsHubQueryTemplate(String localName, {required TfArg<String> dataExchangeId, required TfArg<String> queryTemplateId, required TfArg<String> location, required TfArg<String> displayName, TfArg<String>? description, TfArg<String>? documentation, TfArg<String>? primaryContact, BigqueryAnalyticsHubQueryTemplateRoutine? routine, TfArg<bool>? submit, TfArg<String>? deletionPolicy, TfArg<String>? project, LifecycleOptions? lifecycle, List<TfAddressed>? dependsOn, StackProvider? provider, TfTimeouts? timeouts})

Properties

argMap → Map<String, TfArg?>: Argument-name → TfArg map. Keys are snake_case (Terraform JSON name). Synth emits these keys directly; the factory is responsible for the camelCase → snake_case translation at construction time.
finalinherited
createTime → TfRef<String>: Reference to create_time attribute.
no setter
dataExchangeId → TfRef<String>: Reference to data_exchange_id attribute.
no setter
defaultProvider → String: The provider name a block without provider uses: by default the prefix of terraformType (google for google_pubsub_topic).
no setterinherited
deletionPolicy → TfRef<String>: Reference to deletion_policy attribute.
no setter
dependsOn → List<TfAddressed>?: Optional depends_on = [...]: the resources, data sources and module calls this block waits for, e.g. dependsOn: [api, ...apiDeps]. Terraform takes whole blocks only, so an entry is never an attribute.
finalinherited
description → TfRef<String>: Reference to description attribute.
no setter
displayName → TfRef<String>: Reference to display_name attribute.
no setter
documentation → TfRef<String>: Reference to documentation attribute.
no setter
hashCode → int: The hash code for this object.
no setterinherited
id → TfRef<String>: Reference to id attribute.
no setter
kind → ResourceKind: Always ResourceKind.resource. Overridden by Data.
no setterinherited
lifecycle → LifecycleOptions?: Optional lifecycle { ... } block.
finalinherited
localName → String: User-supplied local name within a Stack.
finalinherited
location → TfRef<String>: Reference to location attribute.
no setter
name → TfRef<String>: Reference to name attribute.
no setter
primaryContact → TfRef<String>: Reference to primary_contact attribute.
no setter
project → TfRef<String>: Reference to project attribute.
no setter
provider → StackProvider?: Optional Terraform provider meta-argument: the provider configuration this block uses, e.g. the aliased GoogleProvider(alias: 'eu') the Stack registered with addProvider.
finalinherited
queryTemplateId → TfRef<String>: Reference to query_template_id attribute.
no setter
ref → RefTo<GoogleBigqueryAnalyticsHubQueryTemplate>: A reference to this resource, for arguments typed RefTo<GoogleBigqueryAnalyticsHubQueryTemplate>.
no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
sensitiveFields → Set<String>: Field names that are @Sensitive per the IR-derived per-resource constant. Curated factories override with a baked-in static const Set<String> (file-private in v0.5+).
no setteroverride
state → TfRef<String>: Reference to state attribute.
no setter
submit → TfRef<bool>: Reference to submit attribute.
no setter
supportsDeletionProtection → bool: Capability flag: true when this resource's underlying Terraform schema has a deletion_protection boolean attribute that the synth-time devMode flow can flip to false. Defaults to false; the codegen emitter overrides this to true for wrappers whose schema includes the attribute.
no setterinherited
terraformType → String: Terraform resource type, e.g. google_pubsub_topic.
finalinherited
tfAddress → String: Terraform address <terraformType>.<localName>, e.g. google_pubsub_topic.orders.
no setterinherited
timeouts → TfTimeouts?: Optional timeouts { ... } block: how long Terraform waits for each operation. Provider-neutral like lifecycle — synth copies the duration strings verbatim, and terraform validate decides whether this resource's schema declares the operations set here.
finalinherited
updateTime → TfRef<String>: Reference to update_time attribute.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Constants

tfType → const String